zitadel/docs
Silvan 2243306ef6
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
..
apis/assets ci: improve performance (#5953) 2023-07-17 10:08:20 +02:00
docs feat(cmd): mirror (#7004) 2024-05-30 09:35:30 +00:00
src docs: add video to quickstart (#7512) 2024-03-06 18:31:49 +00:00
static feat(cnsl): docs link can be customized and custom button is available (#7840) 2024-05-13 16:01:50 +02:00
.gitignore docs: copy config options to docs (#6143) 2023-08-07 22:32:10 +02:00
babel.config.js docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
buf.gen.yaml chore(api): initial definition of API for user schemas (user v3 and user schema v3 service) (#7372) 2024-02-15 11:22:48 +01:00
Dockerfile docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
docusaurus.config.js fix: add action v2 execution to features (#7597) 2024-04-09 20:21:21 +03:00
frameworks.json feat(console): integrate app (#7417) 2024-02-28 16:52:21 +00:00
nginx.conf docs(nginx): fix nginx directory, system api proto description (#5809) 2023-05-15 07:23:56 +00:00
package.json docs: add video to quickstart (#7512) 2024-03-06 18:31:49 +00:00
README.md docs: Add reference to Actions for custom claims and custom attributes (#7204) 2024-01-11 15:27:37 +01:00
sidebars.js feat(cmd): mirror (#7004) 2024-05-30 09:35:30 +00:00
tailwind.config.js docs: add tailwindcss for styles, oidc authorize endpoint playground (#4707) 2022-12-05 18:36:12 +01:00
vercel.json docs: redirect identity providers introduction (#7695) 2024-04-03 07:02:01 +00:00
yarn.lock docs: add video to quickstart (#7512) 2024-03-06 18:31:49 +00:00

ZITADEL-Docs

This website is built using Docusaurus 2, a modern static website generator.

Add new Sites to existing Topics

To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.

Installation

Install dependencies with

yarn install

then run

yarn generate

Local Development

Start a local development server with

yarn start

When working on the API docs, run a local development server with

yarn start:api

Container Image

If you just want to start docusaurus locally without installing node you can fallback to our container image. Execute the following commands from the repository root to build and start a local version of ZITADEL

docker build -f docs/Dockerfile . -t zitadel-docs
docker run -p 8080:8080 zitadel-docs