Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

[ENH]: Cloud Deployment Blueprints #190

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[ENH]: Cloud Deployment Blueprints #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
39c6a82
feat: Cloud Deployment Blueprints
tazarov Dec 18, 2023
0b9804f
fix: Fixed source CIRDs for AWS template
tazarov Dec 19, 2023
c21369a
Merge branch 'main' into feature/cloud-blueprint-deployments
tazarov Jan 22, 2024
019ae20
refactor: Refactored Deployments into its own category
tazarov Jan 22, 2024
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
211 changes: 0 additions & 211 deletions docs/deployment.md
View file
Open in desktop

This file was deleted.

67 changes: 67 additions & 0 deletions docs/deployment/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
slug: /deployment/aws
title: Amazon Web Services
---

# Amazon Web Services (AWS)


AWS Configuration variables

| Parameter Name | Description | Default Value |
|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------|---------------------|
| chroma_release | The chroma release to deploy | 0.4.20 |
| region | AWS Region | us-west-1 |
| instance_type | AWS EC2 Instance Type | t3.medium |
| public_access | Enable public ingress on port 8000 | true |
| enable_auth | Enable authentication | true |
| auth_type | Authentication type | token |
| import_keypair | Whether to import the keypair in AWS. Set this to `false` if your keypair is already available in AWS. | true |
| keypair_name | The name of the keypair to import | chroma_keypair |
| ssh_public_key | SSH Public Key | ./chroma_id_rsa.pub |
| ssh_private_key | SSH Private Key | ./chroma_id_rsa |
| chroma_instance_volume_size | The size of the instance volume - the root volume | 30 |
| chroma_data_volume_size | EBS Volume Size of the attached data volume where your chroma data is stored | 20 |
| chroma_data_volume_snapshot_before_destroy | Take a snapshot of the chroma data volume before destroying it | false |
| chroma_data_restore_from_snapshot_id | Restore the chroma data volume from a snapshot | null |
| chroma_port | The port that chroma listens on | 8000 |
| source_ranges | List of CIDR ranges to allow through the firewall | ["0.0.0.0/0"] |
| mgmt_source_ranges | List of CIDR ranges to allow for management of the Chroma instance. This is used for SSH incoming traffic filtering | ["0.0.0.0/0"] |

> Note: All of the above variables can be exported via environment variables (`TF_<variable_name>=<var_value>`) or set
> in a `.tfvars` file.

Set up your Terraform variables and deploy your instance:

```bash
export TF_VAR_AWS_ACCESS_KEY=<AWS_ACCESS_KEY>
export TF_VAR_AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
export TF_ssh_public_key="./chroma_id_rsa.pub"
export TF_ssh_private_key="./chroma_id_rsa"
export TF_VAR_chroma_release=0.4.20
export TF_VAR_region="us-west-1"
export TF_VAR_public_access="true"
export TF_VAR_enable_auth="true"
export TF_VAR_auth_type="token"
export TF_VAR_chroma_data_volume_snapshot_before_destroy="true"
terraform apply -auto-approve
```

Verify that your instance is up and running:

```bash
export instance_public_ip=$(terraform output instance_public_ip | sed 's/"//g')
curl -v http://$instance_public_ip:8000/api/v1/heartbeat
```

> Note: Depending on your OS the `sed` command might not work. In that case, you can manually copy the public IP from
> the Terraform output.

To get the auth token generated during the setup:

```bash
terraform output chroma_auth_token
```

For more details check
our [Terraform AWS deployment blueprint](https://github.com/chroma-core/chroma/tree/main/examples/deployments/aws-terraform)
61 changes: 61 additions & 0 deletions docs/deployment/digital-ocean.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
slug: /deployment/digital-ocean
title: Digital Ocean
---

# Digital Ocean (DO)


Digital Ocean Configuration parameters:

| Parameter Name | Description | Default Value |
|-------------------------|---------------------------------------------------------------------------------------------------------------------|-----------------------|
| instance_image | The image to use for the instance | ubuntu-22-04-x64 |
| chroma_release | The chroma release to deploy | 0.4.20 |
| region | DO Region | nyc2 |
| instance_type | Droplet size | s-2vcpu-4gb |
| public_access | Enable public ingress on port 8000 | true |
| enable_auth | Enable authentication | true |
| auth_type | Authentication type | token |
| ssh_public_key | SSH Public Key | ./chroma-do.pub |
| ssh_private_key | SSH Private Key | ./chroma-do |
| chroma_data_volume_size | EBS Volume Size of the attached data volume where your chroma data is stored | 20 |
| chroma_port | The port that chroma listens on | 8000 |
| source_ranges | List of CIDR ranges to allow through the firewall | ["0.0.0.0/0", "::/0"] |
| mgmt_source_ranges | List of CIDR ranges to allow for management of the Chroma instance. This is used for SSH incoming traffic filtering | ["0.0.0.0/0", "::/0"] |

> Note: All of the above variables can be exported via environment variables (`TF_<variable_name>=<var_value>`) or set
> in a `.tfvars` file.

Set up your Terraform variables and deploy your instance:

```bash
export TF_VAR_do_token=<DIGITALOCEAN_TOKEN>
export TF_ssh_public_key="./chroma_id_rsa.pub"
export TF_ssh_private_key="./chroma_id_rsa"
export TF_VAR_chroma_release="0.4.20"
export TF_VAR_region="ams2"
export TF_VAR_public_access="true"
export TF_VAR_enable_auth="true"
export TF_VAR_auth_type="token"
terraform apply -auto-approve
```

Verify that your instance is up and running:

```bash
export instance_public_ip=$(terraform output instance_public_ip | sed 's/"//g')
curl -v http://$instance_public_ip:8000/api/v1/heartbeat
```

> Note: Depending on your OS the `sed` command might not work. In that case, you can manually copy the public IP from
> the Terraform output.

To get the auth token generated during the setup:

```bash
terraform output chroma_auth_token
```

For more details check
our [Terraform Digital Ocean deployment blueprint](https://github.com/chroma-core/chroma/tree/main/examples/deployments/do-terraform)
Loading