diff --git a/charts/logto/.helmignore b/charts/logto/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/logto/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/charts/logto/Chart.lock b/charts/logto/Chart.lock new file mode 100644 index 0000000..2eaf755 --- /dev/null +++ b/charts/logto/Chart.lock @@ -0,0 +1,6 @@ +dependencies: +- name: postgresql + repository: https://charts.bitnami.com/bitnami + version: 15.2.8 +digest: sha256:a6755fbd5d66ee96ea2437d8be5577f6742f274ba720b9cc471fcd0291ef80eb +generated: "2024-05-02T18:39:06.256574315+08:00" diff --git a/charts/logto/Chart.yaml b/charts/logto/Chart.yaml new file mode 100644 index 0000000..c5804df --- /dev/null +++ b/charts/logto/Chart.yaml @@ -0,0 +1,30 @@ +apiVersion: v2 +name: logto +description: Logto, the better identity infrastructure for developers + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +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.0 + +# 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 +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "1.15.0" + +dependencies: + - name: postgresql + version: ~15.2.8 + repository: https://charts.bitnami.com/bitnami + condition: postgresql.enabled \ No newline at end of file diff --git a/charts/logto/charts/postgresql-15.2.8.tgz b/charts/logto/charts/postgresql-15.2.8.tgz new file mode 100644 index 0000000..2861457 Binary files /dev/null and b/charts/logto/charts/postgresql-15.2.8.tgz differ diff --git a/charts/logto/templates/NOTES.txt b/charts/logto/templates/NOTES.txt new file mode 100644 index 0000000..36b5181 --- /dev/null +++ b/charts/logto/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.services.core.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "logto.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.services.core.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "logto.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "logto.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.services.core.port }} +{{- else if contains "ClusterIP" .Values.services.core.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "logto.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/charts/logto/templates/_helpers.tpl b/charts/logto/templates/_helpers.tpl new file mode 100644 index 0000000..90d14fe --- /dev/null +++ b/charts/logto/templates/_helpers.tpl @@ -0,0 +1,75 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "logto.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "logto.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- 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. +*/}} +{{- define "logto.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "logto.labels" -}} +helm.sh/chart: {{ include "logto.chart" . }} +{{ include "logto.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "logto.selectorLabels" -}} +app.kubernetes.io/name: {{ include "logto.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "logto.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "logto.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{/* +Create the name of secret +*/}} +{{- define "logto.secretName" -}} +{{- include "logto.fullname" . }} +{{- end }} + +{{/* +*/}} +{{- define "logto.configMapName" -}} +{{- include "logto.fullname" . }} +{{- end }} diff --git a/charts/logto/templates/configmap.yaml b/charts/logto/templates/configmap.yaml new file mode 100644 index 0000000..5d01fca --- /dev/null +++ b/charts/logto/templates/configmap.yaml @@ -0,0 +1,13 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "logto.configMapName" . }} + labels: + {{- include "logto.labels" . | nindent 4 }} +data: + # ENDPOINT: {{ .Values.coreEndpoint | quote }} + # ADMIN_ENDPOINT: {{ .Values.adminEndpoint | quote }} + {{- if .Values.emmbedded_tls.enabled }} + HTTPS_CERT_PATH: "/etc/logto/tls/{{ .Values.tls.certName }}" + HTTPS_KEY_PATH: "/etc/logto/tls/{{ .Values.tls.keyName }}" + {{- end }} \ No newline at end of file diff --git a/charts/logto/templates/deployment.yaml b/charts/logto/templates/deployment.yaml new file mode 100644 index 0000000..796a856 --- /dev/null +++ b/charts/logto/templates/deployment.yaml @@ -0,0 +1,122 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "logto.fullname" . }} + labels: + {{- include "logto.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "logto.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "logto.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "logto.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + initContainers: + - name: {{ .Chart.Name }}-init + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + command: + - /bin/sh + args: + - '-c' + - 'npm run cli connector add -- --official' + env: + {{- if .Values.postgresql.enabled }} + - name: POSTGRES_PASSWORD + valueFrom: + secretKeyRef: + name: {{ include "postgresql.v1.secretName" .Subcharts.postgresql }} + key: password + {{- end }} + envFrom: + - secretRef: + name: {{ include "logto.secretName" . }} + - configMapRef: + name: {{ include "logto.configMapName" . }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- if .Values.emmbedded_tls.enabled }} + - name: emmbedded_tls + mountPath: /etc/logto/tls + readOnly: true + {{- end }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + {{- range .Values.services }} + - name: {{ .name }} + containerPort: {{ .port }} + {{- end }} + env: + {{- if .Values.postgresql.enabled }} + - name: POSTGRES_PASSWORD + valueFrom: + secretKeyRef: + name: {{ include "postgresql.v1.secretName" .Subcharts.postgresql }} + key: password + {{- end }} + envFrom: + - secretRef: + name: {{ include "logto.secretName" . }} + - configMapRef: + name: {{ include "logto.configMapName" . }} + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- if .Values.emmbedded_tls.enabled }} + - name: emmbedded_tls + mountPath: /etc/logto/tls + readOnly: true + {{- end }} + {{- with .Values.volumes }} + volumes: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/charts/logto/templates/hpa.yaml b/charts/logto/templates/hpa.yaml new file mode 100644 index 0000000..ab95d14 --- /dev/null +++ b/charts/logto/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "logto.fullname" . }} + labels: + {{- include "logto.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "logto.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/charts/logto/templates/ingress.yaml b/charts/logto/templates/ingress.yaml new file mode 100644 index 0000000..f8509e2 --- /dev/null +++ b/charts/logto/templates/ingress.yaml @@ -0,0 +1,62 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "logto.fullname" . -}} +{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }} + {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }} + {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}} + {{- end }} +{{- end }} +{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1 +{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: extensions/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "logto.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + {{- $svcName := .svcName -}} + {{- $svcPort := index .Values.services (index (index .Values.services 0).name .svcName).port | default 80 -}} + - path: {{ .path }} + {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }} + pathType: {{ .pathType }} + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullName }}-{{ $svcName }} + port: + number: {{ $svcPort }} + {{- else }} + serviceName: {{ $fullName }}-{{ $svcName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} +{{- end }} diff --git a/charts/logto/templates/pvc.yaml b/charts/logto/templates/pvc.yaml new file mode 100644 index 0000000..5ff0c81 --- /dev/null +++ b/charts/logto/templates/pvc.yaml @@ -0,0 +1,21 @@ +{{- if .Values.persistence.enabled }} +{{- range .Values.persistence.claims }} +{{- if .persistentVolumeClaim }} +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: {{ .name }} + labels: + {{- include "logto.labels" $ | nindent 4 }} +spec: + accessModes: + {{- toYaml .accessModes | nindent 4 }} + resources: + {{- toYaml .resources | nindent 4 }} + storageClassName: {{ $.Values.persistence.storageClass }} + selector: + {{- include "logto.selectorLabels" $ | nindent 4 }} +{{- end }} +{{- end }} +--- +{{- end }} \ No newline at end of file diff --git a/charts/logto/templates/secret.yaml b/charts/logto/templates/secret.yaml new file mode 100644 index 0000000..a832f3f --- /dev/null +++ b/charts/logto/templates/secret.yaml @@ -0,0 +1,17 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "logto.secretName" . }} + labels: + {{- include "logto.labels" . | nindent 4 }} +type: Opaque +data: + TRUST_PROXY_HEADER: {{ .Values.trustProxyHeader | b64enc | quote }} + {{- if .Values.postgresql.enabled }} + DB_URL: {{ "postgresql://$(POSTGRES_USERNAME):$(POSTGRES_PASSWORD)@$(POSTGRES_HOST):$(POSTGRES_PORT)/$(POSTGRES_DATABASE)" | b64enc | quote }} + POSTGRES_HOST: {{ printf "%s.%s.svc.cluster.local" (include "postgresql.v1.primary.fullname" .Subcharts.postgresql) .Release.Namespace | b64enc | quote }} + POSTGRES_PORT: {{ include "postgresql.v1.service.port" .Subcharts.postgresql | b64enc | quote }} + POSTGRES_USERNAME: {{ include "postgresql.v1.username" .Subcharts.postgresql | b64enc | quote }} + {{- else }} + DB_URL: {{ .Values.dbUrl | b64enc | quote }} + {{- end }} \ No newline at end of file diff --git a/charts/logto/templates/service.yaml b/charts/logto/templates/service.yaml new file mode 100644 index 0000000..749d211 --- /dev/null +++ b/charts/logto/templates/service.yaml @@ -0,0 +1,18 @@ +{{- range .Values.services }} +apiVersion: v1 +kind: Service +metadata: + name: {{ include "logto.fullname" $ }}-{{ .name }} + labels: + {{- include "logto.labels" $ | nindent 4 }} +spec: + type: {{ .type }} + ports: + - port: {{ .port }} + targetPort: {{ .name }} + protocol: TCP + name: {{ .name }} + selector: + {{- include "logto.selectorLabels" $ | nindent 4 }} +--- +{{- end }} \ No newline at end of file diff --git a/charts/logto/templates/serviceaccount.yaml b/charts/logto/templates/serviceaccount.yaml new file mode 100644 index 0000000..a6df9cf --- /dev/null +++ b/charts/logto/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "logto.serviceAccountName" . }} + labels: + {{- include "logto.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/logto/values.yaml b/charts/logto/values.yaml new file mode 100644 index 0000000..99826aa --- /dev/null +++ b/charts/logto/values.yaml @@ -0,0 +1,180 @@ +# Default values for logto. + +replicaCount: 1 + +image: + registry: ghcr.io + repository: logto-io/logto + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +services: + admin: + type: LoadBalancer + name: admin + port: 3002 + core: + type: LoadBalancer + name: core + port: 3001 + +emmbedded_tls: + enabled: false + secretName: logto-tls + certName: tls.crt + keyName: tls.key + +# Refer to https://docs.logto.io/docs/recipes/deployment/ +coreEndpoint: "" +adminEndpoint: "" + +# Database uri for logto, if postgresql is enabled, this will be ignored +dbUrl: "" +trustProxyHeader: "1" + +# -- Configuration values for the postgresql dependency. +# ref: https://github.com/bitnami/charts/tree/main/bitnami/postgresql +# @default -- see `values.yaml` +postgresql: + ## + ## Use the PostgreSQL chart dependency. + ## Set to false if bringing your own PostgreSQL. + enabled: true + + ## Authentication parameters + auth: + ## The name of an existing secret that contains the postgres password. + existingSecret: + ## PostgreSQL name for a custom user to create + username: logto + ## PostgreSQL password for the custom user to create. Ignored if `auth.existingSecret` with key `password` is provided + password: + ## PostgreSQL name for a custom database to create + database: logto + + ## PostgreSQL Primary parameters + primary: + ## + ## Persistent Volume Storage configuration. + ## ref: https://kubernetes.io/docs/user-guide/persistent-volumes + persistence: + ## + ## Enable PostgreSQL persistence using Persistent Volume Claims. + enabled: true + ## + ## Persistent class + # storageClass: classname + ## + ## Access modes: + accessModes: + - ReadWriteOnce + ## PostgreSQL port + service: + ports: + postgresql: 5432 + +ingress: + enabled: false + className: "" + annotations: {} + hosts: + - host: admin.logto.local + paths: + - path: / + pathType: Prefix + svcName: admin + - host: logto.local + paths: + - path: / + pathType: Prefix + svcName: core + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +persistence: + # Whether to automatically create the PersistentVolumeClaims exists in the volumes + enabled: true + storageClass: "" + claims: + - name: connectors-claim + accessModes: [ "ReadWriteOnce" ] + resources: + requests: + storage: 15Mi + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +livenessProbe: + httpGet: + path: /api/status + port: core +readinessProbe: + httpGet: + path: /api/status + port: core + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +# Additional volumes on the output Deployment definition. +volumes: +- name: connectors + persistentVolumeClaim: + claimName: connectors-claim + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: +- name: connectors + mountPath: /etc/logto/packages/core/connectors + +nodeSelector: {} + +tolerations: [] + +affinity: {}