Skip to content

Updated docs after Dockerhub build changes #601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -25,6 +48,7 @@ commands:
platform:
type: string
steps:
- abort_for_docs
- checkout
- run:
name: Submodule checkout
Expand Down Expand Up @@ -72,6 +96,7 @@ commands:

platforms-build-steps:
steps:
- abort_for_docs
- checkout
- run:
name: Relocate docker overlay2 dir
Expand Down Expand Up @@ -117,6 +142,8 @@ commands:
from:
type: string
steps:
- abort_for_docs
- early_return_for_forked_pull_requests
- run:
name: Deploy to S3
command: |
Expand Down Expand Up @@ -158,6 +185,7 @@ jobs:
docker:
- image: redisfab/rmbuilder:6.0.9-x64-buster
steps:
- abort_for_docs
- checkout
- run:
name: Submodule checkout
Expand Down Expand Up @@ -191,6 +219,7 @@ jobs:
docker:
- image: redisfab/rmbuilder:6.0.9-x64-buster
steps:
- abort_for_docs
- checkout
- run:
name: Submodule checkout
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)

Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down