Moved app auth and git-auth settings to app metadata instead of app settings

Author: akclace

CHANGELOG.md

@@ -11,6 +11,10 @@ This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Added `openrun_admin` plugin with apis to manage `sync` jobs, for use by manage_sync app
 
+### Changed
+
+- Changed app authentication setting and git auth setting to be stored in app metadata instead of in app settings. This allows those properties to be updated through declarative config. The property is moved over as part of a migration. Also, `app update-metadata` CLI command is renamed to `app update`.
+
 ## [0.15.13] - 2025-10-28
 
 ### Added
@@ -54,4 +58,4 @@ This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Enable CSRF protection for internal APIs and for apps. App level CSRF protection is enabled by default.
   Use `security.disable_csrf_protection = true` to disable. Disable in app metadata by running
-  `openrun app update-metadata conf --promote 'security.disable_csrf_protection=true' /myapp`
+  `openrun app update conf --promote 'security.disable_csrf_protection=true' /myapp`

cmd/openrun/app_cmds.go

@@ -366,15 +366,15 @@ func appType(app types.AppResponse) string {
 }
 
 func authType(app types.AppResponse) string {
-	switch app.Settings.AuthnType {
+	switch app.Metadata.AuthnType {
 	case types.AppAuthnNone:
 		return "NONE"
 	case types.AppAuthnSystem:
 		return "SYSTEM"
 	case types.AppAuthnDefault, "":
 		return "DEFAULT"
 	default:
-		return string(app.Settings.AuthnType)
+		return string(app.Metadata.AuthnType)
 	}
 }
 

cmd/openrun/app_update_cmds.go

@@ -21,8 +21,6 @@ func appUpdateSettingsCommand(commonFlags []cli.Flag, clientConfig *types.Client
 		Subcommands: []*cli.Command{
 			appUpdateStageWrite(commonFlags, clientConfig),
 			appUpdatePreviewWrite(commonFlags, clientConfig),
-			appUpdateAuthnType(commonFlags, clientConfig),
-			appUpdateGitAuth(commonFlags, clientConfig),
 		},
 	}
 }
@@ -151,123 +149,18 @@ The second required argument is <appPathGlob>. ` + PATH_SPEC_HELP + `
 	}
 }
 
