diff --git a/cmd/platform/export.go b/cmd/platform/export.go index a364bec5..8094c4d6 100644 --- a/cmd/platform/export.go +++ b/cmd/platform/export.go @@ -15,31 +15,31 @@ import ( ) const ( - commandExamples = ` Export configuration-as-code for all products configured in the configuration file, applying default options. + commandExamples = ` Export Configuration as Code for all products configured in the configuration file, applying default options. pingcli platform export - Export configuration-as-code packages for all configured products to a specific directory, overwriting any previous export. + Export Configuration as Code packages for all configured products to a specific directory, overwriting any previous export. pingcli platform export --output-directory /path/to/my/directory --overwrite - Export configuration-as-code packages for all configured products, specifying the export format as Terraform HCL. + Export Configuration as Code packages for all configured products, specifying the export format as Terraform HCL. pingcli platform export --format HCL - Export configuration-as-code packages for PingOne (core platform and SSO services). + Export Configuration as Code packages for PingOne (core platform and SSO services). pingcli platform export --services pingone-platform,pingone-sso - Export all configuration-as-code packages for PingOne. The --service-group flag can be used instead of listing all pingone-* packages in --services flag. + Export all Configuration as Code packages for PingOne. The --service-group flag can be used instead of listing all pingone-* packages in --services flag. pingcli platform export --service-group pingone - Export configuration-as-code packages for PingOne (core platform), specifying the PingOne environment connection details. + Export Configuration as Code packages for PingOne (core platform), specifying the PingOne environment connection details. pingcli platform export --services pingone-platform --pingone-client-environment-id 3cf2... --pingone-worker-client-id a719... --pingone-worker-client-secret ey..... --pingone-region-code EU - Export configuration-as-code packages for PingFederate, specifying the PingFederate connection details using basic authentication. + Export Configuration as Code packages for PingFederate, specifying the PingFederate connection details using basic authentication. pingcli platform export --services pingfederate --pingfederate-authentication-type basicAuth --pingfederate-username administrator --pingfederate-password 2FederateM0re --pingfederate-https-host https://pingfederate-admin.bxretail.org - Export configuration-as-code packages for PingFederate, specifying the PingFederate connection details using OAuth 2.0 client credentials. + Export Configuration as Code packages for PingFederate, specifying the PingFederate connection details using OAuth 2.0 client credentials. pingcli platform export --services pingfederate --pingfederate-authentication-type clientCredentialsAuth --pingfederate-client-id clientID --pingfederate-client-secret clientSecret --pingfederate-token-url https://pingfederate-admin.bxretail.org/as/token.oauth2 - Export configuration-as-code packages for PingFederate, specifying optional connection properties + Export Configuration as Code packages for PingFederate, specifying optional connection properties pingcli platform export --services pingfederate --x-bypass-external-validation=false --ca-certificate-pem-files "/path/to/cert.pem,/path/to/cert2.pem" --insecure-trust-all-tls=false` ) @@ -48,12 +48,12 @@ func NewExportCommand() *cobra.Command { Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: commandExamples, - Long: "Export configuration-as-code packages for the Ping Platform.\n\n" + + Long: "Export Configuration as Code packages for the Ping Platform.\n\n" + "The CLI can export Terraform HCL to use with released Terraform providers.\n" + "The Terraform HCL option generates `import {}` block statements for resources in the target environment.\n" + "Using Terraform `import {}` blocks, the platform's configuration can be generated and imported into state management.\n" + "More information can be found at https://developer.hashicorp.com/terraform/language/import", - Short: "Export configuration-as-code packages for the Ping Platform.", + Short: "Export Configuration as Code packages for the Ping Platform.", RunE: exportRunE, Use: "export [flags]", } diff --git a/docs/exporting-configuration/hcl-export-compatibility.md b/docs/exporting-configuration/hcl-export-compatibility.md index b99eabb5..5adff050 100644 --- a/docs/exporting-configuration/hcl-export-compatibility.md +++ b/docs/exporting-configuration/hcl-export-compatibility.md @@ -1,7 +1,6 @@ # Ping CLI HCL Export Services Support -The platform export command exports configuration-as-code packages for the Ping Platform. The CLI can export -Terraform HCL to use with released Terraform providers. +The platform export command exports Configuration as Code packages for the Ping Platform. The CLI can export Terraform HCL to use with released Terraform providers. The following describes the CLI's support of each of these Ping platform services for HCL export. diff --git a/docs/exporting-configuration/native-export-compatibility.md b/docs/exporting-configuration/native-export-compatibility.md index 9488acb5..f1a6ef2e 100644 --- a/docs/exporting-configuration/native-export-compatibility.md +++ b/docs/exporting-configuration/native-export-compatibility.md @@ -1,7 +1,6 @@ # Ping CLI Native Export Services Support -The platform export command exports configuration-as-code packages for the Ping Platform. The CLI plans to export -natively from Ping platform services. +The platform export command exports Configuration as Code packages for the Ping Platform. The CLI plans to export natively from Ping platform services. The following describes the CLI's support of each of these Ping platform services for native export. diff --git a/docs/exporting-configuration/terraform-provider-compatibility.md b/docs/exporting-configuration/terraform-provider-compatibility.md index 707024de..7cbc20fc 100644 --- a/docs/exporting-configuration/terraform-provider-compatibility.md +++ b/docs/exporting-configuration/terraform-provider-compatibility.md @@ -1,7 +1,6 @@ # Ping CLI Platform Export Terraform Provider Support -The platform export command exports configuration-as-code packages for the Ping Platform. The CLI can export -Terraform HCL to use with released Terraform providers. +The platform export command exports Configuration as Code packages for the Ping Platform. The CLI can export Terraform HCL to use with released Terraform providers. See [HCL Export Compatibility](./hcl-export-compatibility.md) to learn more about which Ping platform services are supported in export. diff --git a/docs/tool-configuration/configuration-key.md b/docs/tool-configuration/configuration-key.md index a9bfd442..39dc8af5 100644 --- a/docs/tool-configuration/configuration-key.md +++ b/docs/tool-configuration/configuration-key.md @@ -26,7 +26,7 @@ The following parameters can be configured in Ping CLI's static configuration fi | service.pingfederate.authentication.type | ENUM_PINGFEDERATE_AUTH_TYPE | --pingfederate-authentication-type | The authentication type to use when connecting to the PingFederate admin API.

Options are: accessTokenAuth, basicAuth, clientCredentialsAuth.

Example: `basicAuth` | | service.pingfederate.caCertificatePemFiles | ENUM_STRING_SLICE | --pingfederate-ca-certificate-pem-files | Relative or full paths to PEM-encoded certificate files to be trusted as root CAs when connecting to the PingFederate server over HTTPS.

Accepts a comma-separated string to delimit multiple PEM files. | | service.pingfederate.httpsHost | ENUM_STRING | --pingfederate-https-host | The PingFederate HTTPS host used to communicate with PingFederate's admin API.

Example: `https://pingfederate-admin.bxretail.org` | -| service.pingfederate.insecureTrustAllTLS | ENUM_BOOL | --pingfederate-insecure-trust-all-tls | Trust any certificate when connecting to the PingFederate server admin API.

This is insecure and should not be enabled outside of testing. | +| service.pingfederate.insecureTrustAllTLS | ENUM_BOOL | --pingfederate-insecure-trust-all-tls | Trust any certificate when connecting to the PingFederate server admin API.

This is insecure and shouldn't be enabled outside of testing. | | service.pingfederate.xBypassExternalValidationHeader | ENUM_BOOL | --pingfederate-x-bypass-external-validation-header | Bypass connection tests when configuring PingFederate (the X-BypassExternalValidation header when using PingFederate's admin API). | | service.pingone.authentication.type | ENUM_PINGONE_AUTH_TYPE | --pingone-authentication-type | The authentication type to use to authenticate to the PingOne management API.

