TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2024-12-15 12:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
efcb41398d
zitadel/cmd/setup/steps.yaml

57 lines
3.2 KiB
YAML
Raw Normal View History

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
2024-03-05 07:37:12 +00:00
# By using the FirstInstance section, you can overwrite the DefaultInstance configuration for the first instance created by zitadel setup.
fix: clarify instances in steps and config (#4003) * fix: clarify instances in steps and config * docs: update setup step Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com> Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2022-07-27 08:22:20 +00:00
FirstInstance:
feat(cmd): mirror (#7004) # Which Problems Are Solved Adds the possibility to mirror an existing database to a new one. For that a new command was added `zitadel mirror`. Including it's subcommands for a more fine grained mirror of the data. Sub commands: * `zitadel mirror eventstore`: copies only events and their unique constraints * `zitadel mirror system`: mirrors the data of the `system`-schema * `zitadel mirror projections`: runs all projections * `zitadel mirror auth`: copies auth requests * `zitadel mirror verify`: counts the amount of rows in the source and destination database and prints the diff. The command requires one of the following flags: * `--system`: copies all instances of the system * `--instance <instance-id>`, `--instance <comma separated list of instance ids>`: copies only the defined instances The command is save to execute multiple times by adding the `--replace`-flag. This replaces currently existing data except of the `events`-table # Additional Changes A `--for-mirror`-flag was added to `zitadel setup` to prepare the new database. The flag skips the creation of the first instances and initial run of projections. It is now possible to skip the creation of the first instance during setup by setting `FirstInstance.Skip` to true in the steps configuration. # Additional info It is currently not possible to merge multiple databases. See https://github.com/zitadel/zitadel/issues/7964 for more details. It is currently not possible to use files. See https://github.com/zitadel/zitadel/issues/7966 for more information. closes https://github.com/zitadel/zitadel/issues/7586 closes https://github.com/zitadel/zitadel/issues/7486 ### Definition of Ready - [x] I am happy with the code - [x] Short description of the feature/issue is added in the pr description - [x] PR is linked to the corresponding user story - [x] Acceptance criteria are met - [x] All open todos and follow ups are defined in a new ticket and justified - [x] Deviations from the acceptance criteria and design are agreed with the PO and documented. - [x] No debug or dead code - [x] My code has no repetitions - [x] Critical parts are tested automatically - [ ] Where possible E2E tests are implemented - [x] Documentation/examples are up-to-date - [x] All non-functional requirements are met - [x] Functionality of the acceptance criteria is checked manually on the dev system. --------- Co-authored-by: Livio Spring <livio.a@gmail.com>
2024-05-30 09:35:30 +00:00
# If set to true zitadel is setup without initial data
Skip: false
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
# The machine key from the section FirstInstance.Org.Machine.MachineKey is written to the MachineKeyPath.
MachineKeyPath: # ZITADEL_FIRSTINSTANCE_MACHINEKEYPATH
# The personal access token from the section FirstInstance.Org.Machine.Pat is written to the PatPath.
PatPath: # ZITADEL_FIRSTINSTANCE_PATPATH
InstanceName: ZITADEL # ZITADEL_FIRSTINSTANCE_INSTANCENAME
DefaultLanguage: en # ZITADEL_FIRSTINSTANCE_DEFAULTLANGUAGE
fix: setup instance domain handling (#3529)
2022-04-28 08:30:41 +00:00
Org:
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
Name: ZITADEL # ZITADEL_FIRSTINSTANCE_ORG_NAME
# In the FirstInstance.Org.Human section, the initial organization's admin user with the role IAM_OWNER is defined.
# ZITADEL either creates a human user or a machine user.
# If FirstInstance.Org.Machine.Machine is defined, a service user is created with the IAM_OWNER role, not a human user.
fix: setup instance domain handling (#3529)
2022-04-28 08:30:41 +00:00
Human:
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
# In case UserLoginMustBeDomain is false (default) and you don't overwrite the username with an email,
feat: restrict login to specific org by id (scope) (#4294) * feat: add new org scope * change default of UserLoginMustBeDomain to false * return resource owner claims * fix: use email style for first user * fix: ensure email style for default users (backwards compatibility) * change to external domain (as it was before UserLoginMustBeDomain change) * update e2e tests to use email style usernames * document new scope * lint e2e Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
2022-09-23 12:08:10 +00:00
# it will be suffixed by the org domain (org-name + domain from config).
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
# for example zitadel-admin in org ZITADEL on domain.tld -> zitadel-admin@zitadel.domain.tld
UserName: zitadel-admin # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_USERNAME
FirstName: ZITADEL # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_FIRSTNAME
LastName: Admin # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_LASTNAME
NickName: # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_NICKNAME
DisplayName: # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_DISPLAYNAME
fix: setup instance domain handling (#3529)
2022-04-28 08:30:41 +00:00
Email:
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
# uses the username if empty
Address: # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_EMAIL_ADDRESS
Verified: true # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_EMAIL_VERIFIED
PreferredLanguage: en # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PREFERREDLANGUAGE
Gender: # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_GENDER
fix: setup instance domain handling (#3529)
2022-04-28 08:30:41 +00:00
Phone:
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
Number: # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PHONE_NUMBER
Verified: # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PHONE_VERIFIED
Password: Password1! # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORD
PasswordChangeRequired: true # ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORDCHANGEREQUIRED
# In the FirstInstance.Org.Machine section, the initial organization's admin user with the role IAM_OWNER is defined.
# ZITADEL either creates a human user or a machine user.
# If FirstInstance.Org.Machine.Machine is defined, a service user is created with the IAM_OWNER role, not a human user.
feat: Instance create (#4502) * feat(instance): implement create instance with direct machine user and credentials * fix: deprecated add endpoint and variable declaration * fix(instance): update logic for pats and machinekeys * fix(instance): unit test corrections and additional unit test for pats and machinekeys * fix(instance-create): include review changes * fix(instance-create): linter fixes * move iframe usage to solution scenarios configurations * Revert "move iframe usage to solution scenarios configurations" This reverts commit 9db31f3808e6dfcae9907bc574c072436a19865a. * fix merge * fix: add review suggestions Co-authored-by: Livio Spring <livio.a@gmail.com> * fix: add review changes * fix: add review changes for default definitions * fix: add review changes for machinekey details * fix: add machinekey output when setup with machineuser * fix: add changes from review * fix instance converter for machine and allow overwriting of further machine fields Co-authored-by: Livio Spring <livio.a@gmail.com>
2022-12-09 13:04:33 +00:00
Machine:
Machine:
docs: fix environment variable name for steps (#6728) The yaml schema has a `Machine` object nested inside another one, which was improperly represented in the corresponding environment variable. Signed-off-by: Christoph Schmatzler <christoph@medium.place> Co-authored-by: Elio Bischof <elio@zitadel.com>
2023-10-16 09:59:55 +00:00
Username: # ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_USERNAME
Name: # ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_NAME
feat: Instance create (#4502) * feat(instance): implement create instance with direct machine user and credentials * fix: deprecated add endpoint and variable declaration * fix(instance): update logic for pats and machinekeys * fix(instance): unit test corrections and additional unit test for pats and machinekeys * fix(instance-create): include review changes * fix(instance-create): linter fixes * move iframe usage to solution scenarios configurations * Revert "move iframe usage to solution scenarios configurations" This reverts commit 9db31f3808e6dfcae9907bc574c072436a19865a. * fix merge * fix: add review suggestions Co-authored-by: Livio Spring <livio.a@gmail.com> * fix: add review changes * fix: add review changes for default definitions * fix: add review changes for machinekey details * fix: add machinekey output when setup with machineuser * fix: add changes from review * fix instance converter for machine and allow overwriting of further machine fields Co-authored-by: Livio Spring <livio.a@gmail.com>
2022-12-09 13:04:33 +00:00
MachineKey:
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
# date format: 2023-01-01T00:00:00Z
ExpirationDate: # ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINEKEY_EXPIRATIONDATE
# Currently, the only supported value is 1 for JSON
Type: # ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINEKEY_TYPE
fix: nil pointer on create instance add machine (#6000) * fix: nil pointer on create instance add machine * fix: instance setup with machine user pat * fix: correct logic to write pat and key from setup without configurable scope --------- Co-authored-by: Livio Spring <livio.a@gmail.com>
2023-06-15 06:16:39 +00:00
Pat:
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
# date format: 2023-01-01T00:00:00Z
ExpirationDate: # ZITADEL_FIRSTINSTANCE_ORG_MACHINE_PAT_EXPIRATIONDATE
fix(setup): steps 10 and 11 (#5987) * fix(step10): count amount of wrong_events manually * fix(step11): create index for better performance
2023-06-07 16:30:19 +00:00
fix(setup): smaller transactions (#5742)
2023-04-25 08:12:53 +00:00
CorrectCreationDate:
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
FailAfter: 5m # ZITADEL_CORRECTCREATIONDATE_FAILAFTER
fix(setup): steps 10 and 11 (#5987) * fix(step10): count amount of wrong_events manually * fix(step11): create index for better performance
2023-06-07 16:30:19 +00:00
AddEventCreatedAt:
docs: copy config options to docs (#6143) * poc * wip * works * upgrade yaml package * need to add global comments for shifting * wip: need index before working on comments * green * clean up * test null value * comment * package * delete * convert to module * render md table * tests with ESM * comments * top level gitignore * wip: new cases * arrays: green * array_test * treat comments on map without first element * fix some new case * skip leaf comments * output folder * comment * finish up for poc * arrays * create output dir * merge main, create tables * copy config options to docs * cleanup * recommend file configuration * language * add some explanations * some small typo fixes --------- Co-authored-by: mffap <mpa@zitadel.com> Co-authored-by: Florian Forster <florian@zitadel.com>
2023-08-07 20:32:10 +00:00
BulkAmount: 100 # ZITADEL_ADDEVENTCREATEDAT_BULKAMOUNT
Reference in New Issue Copy Permalink