|
| 1 | +# Helm charts for Codezero Space Agent |
| 2 | + |
| 3 | +For further information regarding Codezero, please refer to the [Codezero documentation](https://docs.codezero.io). |
| 4 | + |
| 5 | +## Installing the Chart |
| 6 | + |
| 7 | +```sh |
| 8 | +helm repo add --force-update codezero https://charts.codezero.io |
| 9 | +helm install --create-namespace --namespace=codezero \ |
| 10 | + --set space.name='<TEAMSPACE NAME>' \ |
| 11 | + --set org.id='<ORG_ID>' \ |
| 12 | + --set org.apikey='<ORG_API_KEY>' \ |
| 13 | + codezero codezero/codezero |
| 14 | +``` |
| 15 | + |
| 16 | +## Upgrading the Chart |
| 17 | + |
| 18 | +```sh |
| 19 | +helm repo add --force-update codezero https://charts.codezero.io |
| 20 | +helm upgrade --namespace=codezero codezero codezero/codezero |
| 21 | +``` |
| 22 | + |
| 23 | +## Uninstalling the Chart |
| 24 | + |
| 25 | +```sh |
| 26 | +helm -n codezero uninstall codezero |
| 27 | +kubectl delete ns codezero |
| 28 | +``` |
| 29 | + |
| 30 | +## Configuration Options |
| 31 | + |
| 32 | +| Name | Default | Description | |
| 33 | +| -------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 34 | +| `image.repository` | `""` | Override default image repository for all codezero deployments. | |
| 35 | +| `image.tag` | `""` | Override default image tag for all codezero deployments | |
| 36 | +| `org.apikey` | `""` | Your Organization API Key | |
| 37 | +| `org.id` | `""` | Your Organization ID | |
| 38 | +| `org.secret` | `""` | Provide custom secret for `org.id` and `org.apikey`. Secret data must have the keys `CZ_HUB_ORG_ID` and `CZ_HUB_ORG_APIKEY`. Takes precedence over `org.id` and `org.apikey` helm values. |
| 39 | +| `opa.url` | `""` | URL of your Open Policy Agent | |
| 40 | +| `opa.enabled` | `false` | If true enable OPA | |
| 41 | +| `operator.image.tag` | `""` | Override default image tag for operator deployment | |
| 42 | +| `operator.image.repository` | `""` | Override default image repository for operator deployment | |
| 43 | +| `operator.labels` | `{}` | Set operator deployment labels | |
| 44 | +| `operator.podLabels` | `{}` | Set operator pod labels | |
| 45 | +| `router.image.tag` | `""` | Override default image tag for router deployment | |
| 46 | +| `router.image.repository` | `""` | Override default image repository for router deployment | |
| 47 | +| `router.labels` | `{}` | Sets router deployment labels | |
| 48 | +| `router.privilegedAccess` | `false` | If true router pods are deployed with an empty securityContext | |
| 49 | +| `router.podAnnotations` | `{}` | Set pod annotations | |
| 50 | +| `router.podLabels` | `{}` | Sets pod labels | |
| 51 | +| `router.replicas` | `1` | Number of replicas for router deployments on Serves | |
| 52 | +| `router.serviceLabels` | `{}` | Set router service labels | |
| 53 | +| `router.topologySpreadConstraints` | `[]` | Pod Topology Spread Constraints of router deployments | |
| 54 | +| `space.name` | `""` | Name of Teamspace | |
| 55 | +| `spaceagent.externalHost` | `""` | For cases where codezero's loadbalancer host is not public and custom networking/ingress is used to make the spaceagent publicly accessible | |
| 56 | +| `spaceagent.image.tag` | `""` | Override default image tag for spaceagent deployment | |
| 57 | +| `spaceagent.image.repository` | `""` | Override default image repository for spaceagent deployment | |
| 58 | +| `spaceagent.logLevel` | `info` | Set logging verbosity, valid log levels are: debug, info, warn, error. | |
| 59 | +| `spaceagent.labels` | `{}` | Set spaceagent deployment labels | |
| 60 | +| `spaceagent.podLabels` | `{}` | Set spaceagent pod labels | |
| 61 | +| `spaceagent.replicas` | `1` | Number of replicas for the Space Agent deployment` | |
| 62 | +| `spaceagent.redis.secret` | `""` | Required when `spaceagent.replicas` is greater than 1. Name of the K8s Secret that contains the Redis connection parameters with the following `data` keys: `host`, `password`. The Secret must be in the Space Agent's namespace. | |
| 63 | +| `spaceagent.service.annotations` | `{}` | Set annotations for the spaceagent service, e.g. to set cloud provider specific annotations for loadbalancer creation. |
| 64 | +| `spaceagent.service.loadBalancerIP` | `""` | Sets the IP address for the spaceagent service. If the IP address is the public IP for contacting the spaceagent set `spaceagent.externalHost` to the same value | |
| 65 | +| `spaceagent.topologySpreadConstraints` | `[]` | Pod Topology Spread Constraints of Space Agent deployment | |
0 commit comments