Skip to content

om staged-director config --no-redact help text is wrong #718

@haydonryan

Description

@haydonryan

Describe the bug

$ om staged-director-config --help
Usage:
  om [OPTIONS] staged-director-config [staged-director-config-OPTIONS]

This command generates a config from a staged director that can be passed in to om configure-director

Application Options:
      --ca-cert=                  OpsManager CA certificate path or value [$OM_CA_CERT]
  -c, --client-id=                Client ID for the Ops Manager VM (not required for unauthenticated commands) [$OM_CLIENT_ID]
  -s, --client-secret=            Client Secret for the Ops Manager VM (not required for unauthenticated commands) [$OM_CLIENT_SECRET]
  -o, --connect-timeout=          timeout in seconds to make TCP connections (default: 10) [$OM_CONNECT_TIMEOUT]
  -d, --decryption-passphrase=    Passphrase to decrypt the installation if the Ops Manager VM has been rebooted (optional for most commands) [$OM_DECRYPTION_PASSPHRASE]
  -e, --env=                      env file with login credentials
  -p, --password=                 admin password for the Ops Manager VM (not required for unauthenticated commands) [$OM_PASSWORD]
  -r, --request-timeout=          timeout in seconds for HTTP requests to Ops Manager (default: 1800) [$OM_REQUEST_TIMEOUT]
  -k, --skip-ssl-validation       skip ssl certificate validation during http requests [$OM_SKIP_SSL_VALIDATION]
  -t, --target=                   location of the Ops Manager VM [$OM_TARGET]
      --uaa-target=               optional location of the Ops Manager UAA [$OM_UAA_TARGET]
      --trace                     prints HTTP requests and response payloads [$OM_TRACE]
  -u, --username=                 admin username for the Ops Manager VM (not required for unauthenticated commands) [$OM_USERNAME]
      --vars-env=                 load vars from environment variables by specifying a prefix (e.g.: 'MY' to load MY_var=value) [$OM_VARS_ENV]
  -v, --version                   prints the om release version

Help Options:
  -h, --help                      Show this help message

[staged-director-config command options]
      -r, --include-placeholders  Replace obscured credentials to interpolatable placeholders.
                                  To include credentials hidden by OpsMan, use with "--no-redact"
          --no-redact             Redact IaaS values from director configuration

The help text to the no redact is confusing. It should be that it won't redact the values.

Submitting a PR to fix

Reproduction steps

om staged-director config --no-redact

Expected behavior

Should say Do not redact IaaS values from director configuration

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions