Skip to content

Commit 1d057c8

Browse files
committed
Updated docs after Dockerhub build changes
1 parent 69027b1 commit 1d057c8

File tree

5 files changed

+48
-8
lines changed

5 files changed

+48
-8
lines changed

.circleci/config.yml

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,29 @@
11
version: 2.1
22

33
commands:
4+
abort_for_docs:
5+
steps:
6+
- run:
7+
name: Avoid tests for docs
8+
command: |
9+
if [[ $CIRCLE_BRANCH == *_docs ]]; then
10+
echo "Identifies as documents PR, no testing required"
11+
circleci step halt
12+
fi
13+
14+
early_return_for_forked_pull_requests:
15+
description: >-
16+
If this build is from a fork, stop executing the current job and return success.
17+
This is useful to avoid steps that will fail due to missing credentials.
18+
steps:
19+
- run:
20+
name: Early return if this build is from a forked PR
21+
command: |
22+
if [[ -n "$CIRCLE_PR_NUMBER" ]]; then
23+
echo "Nothing to do for forked PRs, so marking this step successful"
24+
circleci step halt
25+
fi
26+
427
setup-executor:
528
steps:
629
- run:
@@ -25,6 +48,7 @@ commands:
2548
platform:
2649
type: string
2750
steps:
51+
- abort_for_docs
2852
- checkout
2953
- run:
3054
name: Submodule checkout
@@ -75,6 +99,7 @@ commands:
7599
platform:
76100
type: string
77101
steps:
102+
- abort_for_docs
78103
- setup-executor
79104
- checkout
80105
- run:
@@ -111,6 +136,8 @@ commands:
111136
build_args:
112137
type: string
113138
steps:
139+
- abort_for_docs
140+
- early_return_for_forked_pull_requests
114141
- setup-executor
115142
- checkout
116143
- run:
@@ -132,6 +159,8 @@ commands:
132159
from:
133160
type: string
134161
steps:
162+
- abort_for_docs
163+
- early_return_for_forked_pull_requests
135164
- run:
136165
name: Deploy to S3
137166
command: |
@@ -173,6 +202,7 @@ jobs:
173202
docker:
174203
- image: redisfab/rmbuilder:6.0.9-x64-buster
175204
steps:
205+
- abort_for_docs
176206
- checkout
177207
- run:
178208
name: Submodule checkout
@@ -206,6 +236,7 @@ jobs:
206236
docker:
207237
- image: redisfab/rmbuilder:6.0.9-x64-buster
208238
steps:
239+
- abort_for_docs
209240
- checkout
210241
- run:
211242
name: Submodule checkout
@@ -234,18 +265,20 @@ jobs:
234265
macos:
235266
xcode: 11.3.0
236267
steps:
268+
- abort_for_docs
237269
- run:
238270
name: Fix macOS Python installation
239271
command: |
240272
brew reinstall -f python2
241273
- build-steps:
242-
platform: macosx
274+
platform: macos
243275

244276
build-multiarch-docker:
245277
machine:
246278
enabled: true
247279
image: cimg/base:2020.01
248280
steps:
281+
- abort_for_docs
249282
- checkout
250283
- run:
251284
name: Submodule checkout
@@ -277,6 +310,7 @@ jobs:
277310
resource_class: gpu.nvidia.small
278311
image: ubuntu-1604-cuda-10.1:201909-23
279312
steps:
313+
- abort_for_docs
280314
- checkout
281315
- run:
282316
name: Submodule checkout
@@ -311,6 +345,8 @@ jobs:
311345
docker:
312346
- image: redisfab/rmbuilder:6.0.9-x64-buster
313347
steps:
348+
- abort_for_docs
349+
- early_return_for_forked_pull_requests
314350
- attach_workspace:
315351
at: workspace
316352
- run:
@@ -325,6 +361,8 @@ jobs:
325361
docker:
326362
- image: redisfab/rmbuilder:6.0.9-x64-buster
327363
steps:
364+
- abort_for_docs
365+
- early_return_for_forked_pull_requests
328366
- attach_workspace:
329367
at: workspace
330368
- run:
@@ -343,6 +381,8 @@ jobs:
343381
docker:
344382
- image: redisfab/rmbuilder:6.0.9-x64-buster
345383
steps:
384+
- abort_for_docs
385+
- early_return_for_forked_pull_requests
346386
- attach_workspace:
347387
at: workspace
348388
- run:

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![GitHub issues](https://img.shields.io/github/release/RedisAI/RedisAI.svg?sort=semver)](https://github.com/RedisAI/RedisAI/releases/latest)
22
[![CircleCI](https://circleci.com/gh/RedisAI/RedisAI/tree/master.svg?style=svg)](https://circleci.com/gh/RedisAI/RedisAI/tree/master)
3-
[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/redisai/redisai.svg)](https://hub.docker.com/r/redisai/redisai/builds/)
3+
[![Dockerhub](https://img.shields.io/badge/dockerhub-redislabs%2Fredisai-blue)](https://hub.docker.com/r/redislabs/redisai/tags/)
44
[![codecov](https://codecov.io/gh/RedisAI/RedisAI/branch/master/graph/badge.svg)](https://codecov.io/gh/RedisAI/RedisAI)
55
[![Total alerts](https://img.shields.io/lgtm/alerts/g/RedisAI/RedisAI.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RedisAI/RedisAI/alerts/)
66

@@ -23,13 +23,13 @@ If you want to run examples, make sure you have [git-lfs](https://git-lfs.github
2323
To quickly tryout RedisAI, launch an instance using docker:
2424

2525
```sh
26-
docker run -p 6379:6379 -it --rm redisai/redisai
26+
docker run -p 6379:6379 -it --rm redislabs/redisai
2727
```
2828

2929
For docker instance with GPU support, you can launch it from `tensorwerk/redisai-gpu`
3030

3131
```sh
32-
docker run -p 6379:6379 --gpus all -it --rm redisai/redisai:latest-gpu
32+
docker run -p 6379:6379 --gpus all -it --rm redislabs/redisai:latest-gpu
3333
```
3434

3535
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)

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ RedisAI is a joint effort between [Redis Labs](https://www.redislabs.com) and [T
1717
## Quick Links
1818
* [Source code repository](https://github.com/RedisAI/RedisAI)
1919
* [Releases](https://github.com/RedisAI/RedisAI/releases)
20-
* [Docker image](https://hub.docker.com/r/redisai/redisai/)
20+
* [Docker image](https://hub.docker.com/r/redislabs/redisai/)
2121

2222
## Contact Us
2323
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:

docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Backend libraries are dynamically loaded as needed, but can also be loaded durin
124124
The easiest way to get a standalone Redis server with RedisAI bootstrapped locally is to use the official RedisAI Docker container image:
125125

126126
```
127-
docker run -d --name redisai -p 6379:6379 redisai/redisai:latest
127+
docker run -d --name redisai -p 6379:6379 redislabs/redisai:latest
128128
```
129129

130130
??? info "Further reference"

docs/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ The quickest way to try RedisAI is by launching its official Docker container im
88

99
### On a CPU only machine
1010
```
11-
docker run -p 6379:6379 redisai/redisai:latest
11+
docker run -p 6379:6379 redislabs/redisai:latest
1212
```
1313

1414
### On a GPU machine
1515

1616
```
17-
docker run -p 6379:6379 --gpus all -it --rm redisai/redisai:latest-gpu
17+
docker run -p 6379:6379 --gpus all -it --rm redislabs/redisai:latest-gpu
1818
```
1919

2020
## Download

0 commit comments

Comments
 (0)