-func appUpdateAuthnType(commonFlags []cli.Flag, clientConfig *types.ClientConfig) *cli.Command {
-	flags := make([]cli.Flag, 0, len(commonFlags)+2)
-	flags = append(flags, commonFlags...)
-	flags = append(flags, dryRunFlag())
-
-	return &cli.Command{
-		Name:      "auth",
-		Usage:     "Update authentication mode for apps",
-		Flags:     flags,
-		Before:    altsrc.InitInputSourceWithContext(flags, altsrc.NewTomlSourceFromFlagFunc(configFileFlagName)),
-		ArgsUsage: "<value:system|default|none|custom> <appPathGlob>",
-
-		UsageText: `args: <value:default|none> <appPathGlob>
-
-The first required argument <value> is a string, system, default, none or OAuth entry name.
-The second required argument is <appPathGlob>. ` + PATH_SPEC_HELP + `
-
-	Examples:
-	  Update all apps, across domains: openrun app update-settings auth default all
-	  Update apps in the example.com domain: openrun app update-settings auth none "example.com:**"`,
-
-		Action: func(cCtx *cli.Context) error {
-			if cCtx.NArg() != 2 {
-				return fmt.Errorf("requires two arguments: <value> <appPathGlob>")
-			}
-
-			client := system.NewHttpClient(clientConfig.ServerUri, clientConfig.AdminUser, clientConfig.Client.AdminPassword, clientConfig.Client.SkipCertCheck)
-			values := url.Values{}
-			values.Add("appPathGlob", cCtx.Args().Get(1))
-			values.Add(DRY_RUN_ARG, strconv.FormatBool(cCtx.Bool(DRY_RUN_FLAG)))
-
-			body := types.CreateUpdateAppRequest()
-			body.AuthnType = types.StringValue(cCtx.Args().Get(0))
-
-			var updateResponse types.AppUpdateSettingsResponse
-			if err := client.Post("/_openrun/app_settings", values, body, &updateResponse); err != nil {
-				return err
-			}
-
-			for _, updateResult := range updateResponse.UpdateResults {
-				fmt.Printf("Updating %s\n", updateResult)
-			}
-			printStdout(cCtx, "%d app(s) updated.\n", len(updateResponse.UpdateResults))
-
-			if updateResponse.DryRun {
-				fmt.Print(DRY_RUN_MESSAGE)
-			}
-
-			return nil
-		},
-	}
-}
-
-func appUpdateGitAuth(commonFlags []cli.Flag, clientConfig *types.ClientConfig) *cli.Command {
-	flags := make([]cli.Flag, 0, len(commonFlags)+2)
-	flags = append(flags, commonFlags...)
-	flags = append(flags, dryRunFlag())
-
-	return &cli.Command{
-		Name:      "git-auth",
-		Usage:     "Update git-auth entry for apps",
-		Flags:     flags,
-		Before:    altsrc.InitInputSourceWithContext(flags, altsrc.NewTomlSourceFromFlagFunc(configFileFlagName)),
-		ArgsUsage: "<entryName> <appPathGlob>",
-
-		UsageText: `args: <entryName> <appPathGlob> 
-
-The first required argument <entryName> is a string. Specify the git_auth entry key name as configured in the openrun.toml config.
-Set to "-" to remove the git_auth entry.
-The second required argument is <appPathGlob>. ` + PATH_SPEC_HELP + `
-
-	Examples:
-	  Update all apps, across domains: openrun app update-settings git-auth mygit all
-	  Update apps in the example.com domain: openrun app git-auth gitentrykey "example.com:**"`,
-
-		Action: func(cCtx *cli.Context) error {
-			if cCtx.NArg() != 2 {
-				return fmt.Errorf("requires two arguments: <entryName> <appPathGlob>")
-			}
-
-			client := system.NewHttpClient(clientConfig.ServerUri, clientConfig.AdminUser, clientConfig.Client.AdminPassword, clientConfig.Client.SkipCertCheck)
-			values := url.Values{}
-			values.Add("appPathGlob", cCtx.Args().Get(1))
-			values.Add(DRY_RUN_ARG, strconv.FormatBool(cCtx.Bool(DRY_RUN_FLAG)))
-
-			body := types.CreateUpdateAppRequest()
-			body.GitAuthName = types.StringValue(cCtx.Args().Get(0))
-
-			var updateResponse types.AppUpdateSettingsResponse
-			if err := client.Post("/_openrun/app_settings", values, body, &updateResponse); err != nil {
-				return err
-			}
-
-			for _, updateResult := range updateResponse.UpdateResults {
-				fmt.Printf("Updating %s\n", updateResult)
-			}
-			printStdout(cCtx, "%d app(s) updated.\n", len(updateResponse.UpdateResults))
-
-			if updateResponse.DryRun {
-				fmt.Print(DRY_RUN_MESSAGE)
-			}
-
-			return nil
-		},
-	}
-}
-
 func appUpdateMetadataCommand(commonFlags []cli.Flag, clientConfig *types.ClientConfig) *cli.Command {
 	return &cli.Command{
-		Name:  "update-metadata",
+		Name:  "update",
 		Usage: `Update OpenRun app metadata. Metadata updates are staged and have to be promoted to prod. Use "openrun param" to update app parameter metadata.`,
 		Subcommands: []*cli.Command{
 			appUpdateAppSpec(commonFlags, clientConfig),
-			appUpdateConfig(commonFlags, clientConfig, "container-option", "copt", types.AppMetadataContainerOptions),
-			appUpdateConfig(commonFlags, clientConfig, "container-arg", "carg", types.AppMetadataContainerArgs),
-			appUpdateConfig(commonFlags, clientConfig, "container-volumes", "cvol", types.AppMetadataContainerVolumes),
-			appUpdateConfig(commonFlags, clientConfig, "app-config", "conf", types.AppMetadataAppConfig),
+			appUpdateConfig(commonFlags, clientConfig, "container-option", "copt", types.AppMetadataContainerOptions, "option"),
+			appUpdateConfig(commonFlags, clientConfig, "container-arg", "carg", types.AppMetadataContainerArgs, "arg"),
+			appUpdateConfig(commonFlags, clientConfig, "container-volumes", "cvol", types.AppMetadataContainerVolumes, "volume"),
+			appUpdateConfig(commonFlags, clientConfig, "app-config", "conf", types.AppMetadataAppConfig, "config"),
+			appUpdateConfig(commonFlags, clientConfig, "auth", "", types.AppMetadataAuthnType, "<auth_type>"),
+			appUpdateConfig(commonFlags, clientConfig, "git-auth", "", types.AppMetadataGitAuthName, "<git_auth>"),
 		},
 	}
 }
