diff --git a/docs/docs/reference/config-migration.md b/docs/docs/reference/migration.md similarity index 100% rename from docs/docs/reference/config-migration.md rename to docs/docs/reference/migration.md diff --git a/docs/docs/workflows/upgrade.md b/docs/docs/workflows/upgrade.md index 411a4c691..16ac95579 100644 --- a/docs/docs/workflows/upgrade.md +++ b/docs/docs/workflows/upgrade.md @@ -24,7 +24,7 @@ To learn which Kubernetes versions are supported by a particular CLI, run [const ## Migrate the configuration The Constellation configuration file is located in the file `constellation-conf.yaml` in your workspace. -Refer to the [migration reference](../reference/config-migration.md) to check if you need to update fields in your configuration file. +Refer to the [migration reference](../reference/migration.md) to check if you need to update fields in your configuration file. Use [`constellation config migrate`](../reference/cli.md#constellation-config-migrate) to automatically update an old config file to a new format. ## Check for upgrades diff --git a/docs/sidebars.js b/docs/sidebars.js index f32770522..62f5cab4b 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -254,7 +254,7 @@ const sidebars = { { type: 'doc', label: 'Configuration migrations', - id: 'reference/config-migration', + id: 'reference/migration', }, { type: 'doc', diff --git a/docs/versioned_docs/version-2.8/reference/config-migration.md b/docs/versioned_docs/version-2.8/reference/migration.md similarity index 100% rename from docs/versioned_docs/version-2.8/reference/config-migration.md rename to docs/versioned_docs/version-2.8/reference/migration.md diff --git a/docs/versioned_docs/version-2.8/workflows/upgrade.md b/docs/versioned_docs/version-2.8/workflows/upgrade.md index c8dbd2b9b..44fe1956b 100644 --- a/docs/versioned_docs/version-2.8/workflows/upgrade.md +++ b/docs/versioned_docs/version-2.8/workflows/upgrade.md @@ -31,7 +31,7 @@ To learn which Kubernetes versions are supported by a particular CLI, run [const ## Migrate the configuration The Constellation configuration file is located in the file `constellation-conf.yaml` in your workspace. -Refer to the [migration reference](../reference/config-migration.md) to check if you need to update fields in your configuration file. +Refer to the [migration reference](../reference/migration.md) to check if you need to update fields in your configuration file. Use [`constellation config migrate`](../reference/cli.md#constellation-config-migrate) to automatically update an old config file to a new format. ## Check for upgrades diff --git a/docs/versioned_sidebars/version-2.8-sidebars.json b/docs/versioned_sidebars/version-2.8-sidebars.json index ae9191bda..c9dd1cc50 100644 --- a/docs/versioned_sidebars/version-2.8-sidebars.json +++ b/docs/versioned_sidebars/version-2.8-sidebars.json @@ -231,7 +231,7 @@ { "type": "doc", "label": "Configuration migrations", - "id": "reference/config-migration" + "id": "reference/migration" }, { "type": "doc", diff --git a/internal/config/config.go b/internal/config/config.go index f8a60227d..a6a1e8775 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -421,8 +421,8 @@ func New(fileHandler file.Handler, name string, _ attestationconfigapi.Fetcher, if c.Provider.Azure != nil && (c.Provider.Azure.AppClientID != "" || c.Provider.Azure.ClientSecretValue != "") { // Deprecation warning for old auth method - fmt.Fprintf(os.Stderr, "WARNING: Using a service principal for authentication is deprecated and will be removed in an upcoming version.") - fmt.Fprintf(os.Stderr, " Migrate to using a user assigned managed identity by following the migration guide: https://docs.edgeless.systems/constellation/reference/migration.") + fmt.Fprintf(os.Stderr, "WARNING: Using a service principal for authentication is deprecated and will be removed in an upcoming version.\n") + fmt.Fprintf(os.Stderr, " Migrate to using a user assigned managed identity by following the migration guide: https://docs.edgeless.systems/constellation/reference/migration.\n") } return c, c.Validate(force)