From 1082d7f869b1a08666ea018125e470c17f6381d5 Mon Sep 17 00:00:00 2001 From: Maidul Islam Date: Sat, 18 Feb 2023 23:28:52 -0500 Subject: [PATCH] update helm docs for self install --- docs/self-hosting/deployments/kubernetes.mdx | 122 ++++++++----------- 1 file changed, 48 insertions(+), 74 deletions(-) diff --git a/docs/self-hosting/deployments/kubernetes.mdx b/docs/self-hosting/deployments/kubernetes.mdx index 28bdc2416..cbba7a946 100644 --- a/docs/self-hosting/deployments/kubernetes.mdx +++ b/docs/self-hosting/deployments/kubernetes.mdx @@ -24,114 +24,88 @@ Before you can deploy the Helm chart, you must fill out the required environment 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 -##### -# INFISICAL K8 DEFAULT VALUES FILE -# PLEASE REPLACE VALUES/EDIT AS REQUIRED -##### - -nameOverride: "" - frontend: + enabled: true name: frontend podAnnotations: {} deploymentAnnotations: {} replicaCount: 2 image: repository: infisical/frontend - pullPolicy: Always - tag: "latest" # It it highly recommended to select a specific tag for prod deployment so it is easy to rollback: https://hub.docker.com/r/infisical/frontend/tags - # kubeSecretRef: some-kube-secret-name + tag: "latest" + pullPolicy: IfNotPresent + kubeSecretRef: "" service: - # type of the frontend service - type: ClusterIP - # define the nodePort if service type is NodePort - # nodePort: annotations: {} + type: ClusterIP + nodePort: "" + +frontendEnvironmentVariables: + SITE_URL: infisical.local backend: + enabled: true name: backend podAnnotations: {} deploymentAnnotations: {} replicaCount: 2 image: repository: infisical/backend - pullPolicy: Always - tag: "latest" # It it highly recommended to select a specific tag for prod deployment so it is easy to rollback: https://hub.docker.com/r/infisical/backend/tags - # kubeSecretRef: some-kube-secret-name - service: - annotations: {} - -mongodb: - name: mongodb - podAnnotations: {} - image: - repository: mongo + tag: "latest" pullPolicy: IfNotPresent - tag: "latest" + kubeSecretRef: "" service: annotations: {} + type: ClusterIP + nodePort: "" -# By default the backend will be connected to a Mongo instance in the cluster. -# However, it is recommended to add a managed document DB connection string because the DB instance in the cluster does not have persistence yet ( data will be deleted on next deploy). -# Learn about connection string type here https://www.mongodb.com/docs/manual/reference/connection-string/ -mongodbConnection: {} - # externalMongoDBConnectionString: <> +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" - hostName: example.com # replace with your domain - frontend: + # 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 - -## Complete Ingress example -# ingress: -# enabled: true -# annotations: -# kubernetes.io/ingress.class: "nginx" -# cert-manager.io/issuer: letsencrypt-nginx -# hostName: k8.infisical.com -# frontend: -# path: / -# pathType: Prefix -# backend: -# path: /api -# pathType: Prefix -# tls: -# - secretName: letsencrypt-nginx -# hosts: -# - k8.infisical.com - -### -### YOU MUST FILL IN ALL SECRETS BELOW -### -backendEnvironmentVariables: - # Required keys for platform encryption/decryption ops. Replace with nacl sk keys - ENCRYPTION_KEY: MUST_REPLACE - - # JWT - # Required secrets to sign JWT tokens - JWT_SIGNUP_SECRET: MUST_REPLACE - JWT_REFRESH_SECRET: MUST_REPLACE - JWT_AUTH_SECRET: MUST_REPLACE - - # Mail/SMTP - # Required to send emails - SMTP_HOST: MUST_REPLACE - SMTP_NAME: MUST_REPLACE - SMTP_USERNAME: MUST_REPLACE - SMTP_PASSWORD: MUST_REPLACE - -frontendEnvironmentVariables: {} - +mailhog: + enabled: false ```