docs: update db config in example configs (#4077)

* docs: update db config in example configs * fix version * more cockroach
2025-01-05 14:37:45 +00:00 · 2022-07-29 17:45:38 +02:00 · 2022-07-29 17:45:38 +02:00 · 459779ae3a
commit 459779ae3a
parent 25baeb05ff
10 changed files with 61 additions and 59 deletions
--- a/deploy/knative/zitadel-knative-service.yaml
+++ b/deploy/knative/zitadel-knative-service.yaml
@ -7,7 +7,7 @@ spec:
  template:
    metadata:
      annotations:
-        client.knative.dev/user-image: ghcr.io/zitadel/zitadel:v2.0.0-v2-alpha.43-amd64
+        client.knative.dev/user-image: ghcr.io/zitadel/zitadel:v2.0.0-amd64
      creationTimestamp: null
    spec:
      containerConcurrency: 0
@ -18,7 +18,7 @@ spec:
        - --masterkey
        - MasterkeyNeedsToHave32Characters
        env:
-        - name: ZITADEL_DATABASE_HOST
+        - name: ZITADEL_DATABASE_COCKROACH_HOST
          value: cockroachdb
        - name: ZITADEL_EXTERNALSECURE
          value: "false"
@ -28,9 +28,7 @@ spec:
          value: 80
        - name: ZITADEL_EXTERNALDOMAIN
          value: zitadel.default.127.0.0.1.sslip.io
-        - name: ZITADEL_S3DEFAULTINSTANCE_CUSTOMDOMAIN
-          value: zitadel.default.127.0.0.1.sslip.io
-        image: ghcr.io/zitadel/zitadel:v2.0.0-v2-alpha.43-amd64
+        image: ghcr.io/zitadel/zitadel:v2.0.0-amd64
        name: user-container
        ports:
        - containerPort: 8080
--- a/docs/docs/guides/deploy/docker-compose.yaml
+++ b/docs/docs/guides/deploy/docker-compose.yaml
@ -8,7 +8,7 @@ services:
    image: 'ghcr.io/zitadel/zitadel:v2.0.0-amd64'
    command: 'start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled'
    environment:
-      - 'ZITADEL_DATABASE_HOST=db'
+      - 'ZITADEL_DATABASE_COCKROACH_HOST=db'
      - 'ZITADEL_EXTERNALSECURE=false'
    depends_on:
      db:
--- a/docs/docs/guides/deploy/knative.mdx
+++ b/docs/docs/guides/deploy/knative.mdx
@ -26,7 +26,7 @@ kubectl apply -f https://raw.githubusercontent.com/zitadel/zitadel/main/deploy/k
 kn service create zitadel \
 --image ghcr.io/zitadel/zitadel:v2.0.0-amd64 \
 --port 8080 \
--env ZITADEL_DATABASE_HOST=cockroachdb \
+--env ZITADEL_DATABASE_COCKROACH_HOST=cockroachdb \
 --env ZITADEL_EXTERNALSECURE=false \
 --env ZITADEL_EXTERNALPORT=80 \
 --env ZITADEL_TLS_ENABLED=false \
--- a/docs/docs/guides/deploy/kubernetes.mdx
+++ b/docs/docs/guides/deploy/kubernetes.mdx
@ -25,7 +25,7 @@ helm install --namespace zitadel --create-namespace my-zitadel zitadel/zitadel \
  --set zitadel.masterkey="MasterkeyNeedsToHave32Characters" \
  --set zitadel.configmapConfig.ExternalDomain="localhost" \
  --set zitadel.configmapConfig.ExternalSecure=false \
-  --set zitadel.secretConfig.Database.User.Password="a-zitadel-db-user-password"
+  --set zitadel.secretConfig.Database.cockroach.User.Password="a-zitadel-db-user-password" \
  --set replicaCount=1 \
  --set cockroachdb.single-node=true \
  --set cockroachdb.statefulset.replicas=1
--- a/docs/docs/guides/deploy/loadbalancing-example/example-zitadel-config.yaml
+++ b/docs/docs/guides/deploy/loadbalancing-example/example-zitadel-config.yaml
@ -9,16 +9,17 @@ ExternalPort: 443

 # If not using the docker compose example, adjust these values for connecting ZITADEL to your CockroachDB
 Database:
-  Host: 'my-cockroach-db'
-  User:
-    SSL:
-      Mode: 'verify-full'
-      RootCert: "/crdb-certs/ca.crt"
-      Cert: "/crdb-certs/client.zitadel_user.crt"
-      Key: "/crdb-certs/client.zitadel_user.key"
-AdminUser:
-  SSL:
-    Mode: 'verify-full'
-    RootCert: "/crdb-certs/ca.crt"
-    Cert: "/crdb-certs/client.root.crt"
-    Key: "/crdb-certs/client.root.key"
+  cockroach:
+    Host: 'my-cockroach-db'
+    User:
+      SSL:
+        Mode: 'verify-full'
+        RootCert: "/crdb-certs/ca.crt"
+        Cert: "/crdb-certs/client.zitadel_user.crt"
+        Key: "/crdb-certs/client.zitadel_user.key"
+    Admin:
+      SSL:
+        Mode: 'verify-full'
+        RootCert: "/crdb-certs/ca.crt"
+        Cert: "/crdb-certs/client.root.crt"
+        Key: "/crdb-certs/client.root.key"
--- a/docs/docs/guides/deploy/loadbalancing-example/example-zitadel-secrets.yaml
+++ b/docs/docs/guides/deploy/loadbalancing-example/example-zitadel-secrets.yaml
@ -2,10 +2,11 @@

 # If not using the docker compose example, adjust these values for connecting ZITADEL to your CockroachDB
 Database:
-  User:
-    # If the user doesn't exist already, it is created
-    Username: 'zitadel_user'
-    Password: 'Secret_DB_User_Password'
-AdminUser:
-  Username: 'root'
-  Password: ''
+  cockroach:
+    User:
+      # If the user doesn't exist already, it is created
+      Username: 'zitadel_user'
+      Password: 'Secret_DB_User_Password'
+    Admin:
+      Username: 'root'
+      Password: ''
--- a/docs/docs/guides/manage/self-hosted/configure/_linuxunix.mdx
+++ b/docs/docs/guides/manage/self-hosted/configure/_linuxunix.mdx
@ -44,9 +44,9 @@ zitadel start-from-init \

 ```bash
 # Set runtime environment variables
-export ZITADEL_DATABASE_HOST="my.database"
-export ZITADEL_DATABASE_USER_USERNAME="my_zitadel_db_user"
-export ZITADEL_DATABASE_USER_PASSWORD="Secret_DB_User_Password"
+export ZITADEL_DATABASE_COCKROACH_HOST="my.database"
+export ZITADEL_DATABASE_COCKROACH_USER_USERNAME="my_zitadel_db_user"
+export ZITADEL_DATABASE_COCKROACH_USER_PASSWORD="Secret_DB_User_Password"
 export ZITADEL_FIRSTINSTANCE_ORG_HUMAN_USERNAME="root"
 export ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORD="RootPassword1!"

--- a/docs/docs/guides/manage/self-hosted/configure/example-zitadel-config.yaml
+++ b/docs/docs/guides/manage/self-hosted/configure/example-zitadel-config.yaml
@ -7,16 +7,17 @@ ExternalSecure: false

 # If not using the docker compose example, adjust these values for connecting ZITADEL to your CockroachDB
 Database:
-  Host: 'my-cockroach-db'
-  User:
-    SSL:
-      Mode: 'verify-full'
-      RootCert: "/crdb-certs/ca.crt"
-      Cert: "/crdb-certs/client.zitadel_user.crt"
-      Key: "/crdb-certs/client.zitadel_user.key"
-AdminUser:
-  SSL:
-    Mode: 'verify-full'
-    RootCert: "/crdb-certs/ca.crt"
-    Cert: "/crdb-certs/client.root.crt"
-    Key: "/crdb-certs/client.root.key"
+  cockroach:
+    Host: 'my-cockroach-db'
+    User:
+      SSL:
+        Mode: 'verify-full'
+        RootCert: "/crdb-certs/ca.crt"
+        Cert: "/crdb-certs/client.zitadel_user.crt"
+        Key: "/crdb-certs/client.zitadel_user.key"
+    Admin:
+      SSL:
+        Mode: 'verify-full'
+        RootCert: "/crdb-certs/ca.crt"
+        Cert: "/crdb-certs/client.root.crt"
+        Key: "/crdb-certs/client.root.key"
--- a/docs/docs/guides/manage/self-hosted/configure/example-zitadel-secrets.yaml
+++ b/docs/docs/guides/manage/self-hosted/configure/example-zitadel-secrets.yaml
@ -2,10 +2,11 @@

 # If not using the docker compose example, adjust these values for connecting ZITADEL to your CockroachDB
 Database:
-  User:
-    # If the user doesn't exist already, it is created
-    Username: 'zitadel_user'
-    Password: 'Secret_DB_User_Password'
-AdminUser:
-  Username: 'root'
-  Password: ''
+  cockroach:
+    User:
+      # If the user doesn't exist already, it is created
+      Username: 'zitadel_user'
+      Password: 'Secret_DB_User_Password'
+    Admin:
+      Username: 'root'
+      Password: ''
--- a/docs/docs/guides/manage/self-hosted/configure/example-zitadel-values-secrets.yaml
+++ b/docs/docs/guides/manage/self-hosted/configure/example-zitadel-values-secrets.yaml
@ -6,11 +6,11 @@ zitadel:
  secretConfig:

    Database:
-      User:
-        # If the user doesn't exist already, it is created
-        Username: 'zitadel_user'
-        Password: 'Secret_DB_User_Password'
-
-    AdminUser:
-      Username: 'root'
-      Password: ''
+      cockroach:
+        User:
+          # If the user doesn't exist already, it is created
+          Username: 'zitadel_user'
+          Password: 'Secret_DB_User_Password'
+        Admin:
+          Username: 'root'
+          Password: ''