|
| 1 | +--- |
| 2 | +title: 'Digger Helm Chart' |
| 3 | +description: 'Description of your new file.' |
| 4 | +--- |
| 5 | + |
| 6 | +## Installation steps |
| 7 | + |
| 8 | + |
| 9 | +1. Install the `digger-backend` helm chart from https://diggerhq.github.io/helm-charts/, leaving empty all the data related to the GitHub App |
| 10 | +2. Go to `your_digger_hostname/github/setup` to install and configure the GitHub App |
| 11 | +3. Configure in the helm values or in the external secret all the data related to the new GitHub app and upgrade the helm installation to reload the Digger application with the new configuration |
| 12 | + |
| 13 | +## Configuration Details |
| 14 | + |
| 15 | +To configure the Digger backend deployment with the Helm chart, you'll need to set several values in the `values.yaml` file. Below are the key configurations to consider: |
| 16 | + |
| 17 | +- `digger.image.repository`: The Docker image repository for the Digger backend (e.g., `registry.digger.dev/diggerhq/digger_backend`). |
| 18 | +- `digger.image.tag`: The specific version tag of the Docker image to deploy (e.g., `"v0.4.2"`). |
| 19 | + |
| 20 | +- `digger.service.type`: The type of Kubernetes service to create, such as `ClusterIP`, `NodePort`, or `LoadBalancer`. |
| 21 | +- `digger.service.port`: The port number that the service will expose (e.g., `3000`). |
| 22 | + |
| 23 | +- `digger.ingress.enabled`: Set to `true` to create an Ingress for the service. |
| 24 | +- `digger.annotations`: Add the needed annotations based on your ingress controller configuration. |
| 25 | +- `digger.ingress.host`: The hostname to use for the Ingress resource (e.g., `digger-backend.test`). |
| 26 | +- `digger.ingress.path`: The path for the Ingress resource (e.g., `/`). |
| 27 | +- `digger.ingress.tls.secretName`: The name of the TLS secret to use for Ingress encryption (e.g., `digger-backend-tls`). |
| 28 | + |
| 29 | +- `digger.secret.*`: Various secrets needed for the application, such as `HTTP_BASIC_AUTH_PASSWORD` and `BEARER_AUTH_TOKEN`. You can provide them directly or reference an existing Kubernetes secret by setting `useExistingSecret` to `true` and specifying `existingSecretName`. |
| 30 | + |
| 31 | +- `digger.postgres.*`: If you're using an external Postgres database, configure the `user`, `database`, and `host` accordingly. Ensure you provide the `password` either directly or through an existing secret in the `secret.*` section. |
| 32 | + |
| 33 | +Remember to replace placeholders and default values with your specific, sensitive information before deploying the chart. For example, it's essential to generate a strong `bearerAuthToken` and `postgresPassword` rather than using the defaults for security reasons. |
| 34 | + |
| 35 | +You can also deploy a PostgreSQL database ONLY FOR TEST PURPOSES configuring the `postgres.*` section: |
| 36 | + |
| 37 | +- `postgres.enabled`: Set to `true` if you want to deploy a postgres database |
| 38 | +- `postgres.secret.*`: As for the digger secret, you can pass the `postgres` user password directly or through an existing secret |
0 commit comments