diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 45816f5cd..fd27d42c1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ # Description đŸ“Ŗ -*Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.* + ## Type ✨ @@ -11,7 +11,7 @@ # Tests 🛠ī¸ -*Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. You may want to add screenshots when relevant and possible* + ```sh # Here's some code block to paste some code snippets diff --git a/docs/self-hosting/overview.mdx b/docs/self-hosting/overview.mdx index f149f9663..995fe93a0 100644 --- a/docs/self-hosting/overview.mdx +++ b/docs/self-hosting/overview.mdx @@ -35,101 +35,7 @@ Self-hosted Infisical allows you to maintain your sensitive information within y - You have [kubectl](https://kubernetes.io/docs/reference/kubectl/kubectl/) installed and connected to your kubernetes cluster - #### 1. Fill our environment variables - - Before you can deploy the Helm chart, you must fill out the required environment variables. To do so, please copy the below file to a `.yaml` file. - Refer to the available [environment variables](/self-hosting/configuration/envars) to learn more - - - [View all available Helm chart values parameters](https://github.com/Infisical/infisical/tree/main/helm-charts/infisical) - ```yaml - frontend: - enabled: true - name: frontend - podAnnotations: {} - deploymentAnnotations: {} - replicaCount: 2 - image: - repository: infisical/frontend - tag: "latest" - pullPolicy: IfNotPresent - kubeSecretRef: "" - service: - annotations: {} - type: ClusterIP - nodePort: "" - - frontendEnvironmentVariables: - SITE_URL: infisical.local - - backend: - enabled: true - name: backend - podAnnotations: {} - deploymentAnnotations: {} - replicaCount: 2 - image: - repository: infisical/backend - tag: "latest" - pullPolicy: IfNotPresent - kubeSecretRef: "" - service: - annotations: {} - type: ClusterIP - nodePort: "" - - backendEnvironmentVariables: - ENCRYPTION_KEY: MUST_REPLACE - JWT_SIGNUP_SECRET: MUST_REPLACE - JWT_REFRESH_SECRET: MUST_REPLACE - JWT_AUTH_SECRET: MUST_REPLACE - JWT_SERVICE_SECRET: MUST_REPLACE - SMTP_HOST: MUST_REPLACE - SMTP_PORT: 587 - SMTP_SECURE: false - SMTP_FROM_NAME: Infisical - SMTP_FROM_ADDRESS: MUST_REPLACE - SMTP_USERNAME: MUST_REPLACE - SMTP_PASSWORD: MUST_REPLACE - SITE_URL: infisical.local - - ## Mongo DB persistence - mongodb: - enabled: true - - ## By default the backend will be connected to a Mongo instance within the cluster - ## However, it is recommended to add a managed document DB connection string for production-use (DBaaS) - ## Learn about connection string type here https://www.mongodb.com/docs/manual/reference/connection-string/ - ## e.g. "mongodb://:@:/" - mongodbConnection: - externalMongoDBConnectionString: "" - - ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: "nginx" - # cert-manager.io/issuer: letsencrypt-nginx - hostName: infisical.local ## <- Replace with your own domain - frontend: - path: / - pathType: Prefix - backend: - path: /api - pathType: Prefix - tls: [] - # - secretName: letsencrypt-nginx - # hosts: - # - infisical.local - - mailhog: - enabled: false - ``` - - - Once you have a local copy of the values file, fill our the required environment variables and save the file. - - - #### 2. Install Infisical Helm repository + #### 1. Install Infisical Helm repository ```bash helm repo add infisical-helm-charts 'https://dl.cloudsmith.io/public/infisical/helm-charts/helm/charts/' @@ -137,23 +43,22 @@ Self-hosted Infisical allows you to maintain your sensitive information within y helm repo update ``` - #### 3. Install the Helm chart + #### 2. Install the Helm chart By default, the helm chart will be installed on your default namespace. If you wish to install the Chart on a different namespace, you may specify that by adding the `--namespace ` to your `helm install` command. ```bash ## Installs to default namespace - helm install infisical-helm-charts/infisical --generate-name --values + helm install infisical-helm-charts/infisical --generate-name ``` - - If you have not filled out all of the required environment variables, you will see an error message prompting you to - do so. - - - #### 4. Your Infisical installation is complete and should be running on the host name you specified in Ingress in `values.yaml`. + #### 3. Access Infisical + Allow 3-5 minutes for the deployment to complete. Once done, you should now be able to access Infisical on the IP address exposed via Ingress on your load balancer. If you are not sure what the IP address is run `kubectl get ingress` to view the external IP address exposing Infisical. + #### Custom configuration + To configure environment variables, database and deployments, you'll need to set the parameters in a `values.yaml` file. To view all available parameters [visit here](https://github.com/Infisical/infisical/tree/main/helm-charts/infisical#parameters) + 1. Install Docker on your VM diff --git a/helm-charts/README.md b/helm-charts/README.md index 1bb587a2a..858f458bb 100644 --- a/helm-charts/README.md +++ b/helm-charts/README.md @@ -36,4 +36,4 @@ Steps to update the documentation : 1. `npm install ./readme-generator-for-helm` 1. `npm exec readme-generator -- --readme README.md --values values.yaml` - It'll insert the table below the `## Parameters` title - - It'll output errors if some of the path aren't documented \ No newline at end of file + - It'll output errors if some of the path aren't documented diff --git a/helm-charts/infisical/.gitignore b/helm-charts/infisical/.gitignore index a2968aad7..c9fe0caa7 100644 --- a/helm-charts/infisical/.gitignore +++ b/helm-charts/infisical/.gitignore @@ -1,3 +1,4 @@ charts/ node_modules/ -package*.json \ No newline at end of file +package*.json +*.bak \ No newline at end of file diff --git a/helm-charts/infisical/Chart.lock b/helm-charts/infisical/Chart.lock index 3b5f48ca4..5170df21b 100644 --- a/helm-charts/infisical/Chart.lock +++ b/helm-charts/infisical/Chart.lock @@ -1,9 +1,9 @@ dependencies: - name: mongodb repository: https://charts.bitnami.com/bitnami - version: 13.6.7 + version: 13.9.1 - name: mailhog repository: https://codecentric.github.io/helm-charts version: 5.2.3 -digest: sha256:a54ae9ee60775f6f1aa916b59aee55b3ed5234b6bd88185fcb118b7f69539d70 -generated: "2023-02-13T14:13:27.525541038+01:00" +digest: sha256:1ddb3ffef899859222b72547657f57ea303e768d67886a4a57edcb0f773ea83f +generated: "2023-03-14T12:58:34.387144895+01:00" diff --git a/helm-charts/infisical/Chart.yaml b/helm-charts/infisical/Chart.yaml index 80fe48fcc..55cc51b9b 100644 --- a/helm-charts/infisical/Chart.yaml +++ b/helm-charts/infisical/Chart.yaml @@ -7,7 +7,7 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.1.15 +version: 0.1.16 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to @@ -17,7 +17,7 @@ appVersion: "1.17.0" dependencies: - name: mongodb - version: "~13.6.7" + version: "~13.9.1" repository: "https://charts.bitnami.com/bitnami" condition: mongodb.enabled - name: mailhog diff --git a/helm-charts/infisical/README.md b/helm-charts/infisical/README.md index 4e20bbc86..e614d9600 100644 --- a/helm-charts/infisical/README.md +++ b/helm-charts/infisical/README.md @@ -6,7 +6,7 @@ This is the Infisical application Helm chart. This chart includes the following | ---------- | ----------------------------------- | | `frontend` | Infisical's Web UI | | `backend` | Infisical's API | -| `mongodb` | Infisical's local database | +| `mongodb` | Infisical's database | | `mailhog` | Infisical's development SMTP server | ## Installation @@ -36,6 +36,19 @@ helm upgrade --install --atomic \ infisical infisical/infisical ``` +### Backup up encryption keys + +If you did not explicitly set required environment variables, this helm chart will auto-generated them by default. It's recommended to save these credentials somewhere safe. Run the following command in your cluster where Infisical chart is installed. + +This command requires [`jq`](https://stedolan.github.io/jq/download/) + +```sh +# export secrets to a given file (requires jq) +kubectl get secrets -n \ + -o json | jq '.data | map_values(@base64d)' > \ + .bak +``` + ## Parameters ### Common parameters @@ -68,34 +81,37 @@ helm upgrade --install --atomic \ ### Infisical backend parameters -| Name | Description | Value | -| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------- | -| `backend.enabled` | Enable backend | `true` | -| `backend.name` | Backend name | `backend` | -| `backend.fullnameOverride` | Backend fullnameOverride | `""` | -| `backend.podAnnotations` | Backend pod annotations | `{}` | -| `backend.deploymentAnnotations` | Backend deployment annotations | `{}` | -| `backend.replicaCount` | Backend replica count | `2` | -| `backend.image.repository` | Backend image repository | `infisical/backend` | -| `backend.image.tag` | Backend image tag | `latest` | -| `backend.image.pullPolicy` | Backend image pullPolicy | `IfNotPresent` | -| `backend.kubeSecretRef` | Backend secret resource reference name (containing required [backend configuration variables](https://infisical.com/docs/self-hosting/configuration/envars)) | `""` | -| `backend.service.annotations` | Backend service annotations | `{}` | -| `backend.service.type` | Backend service type | `ClusterIP` | -| `backend.service.nodePort` | Backend service nodePort (used if above type is `NodePort`) | `""` | -| `backendEnvironmentVariables.ENCRYPTION_KEY` | **Required** Backend encryption key (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) | `MUST_REPLACE` | -| `backendEnvironmentVariables.JWT_SIGNUP_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) | `MUST_REPLACE` | -| `backendEnvironmentVariables.JWT_REFRESH_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) | `MUST_REPLACE` | -| `backendEnvironmentVariables.JWT_AUTH_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) | `MUST_REPLACE` | -| `backendEnvironmentVariables.JWT_SERVICE_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) | `MUST_REPLACE` | -| `backendEnvironmentVariables.SMTP_HOST` | **Required** Hostname to connect to for establishing SMTP connections | `MUST_REPLACE` | -| `backendEnvironmentVariables.SMTP_PORT` | Port to connect to for establishing SMTP connections | `587` | -| `backendEnvironmentVariables.SMTP_SECURE` | If true, use TLS when connecting to host. If false, TLS will be used if STARTTLS is supported | `false` | -| `backendEnvironmentVariables.SMTP_FROM_NAME` | Name label to be used in From field (e.g. Infisical) | `Infisical` | -| `backendEnvironmentVariables.SMTP_FROM_ADDRESS` | **Required** Email address to be used for sending emails (e.g. dev@infisical.com) | `MUST_REPLACE` | -| `backendEnvironmentVariables.SMTP_USERNAME` | **Required** Credential to connect to host (e.g. team@infisical.com) | `MUST_REPLACE` | -| `backendEnvironmentVariables.SMTP_PASSWORD` | **Required** Credential to connect to host | `MUST_REPLACE` | -| `backendEnvironmentVariables.SITE_URL` | Absolute URL including the protocol (e.g. https://app.infisical.com) | `infisical.local` | +| Name | Description | Value | +| ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | +| `backend.enabled` | Enable backend | `true` | +| `backend.name` | Backend name | `backend` | +| `backend.fullnameOverride` | Backend fullnameOverride | `""` | +| `backend.podAnnotations` | Backend pod annotations | `{}` | +| `backend.deploymentAnnotations` | Backend deployment annotations | `{}` | +| `backend.replicaCount` | Backend replica count | `2` | +| `backend.image.repository` | Backend image repository | `infisical/backend` | +| `backend.image.tag` | Backend image tag | `latest` | +| `backend.image.pullPolicy` | Backend image pullPolicy | `IfNotPresent` | +| `backend.kubeSecretRef` | Backend secret resource reference name (containing required [backend configuration variables](https://infisical.com/docs/self-hosting/configuration/envars)) | `""` | +| `backend.service.annotations` | Backend service annotations | `{}` | +| `backend.service.type` | Backend service type | `ClusterIP` | +| `backend.service.nodePort` | Backend service nodePort (used if above type is `NodePort`) | `""` | +| `backendEnvironmentVariables.ENCRYPTION_KEY` | **Required** Backend encryption key (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) | `""` | +| `backendEnvironmentVariables.JWT_SIGNUP_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) | `""` | +| `backendEnvironmentVariables.JWT_REFRESH_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) | `""` | +| `backendEnvironmentVariables.JWT_AUTH_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) | `""` | +| `backendEnvironmentVariables.JWT_SERVICE_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) | `""` | +| `backendEnvironmentVariables.JWT_MFA_SECRET` | **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) | `""` | +| `backendEnvironmentVariables.SMTP_HOST` | **Required** Hostname to connect to for establishing SMTP connections | `""` | +| `backendEnvironmentVariables.SMTP_PORT` | Port to connect to for establishing SMTP connections | `587` | +| `backendEnvironmentVariables.SMTP_SECURE` | If true, use TLS when connecting to host. If false, TLS will be used if STARTTLS is supported | `false` | +| `backendEnvironmentVariables.SMTP_FROM_NAME` | Name label to be used in From field (e.g. Infisical) | `Infisical` | +| `backendEnvironmentVariables.SMTP_FROM_ADDRESS` | **Required** Email address to be used for sending emails (e.g. dev@infisical.com) | `""` | +| `backendEnvironmentVariables.SMTP_USERNAME` | **Required** Credential to connect to host (e.g. team@infisical.com) | `""` | +| `backendEnvironmentVariables.SMTP_PASSWORD` | **Required** Credential to connect to host | `""` | +| `backendEnvironmentVariables.SITE_URL` | Absolute URL including the protocol (e.g. https://app.infisical.com) | `infisical.local` | +| `backendEnvironmentVariables.INVITE_ONLY_SIGNUP` | To disable account creation from the login page (invites only) | `false` | +| `backendEnvironmentVariables.MONGO_URL` | MongoDB connection string (external or internal)
Leave it empty for auto-generated connection string | `""` | ### MongoDB(®) parameters @@ -112,26 +128,42 @@ helm upgrade --install --atomic \ | `mongodb.image.repository` | MongoDB(®) image registry | `bitnami/mongodb` | | `mongodb.image.tag` | MongoDB(®) image tag (immutable tags are recommended) | `6.0.4-debian-11-r0` | | `mongodb.image.pullPolicy` | MongoDB(®) image pull policy | `IfNotPresent` | +| `mongodb.livenessProbe.enabled` | Enable livenessProbe | `true` | +| `mongodb.livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `30` | +| `mongodb.livenessProbe.periodSeconds` | Period seconds for livenessProbe | `20` | +| `mongodb.livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `10` | +| `mongodb.livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `6` | +| `mongodb.livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` | +| `mongodb.readinessProbe.enabled` | Enable readinessProbe | `true` | +| `mongodb.readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `5` | +| `mongodb.readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` | +| `mongodb.readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `10` | +| `mongodb.readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `6` | +| `mongodb.readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` | | `mongodb.service.annotations` | Service annotations | `{}` | | `mongodb.auth.enabled` | Enable custom authentication | `true` | | `mongodb.auth.usernames` | Custom usernames list ([special characters warning](https://www.mongodb.com/docs/manual/reference/connection-string/#standard-connection-string-format)) | `["infisical"]` | | `mongodb.auth.passwords` | Custom passwords list, match the above usernames order ([special characters warning](https://www.mongodb.com/docs/manual/reference/connection-string/#standard-connection-string-format)) | `["infisical"]` | | `mongodb.auth.databases` | Custom databases list ([special characters warning](https://www.mongodb.com/docs/manual/reference/connection-string/#standard-connection-string-format)) | `["infisical"]` | +| `mongodb.auth.rootUser` | Database root user name | `root` | +| `mongodb.auth.rootPassword` | Database root user password | `root` | | `mongodb.persistence.enabled` | Enable database persistence | `true` | | `mongodb.persistence.existingClaim` | Existing persistent volume claim name | `""` | | `mongodb.persistence.resourcePolicy` | Keep the persistent volume even on deletion (`keep` or `""`) | `keep` | | `mongodb.persistence.accessModes` | Persistent volume access modes | `["ReadWriteOnce"]` | | `mongodb.persistence.size` | Persistent storage request size | `8Gi` | -| `mongodbConnection.externalMongoDBConnectionString` | External MongoDB connection string | `""` | +| `mongodbConnection.externalMongoDBConnectionString` | Deprecated :warning: External MongoDB connection string
Use backendEnvironmentVariables.MONGO_URL instead | `""` | ### Ingress parameters -| Name | Description | Value | -| ------------------ | ------------------------------------------- | ----------------- | -| `ingress.enabled` | Enable ingress | `true` | -| `ingress.hostName` | Ingress hostname (your custom domain name) | `infisical.local` | -| `ingress.tls` | Ingress TLS hosts (matching above hostName) | `[]` | +| Name | Description | Value | +| -------------------------- | ------------------------------------------------------------------------ | ------- | +| `ingress.enabled` | Enable ingress | `true` | +| `ingress.ingressClassName` | Ingress class name | `nginx` | +| `ingress.annotations` | Ingress annotations | `{}` | +| `ingress.hostName` | Ingress hostname (your custom domain name, e.g. `infisical.example.org`) | `""` | +| `ingress.tls` | Ingress TLS hosts (matching above hostName) | `[]` | ### Mailhog parameters @@ -152,7 +184,7 @@ helm upgrade --install --atomic \ | `mailhog.ingress.labels` | Ingress labels | `{}` | | `mailhog.ingress.hosts[0].host` | Mailhog host | `mailhog.infisical.local` | -Learn more in our [docs](https://infisical.com/docs/self-hosting/deployments/kubernetes) + ## Persistence @@ -185,32 +217,37 @@ Below example will deploy the following : - The corresponding IP will depend on the tool or the way you're exposing the services ([learn more](https://minikube.sigs.k8s.io/docs/handbook/host-access/)) - [**mailhog.infisical.local**](https://mailhog.infisical.local) - - Local SMTP server used to receive the signup verification code + - Local SMTP server used to receive the emails (e.g. signup verification code) - You may have to add `mailhog.infisical.local` to your `/etc/hosts` or similar depending your OS - The corresponding IP will depend on the tool or the way you're exposing the services ([learn more](https://minikube.sigs.k8s.io/docs/handbook/host-access/)) Use below values to setup a local development environment, adapt those variables as you need +#### TL;DR + +If you're running a k8s cluster with `ingress-nginx`, you can run one of the below scripts : + +```sh +# With 'kind' + 'helm', to create a local cluster and deploy the chart +./examples.local-kind.sh + +# With 'helm' only, if you already have a cluster to deploy the chart +./examples.local-helm.sh +``` + +#### Instructions + +Here's the step-by-step instructions to setup your local development environment. First create the below file : + ```yaml # values.dev.yaml -# Enable all services for local development -frontend: - enabled: true -backend: - enabled: true -mongodb: - enabled: true +# Enable mailhog for local development mailhog: enabled: true # Configure backend development variables (required) backendEnvironmentVariables: - ENCRYPTION_KEY: 6c1fe4e407b8911c104518103505b218 - JWT_AUTH_SECRET: 4be6ba5602e0fa0ac6ac05c3cd4d247f - JWT_REFRESH_SECRET: 5f2f3c8f0159068dc2bbb3a652a716ff - JWT_SERVICE_SECRET: f32f716d70a42c5703f4656015e76200 - JWT_SIGNUP_SECRET: 3679e04ca949f914c03332aaaeba805a SITE_URL: https://infisical.local SMTP_FROM_ADDRESS: dev@infisical.local SMTP_FROM_NAME: Local Infisical @@ -240,6 +277,65 @@ helm upgrade --install --atomic \ ## Upgrading -### 1.15.0 +Find the chart upgrade instructions below. When upgrading from your version to one of the listed below, please follow every instructions in between. -Refactoring in progress, instructions are coming soon \ No newline at end of file +Here's a snippet to upgrade your installation manually : + +```sh +# replace below '' with your own values +helm upgrade --install --atomic \ + -n "" --create-namespace \ + -f "" \ + . +``` + +ℹī¸ Since we provide references to the k8s secret resources within the pods, their manifest file doesnt change and though doesnt reload (no changes detected). When upgrading your secrets, you'll have to do it through Helm (a timestamp field will be updated and your pods restarted) + +### 0.1.16 + +- Auto-generation for the following variables, to ease your future upgrades or setups : + - `ENCRYPTION_KEY` + - `JWT_SIGNUP_SECRET` + - `JWT_REFRESH_SECRET` + - `JWT_AUTH_SECRET` + - `JWT_SERVICE_SECRET` + - `JWT_MFA_SECRET` + +We've migrated the applications' environment variables into `secrets` resources, shared within the deployments through `envFrom`. If you upgrade your installation make sure to backup your deployments' environment variables (e.g. encryption key and jwt secrets). + +The preference order is : +- **user-defined** (values file or inline) + - **existing-secret** (for existing installations, you don't have to specify the secrets when upgrading if they already exist) + - **auto-generated** (if none of the values above have been found, we'll auto-generate a value for the user, only for the above mentioned variables) + +#### Instructions + +1. Make sure **you have all the required environment variables** defined in the value file (or inline `--set`) you'll provide to `helm` + 1. e.g. All the above mentioned variables +1. **Backup your existing secrets** (safety precaution) + 1. with below [snippets](#snippets) +1. **Upgrade the chart**, with the [instructions](#upgrading) + 1. It'll create a secret per service, and store the secrets/conf within (auto-generate if you don't provide the required ones) + 1. It'll link the secret to the deployment through `envFrom` + 1. It'll automatically remove the hard-coded `env.*` variables from your infisical deployments +1. Make sure that the **created secrets match the ones in your backups** + 1. e.g. `kubectl get secret -n -backend --template={{.data.ENCRYPTION_KEY}} | base64 -d` +1. You're all set! + +#### Snippets + +Here's some snippets to backup your current secrets **before the upgrade** (:warning: it requires [`jq`](https://stedolan.github.io/jq/download/)) : + +```sh +# replace the below variables with yours (namespace + app) +namespace=infisical; app=infisical; components="frontend backend" + +for component in $components; do + dpl=$(kubectl get deployment -n $namespace -l app=$app -l component=$component \ + -o jsonpath="{.items[0].metadata.name}") + + kubectl get deployments -n $namespace $dpl \ + -o jsonpath='{.spec.template.spec.containers[0].env[*]}' | \ + jq -r '.name + ":" + .value' > infisical-$component-conf.bak +done +``` \ No newline at end of file diff --git a/helm-charts/infisical/examples/local-helm.sh b/helm-charts/infisical/examples/local-helm.sh new file mode 100755 index 000000000..ac7466821 --- /dev/null +++ b/helm-charts/infisical/examples/local-helm.sh @@ -0,0 +1,37 @@ +#!/usr/bin/env bash + +## Infisical local k8s development environment setup script +## using 'helm' and assume you already have a cluster and an ingress (nginx) +## + +## +## DEVELOPMENT USE ONLY +## DO NOT USE IN PRODUCTION +## + +# define variables +cluster_name=infisical +host=infisical.local + +# install infisical (local development) +helm dep update +cat < -n {{ .Release.Namespace }} \ + -o json | jq '.data | map_values(@base64d)' > .bak + +――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――┤ ## \ No newline at end of file diff --git a/helm-charts/infisical/templates/_helpers.tpl b/helm-charts/infisical/templates/_helpers.tpl index bf3f8e301..500edea33 100644 --- a/helm-charts/infisical/templates/_helpers.tpl +++ b/helm-charts/infisical/templates/_helpers.tpl @@ -122,8 +122,9 @@ Create the mongodb connection string. {{- $pass := first .Values.mongodb.auth.passwords | default "root" -}} {{- $database := first .Values.mongodb.auth.databases | default "test" -}} {{- $connectionString := printf "mongodb://%s:%s@%s:%d/%s" $user $pass $host $port $database -}} +{{/* Backward compatibility (< 0.1.16, deprecated) */}} {{- if .Values.mongodbConnection.externalMongoDBConnectionString -}} {{- $connectionString = .Values.mongodbConnection.externalMongoDBConnectionString -}} {{- end -}} {{- printf "%s" $connectionString -}} -{{- end -}} +{{- end -}} \ No newline at end of file diff --git a/helm-charts/infisical/templates/backend-deployment.yaml b/helm-charts/infisical/templates/backend-deployment.yaml index f93f3c87e..797439019 100644 --- a/helm-charts/infisical/templates/backend-deployment.yaml +++ b/helm-charts/infisical/templates/backend-deployment.yaml @@ -1,31 +1,34 @@ +{{- $backend := .Values.backend }} apiVersion: apps/v1 kind: Deployment metadata: name: {{ include "infisical.backend.fullname" . }} - {{- with .Values.backend.deploymentAnnotations }} annotations: - {{- toYaml . | nindent 8 }} - {{- end }} + updatedAt: {{ now | date "2006-01-01 MST 15:04:05" | quote }} + {{- with $backend.deploymentAnnotations }} + {{- toYaml . | nindent 4 }} + {{- end }} labels: {{- include "infisical.backend.labels" . | nindent 4 }} spec: - replicas: {{ .Values.backend.replicaCount }} + replicas: {{ $backend.replicaCount }} selector: matchLabels: {{- include "infisical.backend.matchLabels" . | nindent 6 }} template: - metadata: + metadata: labels: {{- include "infisical.backend.matchLabels" . | nindent 8 }} - {{- with .Values.backend.podAnnotations }} annotations: + updatedAt: {{ now | date "2006-01-01 MST 15:04:05" | quote }} + {{- with $backend.podAnnotations }} {{- toYaml . | nindent 8 }} - {{- end }} + {{- end }} spec: containers: - - name: {{ template "infisical.name" . }}-{{ .Values.backend.name }} - image: "{{ .Values.backend.image.repository }}:{{ .Values.backend.image.tag | default .Chart.AppVersion }}" - imagePullPolicy: {{ .Values.backend.image.pullPolicy }} + - name: {{ template "infisical.name" . }}-{{ $backend.name }} + image: "{{ $backend.image.repository }}:{{ $backend.image.tag | default "latest" }}" + imagePullPolicy: {{ $backend.image.pullPolicy }} readinessProbe: httpGet: path: /api/status @@ -34,43 +37,58 @@ spec: periodSeconds: 10 ports: - containerPort: 4000 - {{- if .Values.backend.kubeSecretRef }} envFrom: - secretRef: - name: {{ .Values.backend.kubeSecretRef }} - {{- end }} - env: - - name: MONGO_URL - value: {{ include "infisical.mongodb.connectionString" . | quote }} - {{- if .Values.backendEnvironmentVariables }} - {{- range $key, $value := .Values.backendEnvironmentVariables }} - {{- if $value | quote | eq "MUST_REPLACE" }} - {{ fail "Environment variables are not set. Please set all environment variables to continue." }} - {{ end }} - - name: {{ $key }} - value: {{ quote $value }} - {{- end }} - {{- end }} + name: {{ $backend.kubeSecretRef | default (include "infisical.backend.fullname" .) }} --- + apiVersion: v1 kind: Service metadata: name: {{ include "infisical.backend.fullname" . }} labels: {{- include "infisical.backend.labels" . | nindent 4 }} - {{- with .Values.backend.service.annotations }} + {{- with $backend.service.annotations }} annotations: {{- toYaml . | nindent 4 }} {{- end }} spec: - type: {{ .Values.backend.service.type }} + type: {{ $backend.service.type }} selector: {{- include "infisical.backend.matchLabels" . | nindent 8 }} ports: - protocol: TCP port: 4000 targetPort: 4000 # container port - {{- if eq .Values.backend.service.type "NodePort" }} - nodePort: {{ .Values.backend.service.nodePort }} + {{- if eq $backend.service.type "NodePort" }} + nodePort: {{ $backend.service.nodePort }} {{- end }} + +--- + +{{ if not $backend.kubeSecretRef }} +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "infisical.backend.fullname" . }} + annotations: + "helm.sh/resource-policy": "keep" +type: Opaque +stringData: + {{- $requiredVars := dict "ENCRYPTION_KEY" (randAlphaNum 32 | lower) + "JWT_SIGNUP_SECRET" (randAlphaNum 32 | lower) + "JWT_REFRESH_SECRET" (randAlphaNum 32 | lower) + "JWT_AUTH_SECRET" (randAlphaNum 32 | lower) + "JWT_SERVICE_SECRET" (randAlphaNum 32 | lower) + "JWT_MFA_SECRET" (randAlphaNum 32 | lower) + "MONGO_URL" (include "infisical.mongodb.connectionString" .) }} + {{- $secretObj := (lookup "v1" "Secret" .Release.Namespace (include "infisical.backend.fullname" .)) | default dict }} + {{- $secretData := (get $secretObj "data") | default dict }} + {{ range $key, $value := .Values.backendEnvironmentVariables }} + {{- $default := get $requiredVars $key -}} + {{- $current := get $secretData $key | b64dec -}} + {{- $v := $value | default ($current | default $default) -}} + {{ $key }}: {{ $v | quote }} + {{ end -}} +{{- end }} diff --git a/helm-charts/infisical/templates/frontend-deployment.yaml b/helm-charts/infisical/templates/frontend-deployment.yaml index d396e5628..9c5cd1560 100644 --- a/helm-charts/infisical/templates/frontend-deployment.yaml +++ b/helm-charts/infisical/templates/frontend-deployment.yaml @@ -1,15 +1,17 @@ +{{- $frontend := .Values.frontend }} apiVersion: apps/v1 kind: Deployment metadata: name: {{ include "infisical.frontend.fullname" . }} - {{- with .Values.frontend.deploymentAnnotations }} annotations: - {{- toYaml . | nindent 8 }} + updatedAt: {{ now | date "2006-01-01 MST 15:04:05" | quote }} + {{- with .Values.frontend.deploymentAnnotations }} + {{- toYaml . | nindent 4 }} {{- end }} labels: {{- include "infisical.frontend.labels" . | nindent 4 }} spec: - replicas: {{ .Values.frontend.replicaCount }} + replicas: {{ $frontend.replicaCount }} selector: matchLabels: {{- include "infisical.frontend.matchLabels" . | nindent 6 }} @@ -17,57 +19,70 @@ spec: metadata: labels: {{- include "infisical.frontend.matchLabels" . | nindent 8 }} - {{- with .Values.frontend.podAnnotations }} annotations: + updatedAt: {{ now | date "2006-01-01 MST 15:04:05" | quote }} + {{- with $frontend.podAnnotations }} {{- toYaml . | nindent 8 }} - {{- end }} + {{- end }} spec: containers: - - name: {{ template "infisical.name" . }}-{{ .Values.frontend.name }} - image: "{{ .Values.frontend.image.repository }}:{{ .Values.frontend.image.tag | default .Chart.AppVersion }}" - imagePullPolicy: {{ .Values.frontend.image.pullPolicy }} + - name: {{ template "infisical.name" . }}-{{ $frontend.name }} + image: "{{ $frontend.image.repository }}:{{ $frontend.image.tag | default "latest" }}" + imagePullPolicy: {{ $frontend.image.pullPolicy }} readinessProbe: httpGet: path: / port: 3000 initialDelaySeconds: 10 periodSeconds: 10 - {{- if .Values.frontend.kubeSecretRef }} envFrom: - secretRef: - name: {{ .Values.frontend.kubeSecretRef }} - {{- end }} - {{- if .Values.frontendEnvironmentVariables }} - env: - {{- range $key, $value := .Values.frontendEnvironmentVariables }} - {{- if $value | quote | eq "MUST_REPLACE" }} - {{ fail "Environment variables are not set. Please set all environment variables to continue." }} - {{ end }} - - name: {{ $key }} - value: {{ quote $value }} - {{- end }} - {{- end }} + name: {{ $frontend.kubeSecretRef | default (include "infisical.frontend.fullname" .) }} ports: - containerPort: 3000 + --- + apiVersion: v1 kind: Service metadata: name: {{ include "infisical.frontend.fullname" . }} labels: {{- include "infisical.frontend.labels" . | nindent 4 }} - {{- with .Values.frontend.service.annotations }} + {{- with $frontend.service.annotations }} annotations: {{- toYaml . | nindent 4 }} {{- end }} spec: - type: {{ .Values.frontend.service.type }} + type: {{ $frontend.service.type }} selector: {{- include "infisical.frontend.matchLabels" . | nindent 8 }} ports: - protocol: TCP port: 3000 # service targetPort: 3000 # container port - {{- if eq .Values.frontend.service.type "NodePort" }} - nodePort: {{ .Values.frontend.service.nodePort }} - {{- end }} \ No newline at end of file + {{- if eq $frontend.service.type "NodePort" }} + nodePort: {{ $frontend.service.nodePort }} + {{- end }} + +--- + +{{ if not $frontend.kubeSecretRef }} +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "infisical.frontend.fullname" . }} + annotations: + "helm.sh/resource-policy": "keep" +type: Opaque +stringData: + {{- $requiredVars := dict }} + {{- $secretObj := (lookup "v1" "Secret" .Release.Namespace (include "infisical.frontend.fullname" .)) | default dict }} + {{- $secretData := (get $secretObj "data") | default dict }} + {{ range $key, $value := .Values.frontendEnvironmentVariables }} + {{- $default := get $requiredVars $key -}} + {{- $current := get $secretData $key | b64dec -}} + {{- $v := $value | default ($current | default $default) -}} + {{ $key }}: {{ $v | quote }} + {{ end -}} +{{- end }} \ No newline at end of file diff --git a/helm-charts/infisical/templates/ingress.yaml b/helm-charts/infisical/templates/ingress.yaml index cf9952ea3..a675fa2ff 100644 --- a/helm-charts/infisical/templates/ingress.yaml +++ b/helm-charts/infisical/templates/ingress.yaml @@ -1,16 +1,25 @@ {{ if .Values.ingress.enabled }} +{{- $ingress := .Values.ingress }} +{{- if and $ingress.ingressClassName (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }} + {{- if not (hasKey $ingress.annotations "kubernetes.io/ingress.class") }} + {{- $_ := set $ingress.annotations "kubernetes.io/ingress.class" $ingress.ingressClassName}} + {{- end }} +{{- end }} apiVersion: networking.k8s.io/v1 kind: Ingress metadata: name: infisical-ingress - {{- with .Values.ingress.annotations }} + {{- with $ingress.annotations }} annotations: {{- toYaml . | nindent 4 }} {{- end }} spec: -{{- if .Values.ingress.tls }} + {{- if and $ingress.ingressClassName (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + ingressClassName: {{ $ingress.ingressClassName | default "nginx" }} + {{- end }} +{{- if $ingress.tls }} tls: - {{- range .Values.ingress.tls }} + {{- range $ingress.tls }} - hosts: {{- range .hosts }} - {{ . | quote }} @@ -19,21 +28,23 @@ spec: {{- end }} {{- end }} rules: - - host: {{ .Values.ingress.hostName}} - http: - paths: - - path: {{ .Values.ingress.frontend.path }} - pathType: {{ .Values.ingress.frontend.pathType }} - backend: - service: - name: {{ include "infisical.frontend.fullname" . }} - port: - number: 3000 - - path: {{ .Values.ingress.backend.path }} - pathType: {{ .Values.ingress.backend.pathType }} - backend: - service: - name: {{ include "infisical.backend.fullname" . }} - port: - number: 4000 + - http: + paths: + - path: {{ $ingress.frontend.path }} + pathType: {{ $ingress.frontend.pathType }} + backend: + service: + name: {{ include "infisical.frontend.fullname" . }} + port: + number: 3000 + - path: {{ $ingress.backend.path }} + pathType: {{ $ingress.backend.pathType }} + backend: + service: + name: {{ include "infisical.backend.fullname" . }} + port: + number: 4000 + {{- if $ingress.hostName }} + host: {{ $ingress.hostName }} + {{- end }} {{ end }} \ No newline at end of file diff --git a/helm-charts/infisical/values.yaml b/helm-charts/infisical/values.yaml index d569e7c31..67c222278 100644 --- a/helm-charts/infisical/values.yaml +++ b/helm-charts/infisical/values.yaml @@ -46,6 +46,8 @@ frontend: ## @param frontend.kubeSecretRef Backend secret resource reference name (containing required [frontend configuration variables](https://infisical.com/docs/self-hosting/configuration/envars)) ## kubeSecretRef: "" + ## Frontend service + ## service: ## @param frontend.service.annotations Backend service annotations ## @@ -103,6 +105,8 @@ backend: ## @param backend.kubeSecretRef Backend secret resource reference name (containing required [backend configuration variables](https://infisical.com/docs/self-hosting/configuration/envars)) ## kubeSecretRef: "" + ## Backend service + ## service: ## @param backend.service.annotations Backend service annotations ## @@ -118,20 +122,22 @@ backend: ## Documentation : https://infisical.com/docs/self-hosting/configuration/envars ## backendEnvironmentVariables: - ## @param backendEnvironmentVariables.ENCRYPTION_KEY **Required** Backend encryption key (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) + ## @param backendEnvironmentVariables.ENCRYPTION_KEY **Required** Backend encryption key (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) ## Command to generate the required value (linux) : 'hexdump -vn16 -e'4/4 "%08X" 1 "\n"' /dev/urandom', 'openssl rand -hex 16' ## - ENCRYPTION_KEY: MUST_REPLACE - ## @param backendEnvironmentVariables.JWT_SIGNUP_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) - ## @param backendEnvironmentVariables.JWT_REFRESH_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) - ## @param backendEnvironmentVariables.JWT_AUTH_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) - ## @param backendEnvironmentVariables.JWT_SERVICE_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057)) + ENCRYPTION_KEY: "" + ## @param backendEnvironmentVariables.JWT_SIGNUP_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) + ## @param backendEnvironmentVariables.JWT_REFRESH_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) + ## @param backendEnvironmentVariables.JWT_AUTH_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) + ## @param backendEnvironmentVariables.JWT_SERVICE_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) + ## @param backendEnvironmentVariables.JWT_MFA_SECRET **Required** Secrets to sign JWT tokens (128-bit hex value, 32-characters hex, [example](https://stackoverflow.com/a/34329057))
auto-generated variable (if not provided, and not found in an existing secret) ## Command to generate the required value (linux) : 'hexdump -vn16 -e'4/4 "%08X" 1 "\n"' /dev/urandom', 'openssl rand -hex 16' ## - JWT_SIGNUP_SECRET: MUST_REPLACE - JWT_REFRESH_SECRET: MUST_REPLACE - JWT_AUTH_SECRET: MUST_REPLACE - JWT_SERVICE_SECRET: MUST_REPLACE + JWT_SIGNUP_SECRET: "" + JWT_REFRESH_SECRET: "" + JWT_AUTH_SECRET: "" + JWT_SERVICE_SECRET: "" + JWT_MFA_SECRET: "" ## @param backendEnvironmentVariables.SMTP_HOST **Required** Hostname to connect to for establishing SMTP connections ## @param backendEnvironmentVariables.SMTP_PORT Port to connect to for establishing SMTP connections ## @param backendEnvironmentVariables.SMTP_SECURE If true, use TLS when connecting to host. If false, TLS will be used if STARTTLS is supported @@ -140,16 +146,26 @@ backendEnvironmentVariables: ## @param backendEnvironmentVariables.SMTP_USERNAME **Required** Credential to connect to host (e.g. team@infisical.com) ## @param backendEnvironmentVariables.SMTP_PASSWORD **Required** Credential to connect to host ## - SMTP_HOST: MUST_REPLACE + SMTP_HOST: "" SMTP_PORT: 587 SMTP_SECURE: false SMTP_FROM_NAME: Infisical - SMTP_FROM_ADDRESS: MUST_REPLACE - SMTP_USERNAME: MUST_REPLACE - SMTP_PASSWORD: MUST_REPLACE + SMTP_FROM_ADDRESS: "" + SMTP_USERNAME: "" + SMTP_PASSWORD: "" ## @param backendEnvironmentVariables.SITE_URL Absolute URL including the protocol (e.g. https://app.infisical.com) ## SITE_URL: infisical.local + ## @param backendEnvironmentVariables.INVITE_ONLY_SIGNUP To disable account creation from the login page (invites only) + ## + INVITE_ONLY_SIGNUP: false + ## @param backendEnvironmentVariables.MONGO_URL MongoDB connection string (external or internal)
Leave it empty for auto-generated connection string + ## By default the backend will automatically be connected to a Mongo instance within the cluster + ## However, it is recommended to add a managed document DB connection string for production-use (DBaaS) + ## Learn about connection string type here https://www.mongodb.com/docs/manual/reference/connection-string/ + ## e.g. "mongodb://:@:/" + ## + MONGO_URL: "" ## @section MongoDB(®) parameters ## Documentation : https://github.com/bitnami/charts/blob/main/bitnami/mongodb/values.yaml @@ -187,6 +203,38 @@ mongodb: repository: bitnami/mongodb pullPolicy: IfNotPresent tag: "6.0.4-debian-11-r0" + ## Bitnami MongoDB(®) pods' liveness probe + ## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes + ## @param mongodb.livenessProbe.enabled Enable livenessProbe + ## @param mongodb.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe + ## @param mongodb.livenessProbe.periodSeconds Period seconds for livenessProbe + ## @param mongodb.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe + ## @param mongodb.livenessProbe.failureThreshold Failure threshold for livenessProbe + ## @param mongodb.livenessProbe.successThreshold Success threshold for livenessProbe + ## + livenessProbe: + enabled: true + initialDelaySeconds: 30 + periodSeconds: 20 + timeoutSeconds: 10 + failureThreshold: 6 + successThreshold: 1 + ## Bitnami MongoDB(®) pods' readiness probe. Evaluated as a template. + ## ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes + ## @param mongodb.readinessProbe.enabled Enable readinessProbe + ## @param mongodb.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe + ## @param mongodb.readinessProbe.periodSeconds Period seconds for readinessProbe + ## @param mongodb.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe + ## @param mongodb.readinessProbe.failureThreshold Failure threshold for readinessProbe + ## @param mongodb.readinessProbe.successThreshold Success threshold for readinessProbe + ## + readinessProbe: + enabled: true + initialDelaySeconds: 5 + periodSeconds: 10 + timeoutSeconds: 10 + failureThreshold: 6 + successThreshold: 1 ## @param mongodb.service.annotations Service annotations ## service: @@ -209,8 +257,12 @@ mongodb: ## databases: - "infisical" - rootPassword: root + ## @param mongodb.auth.rootUser Database root user name + ## rootUser: root + ## @param mongodb.auth.rootPassword Database root user password + ## + rootPassword: root ## MongoDB persistence configuration ## persistence: @@ -230,7 +282,7 @@ mongodb: ## size: 8Gi -## @param mongodbConnection.externalMongoDBConnectionString External MongoDB connection string +## @param mongodbConnection.externalMongoDBConnectionString Deprecated :warning: External MongoDB connection string
Use backendEnvironmentVariables.MONGO_URL instead ## By default the backend will be connected to a Mongo instance within the cluster ## However, it is recommended to add a managed document DB connection string for production-use (DBaaS) ## Learn about connection string type here https://www.mongodb.com/docs/manual/reference/connection-string/ @@ -246,15 +298,19 @@ ingress: ## @param ingress.enabled Enable ingress ## enabled: true + ## @param ingress.ingressClassName Ingress class name + ## + ingressClassName: nginx + ## @param ingress.annotations Ingress annotations + ## annotations: - ## @skip ingress.annotations.kubernetes.io/ingress.class - ## - kubernetes.io/ingress.class: "nginx" + {} + # kubernetes.io/ingress.class: "nginx" # cert-manager.io/issuer: letsencrypt-nginx - ## @param ingress.hostName Ingress hostname (your custom domain name) + ## @param ingress.hostName Ingress hostname (your custom domain name, e.g. `infisical.example.org`) ## Replace with your own domain ## - hostName: infisical.local + hostName: "" ## @skip ingress.frontend ## frontend: