diff --git a/docs/installation/kubernetes.md b/docs/installation/kubernetes.md index 63c0d95b9..4343cde61 100644 --- a/docs/installation/kubernetes.md +++ b/docs/installation/kubernetes.md @@ -13,8 +13,6 @@ image: name_static: beryju/passbook-static tag: 0.12.5-stable -nameOverride: "" - serverReplicas: 1 workerReplicas: 1 @@ -45,7 +43,6 @@ ingress: annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" - path: / hosts: - passbook.k8s.local tls: [] diff --git a/helm/Chart.yaml b/helm/Chart.yaml index 1180d6392..bf5d37557 100644 --- a/helm/Chart.yaml +++ b/helm/Chart.yaml @@ -1,9 +1,11 @@ apiVersion: v2 -appVersion: "0.12.5-stable" -description: A Helm chart for passbook. +description: passbook is an open-source Identity Provider focused on flexibility and versatility. You can use passbook in an existing environment to add support for new protocols. passbook is also a great solution for implementing signup/recovery/etc in your application, so you don't have to deal with it. name: passbook +home: https://passbook.beryju.org +sources: + - https://github.com/BeryJu/passbook version: "0.12.5-stable" -icon: https://github.com/BeryJu/passbook/blob/master/docs/images/logo.svg +icon: https://raw.githubusercontent.com/BeryJu/passbook/master/docs/images/logo.svg dependencies: - name: postgresql version: 9.4.1 diff --git a/helm/README.md b/helm/README.md new file mode 100644 index 000000000..cd9c148e2 --- /dev/null +++ b/helm/README.md @@ -0,0 +1,28 @@ +# passbook Helm Chart + +| Name | Default | Description | +|-----------------------------------|-------------------------|-------------| +| image.name | beryju/passbook | Image used to run the passbook server and worker | +| image.name_static | beryju/passbook-static | Image used to run the passbook static server (CSS and JS Files) | +| image.tag | 0.12.5-stable | Image tag | +| serverReplicas | 1 | Replicas for the Server deployment | +| workerReplicas | 1 | Replicas for the Worker deployment | +| kubernetesIntegration | true | Enable/disable the Kubernetes integration for passbook. This will create a service account for passbook to create and update outposts in passbook | +| config.secretKey | | Secret key used to sign session cookies, generate with `pwgen 50 1` for example. | +| config.errorReporting.enabled | false | Enable/disable error reporting | +| config.errorReporting.environment | customer | Environment sent with the error reporting | +| config.errorReporting.sendPii | false | Whether to send Personally-identifiable data with the error reporting | +| config.logLevel | warning | Log level of passbook | +| backup.accessKey | | Optionally enable S3 Backup, Access Key | +| backup.secretKey | | Optionally enable S3 Backup, Secret Key | +| backup.bucket | | Optionally enable S3 Backup, Bucket | +| backup.region | | Optionally enable S3 Backup, Region | +| backup.host | | Optionally enable S3 Backup, to custom Endpoint like minio | +| ingress.annotations | {} | Annotations for the ingress object | +| ingress.hosts | [passbook.k8s.local] | Hosts which the ingress will match | +| ingress.tls | [] | TLS Configuration, same as Ingress objects | +| install.postgresql | true | Enables/disables the packaged PostgreSQL Chart +| install.redis | true | Enables/disables the packaged Redis Chart +| postgresql.postgresqlPassword | | Password used for PostgreSQL, generated automatically. + +For more info, see https://passbook.beryju.org/ and https://passbook.beryju.org/installation/kubernetes/ diff --git a/helm/templates/_helpers.tpl b/helm/templates/_helpers.tpl index e07a252d0..51fc9e667 100644 --- a/helm/templates/_helpers.tpl +++ b/helm/templates/_helpers.tpl @@ -3,7 +3,7 @@ Expand the name of the chart. */}} {{- define "passbook.name" -}} -{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- default .Chart.Name | trunc 63 | trimSuffix "-" -}} {{- end -}} {{/* @@ -12,17 +12,13 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this If release name contains chart name it will be used as a full name. */}} {{- define "passbook.fullname" -}} -{{- if .Values.fullnameOverride -}} -{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} -{{- else -}} -{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- $name := default .Chart.Name -}} {{- if contains $name .Release.Name -}} {{- .Release.Name | trunc 63 | trimSuffix "-" -}} {{- else -}} {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} {{- end -}} {{- end -}} -{{- end -}} {{/* Create chart name and version as used by the chart label. diff --git a/helm/values.yaml b/helm/values.yaml index b01c592a8..659b7ea8a 100644 --- a/helm/values.yaml +++ b/helm/values.yaml @@ -6,8 +6,6 @@ image: name_static: beryju/passbook-static tag: 0.12.5-stable -nameOverride: "" - serverReplicas: 1 workerReplicas: 1 @@ -38,7 +36,6 @@ ingress: annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" - path: / hosts: - passbook.k8s.local tls: [] @@ -57,12 +54,3 @@ install: # These values influence the bundled postgresql and redis charts, but are also used by passbook to connect postgresql: postgresqlDatabase: passbook - -redis: - cluster: - enabled: false - master: - persistence: - enabled: false - # https://stackoverflow.com/a/59189742 - disableCommands: []