mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-16 04:48:04 +00:00
2243306ef6
# 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>
94 lines
2.9 KiB
Go
94 lines
2.9 KiB
Go
package mirror
|
|
|
|
import (
|
|
"bytes"
|
|
_ "embed"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/viper"
|
|
"github.com/zitadel/logging"
|
|
|
|
"github.com/zitadel/zitadel/cmd/key"
|
|
)
|
|
|
|
var (
|
|
instanceIDs []string
|
|
isSystem bool
|
|
shouldReplace bool
|
|
)
|
|
|
|
func New() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "mirror",
|
|
Short: "mirrors all data of ZITADEL from one database to another",
|
|
Long: `mirrors all data of ZITADEL from one database to another
|
|
ZITADEL needs to be initialized and set up with --for-mirror
|
|
|
|
The command does mirror all data needed and recomputes the projections.
|
|
For more details call the help functions of the sub commands.
|
|
|
|
Order of execution:
|
|
1. mirror system tables
|
|
2. mirror auth tables
|
|
3. mirror event store tables
|
|
4. recompute projections
|
|
5. verify`,
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
config := mustNewMigrationConfig(viper.GetViper())
|
|
projectionConfig := mustNewProjectionsConfig(viper.GetViper())
|
|
|
|
masterKey, err := key.MasterKey(cmd)
|
|
logging.OnError(err).Fatal("unable to read master key")
|
|
|
|
copySystem(cmd.Context(), config)
|
|
copyAuth(cmd.Context(), config)
|
|
copyEventstore(cmd.Context(), config)
|
|
|
|
projections(cmd.Context(), projectionConfig, masterKey)
|
|
verifyMigration(cmd.Context(), config)
|
|
},
|
|
}
|
|
|
|
mirrorFlags(cmd)
|
|
cmd.Flags().BoolVar(&shouldIgnorePrevious, "ignore-previous", false, "ignores previous migrations of the events table")
|
|
cmd.Flags().BoolVar(&shouldReplace, "replace", false, `replaces all data of the following tables for the provided instances or all if the "--system"-flag is set:
|
|
* system.assets
|
|
* auth.auth_requests
|
|
* eventstore.unique_constraints
|
|
The flag should be provided if you want to execute the mirror command multiple times so that the static data are also mirrored to prevent inconsistent states.`)
|
|
migrateProjectionsFlags(cmd)
|
|
|
|
err := viper.MergeConfig(bytes.NewBuffer(defaultConfig))
|
|
logging.OnError(err).Fatal("unable to read default config")
|
|
|
|
cmd.AddCommand(
|
|
eventstoreCmd(),
|
|
systemCmd(),
|
|
projectionsCmd(),
|
|
authCmd(),
|
|
verifyCmd(),
|
|
)
|
|
|
|
return cmd
|
|
}
|
|
|
|
func mirrorFlags(cmd *cobra.Command) {
|
|
cmd.PersistentFlags().StringSliceVar(&instanceIDs, "instance", nil, "id or comma separated ids of the instance(s) to migrate. Either this or the `--system`-flag must be set. Make sure to always use the same flag if you execute the command multiple times.")
|
|
cmd.PersistentFlags().BoolVar(&isSystem, "system", false, "migrates the whole system. Either this or the `--instance`-flag must be set. Make sure to always use the same flag if you execute the command multiple times.")
|
|
cmd.MarkFlagsOneRequired("system", "instance")
|
|
cmd.MarkFlagsMutuallyExclusive("system", "instance")
|
|
}
|
|
|
|
func instanceClause() string {
|
|
if isSystem {
|
|
return "WHERE instance_id <> ''"
|
|
}
|
|
for i := range instanceIDs {
|
|
instanceIDs[i] = "'" + instanceIDs[i] + "'"
|
|
}
|
|
|
|
// COPY does not allow parameters so we need to set them directly
|
|
return "WHERE instance_id IN (" + strings.Join(instanceIDs, ", ") + ")"
|
|
}
|