Skip to content

Commit

Permalink
chore: Version bumps (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
tazarov authored Oct 3, 2024
1 parent 98c1e4b commit f0f816e
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 18 deletions.
6 changes: 1 addition & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,8 @@

This is a collection of small guides and recipes to help you get started with ChromaDB.

Latest ChromaDB version: [0.5.5](https://github.com/chroma-core/chroma/releases/tag/0.5.5)
Latest ChromaDB version: [0.5.11](https://github.com/chroma-core/chroma/releases/tag/0.5.11)

**Latest Releases highlights:**

- WAL pruning
- Adds async client support

## New and Noteworthy

Expand Down
17 changes: 10 additions & 7 deletions docs/running/running-chroma.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Prerequisites:
- Docker - [Overview of Docker Desktop | Docker Docs](https://docs.docker.com/desktop/)

```shell
docker run -d --rm --name chromadb -v ./chroma:/chroma/chroma -e IS_PERSISTENT=TRUE -e ANONYMIZED_TELEMETRY=TRUE chromadb/chroma:latest
docker run -d --rm --name chromadb -v ./chroma:/chroma/chroma -e IS_PERSISTENT=TRUE -e ANONYMIZED_TELEMETRY=TRUE chromadb/chroma:0.5.11
```

Options:
Expand All @@ -52,8 +52,7 @@ Options:
default it is `/chroma/chroma`
- `-e ANONYMIZED_TELEMETRY=TRUE` allows you to turn on (`TRUE`) or off (`FALSE`) anonymous product telemetry which helps
the Chroma team in making informed decisions about Chroma OSS and commercial direction.
- `chromadb/chroma:latest` indicates the latest Chroma version but can be replaced with any valid tag if a prior version
is needed (e.g. `chroma:0.4.24`)
- `chromadb/chroma:5.11` indicates the Chroma release version.

### Docker Compose (Cloned Repo)

Expand All @@ -73,7 +72,7 @@ docker compose up -d --build
If you want to run a specific version of Chroma you can checkout the version tag you need:

```shell
git checkout release/0.4.24
git checkout release/0.5.11
```

### Docker Compose (Without Cloning the Repo)
Expand All @@ -94,7 +93,7 @@ networks:
driver: bridge
services:
chromadb:
image: chromadb/chroma:latest
image: chromadb/chroma:0.5.11
volumes:
- ./chromadb:/chroma/chroma
environment:
Expand All @@ -107,9 +106,13 @@ services:
- net
```
The above will create a container with the latest Chroma (`chromadb/chroma:latest`), will expose it to port `8000` on
The above will create a container with the latest Chroma (`chromadb/chroma:0.5.11`), will expose it to port `8000` on
the local machine and will persist data in `./chromadb` relative path from where the `docker-compose.yaml` has been ran.

!!! tip "Versioning"

When running Chroma with docker compose try to pin the version to a specific release. This will ensure intentional upgrades and avoid potential issues (usually with clients).

We have also created a small gist with the above file for convenience:

```bash
Expand Down Expand Up @@ -145,7 +148,7 @@ Get and install the chart:
```bash
helm repo add chroma https://amikos-tech.github.io/chromadb-chart/
helm repo update
helm install chroma chroma/chromadb --set chromadb.apiVersion="0.4.24"
helm install chroma chroma/chromadb --set chromadb.apiVersion="0.5.11"
```

By default the chart will enable authentication in Chroma. To get the token run the following:
Expand Down
2 changes: 1 addition & 1 deletion docs/security/chroma-ssl-cert.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ You can run Chroma with the SSL/TLS certificate generate above or any other cert

services:
server:
image: chromadb/chroma:0.5.0
image: chromadb/chroma:0.5.11
volumes:
# Be aware that indexed data are located in "/chroma/chroma/"
# Default configuration for persist_directory in chromadb/config.py
Expand Down
26 changes: 21 additions & 5 deletions docs/security/ssl-proxies.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,21 +96,28 @@ services:
networks:
- net
depends_on:
- cert-gen
cert-gen:
condition: service_completed_successfully
chromadb:
condition: service_healthy
entrypoint: |
sh -c "/usr/local/bin/wait-for-certs.sh && \
/opt/bitnami/envoy/bin/envoy -c /opt/bitnami/envoy/conf/envoy.yaml"
chromadb:
image: chromadb/chroma:0.5.5
image: chromadb/chroma:0.5.11
volumes:
- ./chromadb:/chroma/chroma
environment:
- IS_PERSISTENT=TRUE
- ANONYMIZED_TELEMETRY=${ANONYMIZED_TELEMETRY:-TRUE}
networks:
- net
depends_on:
- envoy
healthcheck:
# Adjust below to match your container port
test: [ "CMD", "curl", "-f", "http://localhost:8000/api/v1/heartbeat" ]
interval: 30s
timeout: 10s
retries: 3
```

## Nginx
Expand Down Expand Up @@ -159,14 +166,20 @@ services:
environment:
- CHROMA_DOMAIN=${CHROMA_DOMAIN:-localhost}
chromadb:
image: chromadb/chroma:0.5.5
image: chromadb/chroma:0.5.11
volumes:
- ./chromadb:/chroma/chroma
environment:
- IS_PERSISTENT=TRUE
- ANONYMIZED_TELEMETRY=${ANONYMIZED_TELEMETRY:-TRUE}
ports:
- "8000:8000"
healthcheck:
# Adjust below to match your container port
test: [ "CMD", "curl", "-f", "http://localhost:8000/api/v1/heartbeat" ]
interval: 30s
timeout: 10s
retries: 3
networks:
- net
nginx:
Expand All @@ -181,5 +194,8 @@ services:
- ./certs:/etc/nginx/certs
networks:
- net
depends_on:
chromadb:
condition: service_healthy
```

0 comments on commit f0f816e

Please sign in to comment.