From 3ae4e9e6cf42450af7b4011aad81964049f12616 Mon Sep 17 00:00:00 2001 From: Elio Bischof Date: Tue, 5 Mar 2024 08:37:12 +0100 Subject: [PATCH] docs: describe DefaultInstance vs FirstInstance (#7487) * docs: describe DefaultInstance vs FirstInstance * link to docs * add better searchable tip to the docs * add better searchable tip to the docs * add link --- cmd/defaults.yaml | 5 +++++ cmd/setup/steps.yaml | 1 + docs/docs/self-hosting/manage/configure/configure.mdx | 9 +++++++++ 3 files changed, 15 insertions(+) diff --git a/cmd/defaults.yaml b/cmd/defaults.yaml index 42b5fa4024..781f13d501 100644 --- a/cmd/defaults.yaml +++ b/cmd/defaults.yaml @@ -543,6 +543,11 @@ Eventstore: # Maximum amount of push retries in case of primary key violation on the sequence MaxRetries: 5 #ZITADEL_EVENTSTORE_MAXRETRIES +# The DefaultInstance section defines the default values for each new virtual instance that is created. +# Check out https://zitadel.com/docs/concepts/structure/instance#multiple-virtual-instances for more information about virtual instances. +# For the initial setup, the default values are used to create the first instance. +# However, you might want to have your first instance created by the setup job to have a different configuration. +# To overwrite the default values for the initial setup, configure the FirstInstance yaml section and pass it using the --steps flag. DefaultInstance: InstanceName: ZITADEL # ZITADEL_DEFAULTINSTANCE_INSTANCENAME DefaultLanguage: en # ZITADEL_DEFAULTINSTANCE_DEFAULTLANGUAGE diff --git a/cmd/setup/steps.yaml b/cmd/setup/steps.yaml index c585c535b2..5e7805f24d 100644 --- a/cmd/setup/steps.yaml +++ b/cmd/setup/steps.yaml @@ -1,3 +1,4 @@ +# By using the FirstInstance section, you can overwrite the DefaultInstance configuration for the first instance created by zitadel setup. FirstInstance: # The machine key from the section FirstInstance.Org.Machine.MachineKey is written to the MachineKeyPath. MachineKeyPath: # ZITADEL_FIRSTINSTANCE_MACHINEKEYPATH diff --git a/docs/docs/self-hosting/manage/configure/configure.mdx b/docs/docs/self-hosting/manage/configure/configure.mdx index 0288014ca5..aaf221dfda 100644 --- a/docs/docs/self-hosting/manage/configure/configure.mdx +++ b/docs/docs/self-hosting/manage/configure/configure.mdx @@ -21,6 +21,11 @@ This guide assumes you are familiar with [running ZITADEL using the least amount You can configure the runtime using the `--config` flag of the `zitadel` binary. Also, you can use the environment variables listed in the defaults.yaml. +:::tip +For overwriting the default configuration for the first instance created by zitadel setup, use the FirstInstance section in the [database initialization file](#database-initialization-file). +::: + +
defaults.yaml {DefaultsYamlSource} @@ -32,6 +37,10 @@ ZITADEL uses a [different configuration file](https://github.com/zitadel/zitadel Use the `--steps` flag of the `zitadel` binary to provide this configuration file. Also, you can use the environment variables listed in the steps.yaml. +:::tip +By using the FirstInstance section, you can overwrite the [DefaultInstance configuration](#runtime-configuration-file) for the first instance created by zitadel setup. +::: +
steps.yaml {StepsYamlSource}