diff --git a/.circleci/config.yml b/.circleci/config.yml index 6701a1c7d..3891e0675 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,6 +1,29 @@ version: 2.1 commands: + abort_for_docs: + steps: + - run: + name: Avoid tests for docs + command: | + if [[ $CIRCLE_BRANCH == *_docs ]]; then + echo "Identifies as documents PR, no testing required" + circleci step halt + fi + + early_return_for_forked_pull_requests: + description: >- + If this build is from a fork, stop executing the current job and return success. + This is useful to avoid steps that will fail due to missing credentials. + steps: + - run: + name: Early return if this build is from a forked PR + command: | + if [[ -n "$CIRCLE_PR_NUMBER" ]]; then + echo "Nothing to do for forked PRs, so marking this step successful" + circleci step halt + fi + setup-executor: steps: - run: @@ -25,6 +48,7 @@ commands: platform: type: string steps: + - abort_for_docs - checkout - run: name: Submodule checkout @@ -72,6 +96,7 @@ commands: platforms-build-steps: steps: + - abort_for_docs - checkout - run: name: Relocate docker overlay2 dir @@ -117,6 +142,8 @@ commands: from: type: string steps: + - abort_for_docs + - early_return_for_forked_pull_requests - run: name: Deploy to S3 command: | @@ -158,6 +185,7 @@ jobs: docker: - image: redisfab/rmbuilder:6.0.9-x64-buster steps: + - abort_for_docs - checkout - run: name: Submodule checkout @@ -191,6 +219,7 @@ jobs: docker: - image: redisfab/rmbuilder:6.0.9-x64-buster steps: + - abort_for_docs - checkout - run: name: Submodule checkout @@ -219,18 +248,20 @@ jobs: macos: xcode: 11.3.0 steps: + - abort_for_docs - run: name: Fix macOS Python installation command: | brew reinstall -f python2 - build-steps: - platform: macosx + platform: macos build-multiarch-docker: machine: enabled: true image: cimg/base:2020.01 steps: + - abort_for_docs - checkout - run: name: Submodule checkout @@ -262,6 +293,7 @@ jobs: resource_class: gpu.nvidia.small image: ubuntu-1604-cuda-11.1:202012-01 steps: + - abort_for_docs - checkout - run: name: Submodule checkout @@ -295,6 +327,8 @@ jobs: docker: - image: redisfab/rmbuilder:6.0.9-x64-buster steps: + - abort_for_docs + - early_return_for_forked_pull_requests - attach_workspace: at: workspace - run: @@ -310,6 +344,8 @@ jobs: docker: - image: redisfab/rmbuilder:6.0.9-x64-buster steps: + - abort_for_docs + - early_return_for_forked_pull_requests - attach_workspace: at: workspace - run: @@ -331,6 +367,8 @@ jobs: docker: - image: redisfab/rmbuilder:6.0.9-x64-buster steps: + - abort_for_docs + - early_return_for_forked_pull_requests - attach_workspace: at: workspace - run: diff --git a/README.md b/README.md index be448289d..27ed3f32d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![GitHub issues](https://img.shields.io/github/release/RedisAI/RedisAI.svg?sort=semver)](https://github.com/RedisAI/RedisAI/releases/latest) [![CircleCI](https://circleci.com/gh/RedisAI/RedisAI/tree/master.svg?style=svg)](https://circleci.com/gh/RedisAI/RedisAI/tree/master) -[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/redisai/redisai.svg)](https://hub.docker.com/r/redisai/redisai/builds/) +[![Dockerhub](https://img.shields.io/badge/dockerhub-redislabs%2Fredisai-blue)](https://hub.docker.com/r/redislabs/redisai/tags/) [![codecov](https://codecov.io/gh/RedisAI/RedisAI/branch/master/graph/badge.svg)](https://codecov.io/gh/RedisAI/RedisAI) [![Total alerts](https://img.shields.io/lgtm/alerts/g/RedisAI/RedisAI.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RedisAI/RedisAI/alerts/) @@ -23,13 +23,13 @@ If you want to run examples, make sure you have [git-lfs](https://git-lfs.github To quickly tryout RedisAI, launch an instance using docker: ```sh -docker run -p 6379:6379 -it --rm redisai/redisai +docker run -p 6379:6379 -it --rm redislabs/redisai ``` For docker instance with GPU support, you can launch it from `tensorwerk/redisai-gpu` ```sh -docker run -p 6379:6379 --gpus all -it --rm redisai/redisai:latest-gpu +docker run -p 6379:6379 --gpus all -it --rm redislabs/redisai:latest-gpu ``` But if you'd like to build the docker image, you need a machine that has Nvidia driver (CUDA 10.0), nvidia-container-toolkit and Docker 19.03+ installed. For detailed information, checkout [nvidia-docker documentation](https://github.com/NVIDIA/nvidia-docker) diff --git a/docs/index.md b/docs/index.md index 1509f91a6..414a6dfa7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,7 +17,7 @@ RedisAI is a joint effort between [Redis Labs](https://www.redislabs.com) and [T ## Quick Links * [Source code repository](https://github.com/RedisAI/RedisAI) * [Releases](https://github.com/RedisAI/RedisAI/releases) - * [Docker image](https://hub.docker.com/r/redisai/redisai/) + * [Docker image](https://hub.docker.com/r/redislabs/redisai/) ## Contact Us If you have questions, want to provide feedback or perhaps report an issue or [contribute some code](contrib.md), here's where we're listening to you: diff --git a/docs/intro.md b/docs/intro.md index 51d532b08..08a0f812a 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -124,7 +124,7 @@ Backend libraries are dynamically loaded as needed, but can also be loaded durin The easiest way to get a standalone Redis server with RedisAI bootstrapped locally is to use the official RedisAI Docker container image: ``` -docker run -d --name redisai -p 6379:6379 redisai/redisai:latest +docker run -d --name redisai -p 6379:6379 redislabs/redisai:latest ``` ??? info "Further reference" diff --git a/docs/quickstart.md b/docs/quickstart.md index 3192ae81d..bb086eedf 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -8,13 +8,13 @@ The quickest way to try RedisAI is by launching its official Docker container im ### On a CPU only machine ``` -docker run -p 6379:6379 redisai/redisai:latest +docker run -p 6379:6379 redislabs/redisai:latest ``` ### On a GPU machine ``` -docker run -p 6379:6379 --gpus all -it --rm redisai/redisai:latest-gpu +docker run -p 6379:6379 --gpus all -it --rm redislabs/redisai:latest-gpu ``` ## Download