Options are: worker.

Example: `worker` | | service.pingone.authentication.worker.clientID | ENUM_UUID | --pingone-worker-client-id | The worker client ID used to authenticate to the PingOne management API. | @@ -40,7 +40,7 @@ The following parameters can be configured in Ping CLI's static configuration fi |---|---|---|---| | export.format | ENUM_STRING | --format / -f | Specifies the export format.

Options are: HCL.

Example: `HCL` | | export.outputDirectory | ENUM_STRING | --output-directory / -d | Specifies the output directory for export. Example: `$HOME/pingcli-export` | -| export.overwrite | ENUM_BOOL | --overwrite / -o | Overwrite the existing generated exports in output directory. | +| export.overwrite | ENUM_BOOL | --overwrite / -o | Overwrites the existing generated exports in output directory. | | export.pingone.environmentID | ENUM_UUID | --pingone-export-environment-id | The ID of the PingOne environment to export. Must be a valid PingOne UUID. | | export.serviceGroup | ENUM_EXPORT_SERVICE_GROUP | --service-group / -g | Specifies the service group to export.

Options are: pingone.

Example: `pingone` | | export.services | ENUM_EXPORT_SERVICES | --services / -s | Specifies the service(s) to export. Accepts a comma-separated string to delimit multiple services.

Options are: pingfederate, pingone-mfa, pingone-platform, pingone-protect, pingone-sso.

Example: `pingone-sso,pingone-mfa,pingfederate` | diff --git a/internal/configuration/platform/export.go b/internal/configuration/platform/export.go index 40609728..a388442c 100644 --- a/internal/configuration/platform/export.go +++ b/internal/configuration/platform/export.go @@ -145,7 +145,7 @@ func initOverwriteOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "o", - Usage: "Overwrite the existing generated exports in output directory. " + + Usage: "Overwrites the existing generated exports in output directory. " + "(default false)", Value: cobraValue, NoOptDefVal: "true", // Make this flag a boolean flag diff --git a/internal/configuration/services/pingfederate.go b/internal/configuration/services/pingfederate.go index d8a9e080..53da7c23 100644 --- a/internal/configuration/services/pingfederate.go +++ b/internal/configuration/services/pingfederate.go @@ -138,7 +138,7 @@ func initInsecureTrustAllTLSOption() { Name: cobraParamName, Usage: "Trust any certificate when connecting to the PingFederate server admin API. " + "(default false)" + - "\nThis is insecure and should not be enabled outside of testing.", + "\nThis is insecure and shouldn't be enabled outside of testing.", Value: cobraValue, NoOptDefVal: "true", // Make this flag a boolean flag },