Skip to content

Commit

Permalink
fixed deprecation messages, fixed documentation examples
Browse files Browse the repository at this point in the history
  • Loading branch information
GDW1 committed Jun 27, 2023
1 parent a485f51 commit 7d9be89
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions cmd/config/set.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,18 @@ if on context name is specified, the current context is created/updated.`

setContextExample = `
# Set oauth credentials (recommended for interactive use)
fsoc config set --auth=oauth --url=https://mytenant.observe.appdynamics.com
fsoc config set auth=oauth url=https://mytenant.observe.appdynamics.com
# Set service or agent principal credentials (secret file must remain accessible)
fsoc config set --auth=service-principal --secret-file=my-service-principal.json
fsoc config set --auth=agent-principal --secret-file=agent-helm-values.yaml
fsoc config set --auth=agent-principal --secret-file=client-values.json --tenant=123456 --url=https://mytenant.observe.appdynamics.com
fsoc config set auth=service-principal secret-file=my-service-principal.json
fsoc config set auth=agent-principal secret-file=agent-helm-values.yaml
fsoc config set auth=agent-principal secret-file=client-values.json tenant=123456 url=https://mytenant.observe.appdynamics.com
# Set local access
fsoc config set --auth=local url=http://localhost --appd-pid=PID --appd-tid=TID --appd-pty=PTY
fsoc config set auth=local url=http://localhost appd-pid=PID appd-tid=TID appd-pty=PTY
# Set the token field on the "prod" context entry without touching other values
fsoc config set --profile prod --token=top-secret`
fsoc config set profile prod token=top-secret`
)

func newCmdConfigSet() *cobra.Command {
Expand All @@ -63,17 +63,23 @@ func newCmdConfigSet() *cobra.Command {
Run: configSetContext,
}
cmd.Flags().String(AppdPid, "", "pid to use (local auth type only, provide raw value to be encoded)")
_ = cmd.Flags().MarkDeprecated(AppdPid, "the --"+AppdPid+" flag is deprecated, please use arguments supplied as "+AppdPid+"="+strings.ToUpper(AppdPid))
cmd.Flags().String(AppdTid, "", "tid to use (local auth type only, provide raw value to be encoded)")
_ = cmd.Flags().MarkDeprecated(AppdTid, "the --"+AppdTid+" flag is deprecated, please use arguments supplied as "+AppdTid+"="+strings.ToUpper(AppdTid))
cmd.Flags().String(AppdPty, "", "pty to use (local auth type only, provide raw value to be encoded)")
_ = cmd.Flags().MarkDeprecated(AppdPty, "the --"+AppdPty+" flag is deprecated, please use arguments supplied as "+AppdPty+"="+strings.ToUpper(AppdPty))
cmd.Flags().String("auth", "", fmt.Sprintf(`Select authentication method, one of {"%v"}`, strings.Join(GetAuthMethodsStringList(), `", "`)))
_ = cmd.Flags().MarkDeprecated("url", "TODO") // TODO: Change Deprecation Message
_ = cmd.Flags().MarkDeprecated("auth", "the --auth flag is deprecated, please use arguments supplied as auth=AUTH")
cmd.Flags().String("server", "", "Set server host name")
_ = cmd.Flags().MarkDeprecated("server", "The --server flag is deprecated, please use --url instead.")
_ = cmd.Flags().MarkDeprecated("server", "the --server flag is deprecated, please use arguments supplied as url=URL")
cmd.Flags().String("url", "", "Set server URL (with http or https schema)")
_ = cmd.Flags().MarkDeprecated("url", "The --server flag is deprecated, please use --url instead.") // TODO: Change Deprecation Message
_ = cmd.Flags().MarkDeprecated("url", "the --url flag is deprecated, please use arguments supplied as url=URL")
cmd.Flags().String("tenant", "", "Set tenant ID")
_ = cmd.Flags().MarkDeprecated("tenant", "the --tenant flag is deprecated, please use arguments supplied as tenant=TENANT")
cmd.Flags().String("token", "", "Set token value (use --token=- to get from stdin)")
_ = cmd.Flags().MarkDeprecated("token", "the --token flag is deprecated, please use arguments supplied as token=TOKEN")
cmd.Flags().String("secret-file", "", "Set a credentials file to use for service principal (.json or .csv) or agent principal (.yaml)")
_ = cmd.Flags().MarkDeprecated("secret-file", "the --secret-file flag is deprecated, please use arguments supplied as secret-file=SECRET-TOKEN")
return cmd
}

Expand Down

0 comments on commit 7d9be89

Please sign in to comment.