Skip to content

Commit

Permalink
Update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
@mnorbury
mnorbury committed Jan 3, 2025
1 parent ea9c326 commit a191fb8
Showing 1 changed file with 49 additions and 46 deletions.
95 changes: 49 additions & 46 deletions charts/platform/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@ Helm chart for installing the CloudQuery self-hosted platform

## Quickstart

For all instlations, you will need to have a valid activation key, and the DSNs for the Postgres and Clickhouse
databases.
For all instlations, you will need to have a valid activation key, and the DSNs for the Postgres and Clickhouse databases.

Create a `secrets.yaml` file with the following content, replacing `<activation_key>`, `<postgres_dsn>`, and
`<clickhouse_dsn>` with the appropriate values:
Create a `secrets.yaml` file with the following content, replacing `<activation_key>`, `<postgres_dsn>`, and `<clickhouse_dsn>` with the appropriate values:

```console
cat <<EOF > secrets.yml
Expand All @@ -23,8 +21,7 @@ EOF

### Kind Cluster

The following shows how to install the chart in a local [kind](https://kind.sigs.k8s.io/) cluster, configured to expose
ports 80 and 443 on the host machine for ingress.
The following shows how to install the chart in a local [kind](https://kind.sigs.k8s.io/) cluster, configured to expose ports 80 and 443 on the host machine for ingress.

First create a `kind.config` file with the following content:

Expand Down Expand Up @@ -129,8 +126,7 @@ $ helm install platform -n cloudquery --create-namespace cloudquery/platform --v

### AWS EKS Cluster

The following shows how to install the chart in an Amazon Elastic Kubernetes Service (EKS) cluster using
the [eksctl](https://eksctl.io/) CLI.
The following shows how to install the chart in an Amazon Elastic Kubernetes Service (EKS) cluster using the [eksctl](https://eksctl.io/) CLI.

First create an EKS cluster:

Expand Down Expand Up @@ -194,44 +190,51 @@ Kubernetes: `^1.8.0-0`

## Values

| Key | Type | Default | Description |
|-------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
| activationKey | string | `""` | Activation key for the self-hosted platform |
| containerSecurityContext | object | `{}` | Specify the container-level security context |
| debug.enabled | bool | `false` | Optional. Enable debug mode. |
| externalDependencies.clickhouse_dsn | string | `""` | Required: The DSN for the ClickHouse database |
| externalDependencies.postgresql_dsn | string | `""` | Required: The DSN for the Postgres database |
| fullNameOverride | string | `""` | Override the full name |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"us-east1-docker.pkg.dev/cq-cloud-prod/platform/full"` | The image repository to pull from |
| image.tag | string | `nil` | Overrides the image tag whose default is the chart appVersion |
| ingress.annotations | object | `{}` | |
| ingress.className | string | `""` | |
| ingress.enabled | bool | `false` | Optional. Enable ingress. |
| ingress.hosts[0].host | string | `"local.cloudquery.io"` | |
| ingress.hosts[0].paths[0].path | string | `"/"` | |
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
| ingress.tls | list | `[]` | |
| jwtPrivateKey | string | `""` | JWT private key for the self-hosted platform - if not provided, a new key will be generated |
| livenessProbe.httpGet.path | string | `"/"` | |
| livenessProbe.httpGet.port | string | `"api"` | |
| livenessProbe.periodSeconds | int | `60` | |
| nameOverride | string | `""` | Override the default name |
| podAnnotations | object | `{}` | Addition pod annotations |
| podLabels | object | `{}` | Addition pod labels |
| podSecurityContext | object | `{}` | Specify the pod-level security context |
| readinessProbe.httpGet.path | string | `"/"` | |
| readinessProbe.httpGet.port | string | `"api"` | |
| readinessProbe.periodSeconds | int | `30` | |
| replicaCount | int | `1` | The number of replicas to deploy |
| resources | object | `{}` | Deployment resources |
| service | object | `{"apiPort":4444,"apiType":"ClusterIP","proxyPort":3000,"proxyType":"ClusterIP","storagePort":4445,"storageType":"ClusterIP","uiPort":3001,"uiType":"ClusterIP"}` | Specify the ports the container exposes |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.automount | bool | `true` | |
| serviceAccount.create | bool | `false` | |
| serviceAccount.name | string | `""` | |
| volumeMounts | list | `[]` | Additional volumeMounts on the output Deployment definition. |
| volumes | list | `[]` | Additional volumes on the output Deployment definition. |
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| activationKey | string | `""` | Activation key for the self-hosted platform |
| containerSecurityContext | object | `{}` | Specify the container-level security context |
| debug.enabled | bool | `false` | Optional. Enable debug mode. |
| externalDependencies.clickhouse_dsn | string | `""` | Required: The DSN for the ClickHouse database |
| externalDependencies.postgresql_dsn | string | `""` | Required: The DSN for the Postgres database |
| externalSecrets | object | `{"cloudquerySecretsKey":"","enabled":false,"externalSecretsRoleARN":"","region":""}` | External secrets configuration |
| externalSecrets.cloudquerySecretsKey | string | `""` | Required: The AWS secret key for the Postgres DSN |
| externalSecrets.enabled | bool | `false` | Optional. Enable external secrets. |
| externalSecrets.externalSecretsRoleARN | string | `""` | Required: The AWS role ARN to assume when fetching the secrets |
| externalSecrets.region | string | `""` | Required: The AWS region where the secrets are stored |
| fullNameOverride | string | `""` | Override the full name |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"us-east1-docker.pkg.dev/cq-cloud-prod/platform/full"` | The image repository to pull from |
| image.tag | string | `nil` | Overrides the image tag whose default is the chart appVersion |
| ingress.annotations | object | `{}` | |
| ingress.className | string | `"nginx"` | |
| ingress.enabled | bool | `false` | Optional. Enable ingress. |
| ingress.hosts[0].host | string | `"local.cloudquery.io"` | |
| ingress.hosts[0].paths[0].path | string | `"/"` | |
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
| ingress.tls | list | `[]` | |
| jwtPrivateKey | string | `""` | JWT private key for the self-hosted platform - if not provided, a new key will be generated |
| letsEncrypt.email | string | `""` | Required: The email address to use for Let's Encrypt |
| letsEncrypt.enabled | bool | `false` | Optional. Enable Let's Encrypt. |
| livenessProbe.httpGet.path | string | `"/"` | |
| livenessProbe.httpGet.port | string | `"api"` | |
| livenessProbe.periodSeconds | int | `60` | |
| nameOverride | string | `""` | Override the default name |
| podAnnotations | object | `{}` | Addition pod annotations |
| podLabels | object | `{}` | Addition pod labels |
| podSecurityContext | object | `{}` | Specify the pod-level security context |
| readinessProbe.httpGet.path | string | `"/"` | |
| readinessProbe.httpGet.port | string | `"api"` | |
| readinessProbe.periodSeconds | int | `30` | |
| replicaCount | int | `1` | The number of replicas to deploy |
| resources | object | `{}` | Deployment resources |
| service | object | `{"apiPort":4444,"apiType":"ClusterIP","proxyPort":3000,"proxyType":"ClusterIP","storagePort":4445,"storageType":"ClusterIP","uiPort":3001,"uiType":"ClusterIP"}` | Specify the ports the container exposes |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.automount | bool | `true` | |
| serviceAccount.create | bool | `false` | |
| serviceAccount.name | string | `""` | |
| volumeMounts | list | `[]` | Additional volumeMounts on the output Deployment definition. |
| volumes | list | `[]` | Additional volumes on the output Deployment definition. |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

0 comments on commit a191fb8

Please sign in to comment.