@@ -291,8 +184,8 @@ The first required argument <value> is a string, a valid app spec name or - (to
 The last required argument is <appPathGlob>. ` + PATH_SPEC_HELP + `
 
 	Examples:
-	  Update all apps, across domains: openrun app update-metadata spec - all
-	  Update apps in the example.com domain: openrun app update-metadata spec proxy "example.com:**"`,
+	  Update all apps, across domains: openrun app update spec - all
+	  Update apps in the example.com domain: openrun app update spec proxy "example.com:**"`,
 
 		Action: func(cCtx *cli.Context) error {
 			if cCtx.NArg() != 2 {
@@ -340,27 +233,25 @@ The last required argument is <appPathGlob>. ` + PATH_SPEC_HELP + `
 }
 
 // appUpdateConfig creates a command to update app metadata config
-func appUpdateConfig(commonFlags []cli.Flag, clientConfig *types.ClientConfig, arg string, shortFlag string, configType types.AppMetadataConfigType) *cli.Command {
+func appUpdateConfig(commonFlags []cli.Flag, clientConfig *types.ClientConfig, arg string, shortFlag string, configType types.AppMetadataConfigType, valName string) *cli.Command {
 	flags := make([]cli.Flag, 0, len(commonFlags)+2)
 	flags = append(flags, commonFlags...)
 	flags = append(flags, dryRunFlag())
 	flags = append(flags, newBoolFlag(PROMOTE_FLAG, "p", "Promote the change from stage to prod", false))
 
-	return &cli.Command{
+	cmd := &cli.Command{
 		Name:      arg,
-		Aliases:   []string{shortFlag},
 		Usage:     fmt.Sprintf("Update %s metadata for apps", arg),
 		Flags:     flags,
 		Before:    altsrc.InitInputSourceWithContext(flags, altsrc.NewTomlSourceFromFlagFunc(configFileFlagName)),
-		ArgsUsage: "key=value <appPathGlob>",
+		ArgsUsage: valName + " <appPathGlob>",
 
-		UsageText: fmt.Sprintf(`args: key=value [key=value ...] <appPathGlob>
-The initial arguments key=value are strings, the key to set and the value to use delimited by =. The value is optional for
-container options. The last argument is <appPathGlob>. `+PATH_SPEC_HELP+`
+		UsageText: fmt.Sprintf(`args: `+valName+` <appPathGlob>
+The initial argument are strings. The last argument is <appPathGlob>. `+PATH_SPEC_HELP+`
 
 	Examples:
-	  Update all apps, across domains: openrun app update-metadata %s key=value all
-	  Update apps in the example.com domain: openrun app update-metadata %s key=value "example.com:**"`, arg, arg),
+	  Update all apps, across domains: openrun app update %s %s all
+	  Update apps in the example.com domain: openrun app update %s %s "example.com:**"`, arg, valName, arg, valName),
 
 		Action: func(cCtx *cli.Context) error {
 			if cCtx.NArg() < 2 {
@@ -407,4 +298,8 @@ container options. The last argument is <appPathGlob>. `+PATH_SPEC_HELP+`
 			return nil
 		},
 	}
+	if shortFlag != "" {
+		cmd.Aliases = []string{shortFlag}
+	}
+	return cmd
 }