Merge pull request #848 from joshbranham/standardize-clusterid-flag-pullsecret

Update cluster validate-pull-secret-ext to use --cluster-id flag

Author: openshift-merge-bot[bot]

cmd/cluster/validatepullsecretext.go

@@ -55,16 +55,16 @@ type validatePullSecretExtOptions struct {
 
 const VPSExample string = `
 	# Compare OCM Access-Token, OCM Registry-Credentials, and OCM Account Email against cluster's pull secret
-	osdctl cluster validate-pull-secret-ext ${CLUSTER_ID} --reason "OSD-XYZ"
+	osdctl cluster validate-pull-secret-ext --cluster-id ${CLUSTER_ID} --reason "OSD-XYZ"
 
 	# Exclude Access-Token, and Registry-Credential checks...
-	osdctl cluster validate-pull-secret-ext ${CLUSTER_ID} --reason "OSD-XYZ" --skip-access-token --skip-registry-creds
+	osdctl cluster validate-pull-secret-ext --cluster-id ${CLUSTER_ID} --reason "OSD-XYZ" --skip-access-token --skip-registry-creds
 `
 
 func newCmdValidatePullSecretExt() *cobra.Command {
 	ops := newValidatePullSecretExtOptions()
 	validatePullSecretCmd := &cobra.Command{
-		Use:   "validate-pull-secret-ext [CLUSTER_ID]",
+		Use:   "validate-pull-secret-ext --cluster-id $CLUSTER_ID",
 		Short: "Extended checks to confirm pull-secret data is synced with current OCM data",
 		Long: `
 	Attempts to validate if a cluster's pull-secret auth values are in sync with the account's email, 
@@ -73,13 +73,13 @@ func newCmdValidatePullSecretExt() *cobra.Command {
 	Region Lead permissions are required to view and validate the OCM AccessToken. 
 `,
 		Example:           VPSExample,
-		Args:              cobra.ExactArgs(1),
 		DisableAutoGenTag: true,
-		PreRun:            func(cmd *cobra.Command, args []string) { cmdutil.CheckErr(ops.preRun(cmd, args)) },
+		PreRun:            func(cmd *cobra.Command, args []string) { cmdutil.CheckErr(ops.preRun(cmd)) },
 		Run: func(cmd *cobra.Command, args []string) {
 			cmdutil.CheckErr(ops.run())
 		},
 	}
+	validatePullSecretCmd.Flags().StringVarP(&ops.clusterID, "cluster-id", "C", "", "Provide internal ID of the cluster")
 	validatePullSecretCmd.Flags().StringVar(&ops.reason, "reason", "", "Mandatory reason for this command to be run (usually includes an OHSS or PD ticket)")
 	validatePullSecretCmd.Flags().StringVarP(&ops.verboseLevel, "log-level", "l", "info", "debug, info, warn, error. (default=info)")
 	validatePullSecretCmd.Flags().Bool("skip-registry-creds", false, "Exclude OCM Registry Credentials checks against cluster secret")
@@ -93,11 +93,7 @@ func newValidatePullSecretExtOptions() *validatePullSecretExtOptions {
 	return &validatePullSecretExtOptions{}
 }
 
-func (o *validatePullSecretExtOptions) preRun(cmd *cobra.Command, args []string) error {
-	if len(args) != 1 {
-		return cmdutil.UsageErrorf(cmd, "Required 1 positional arg for 'Cluster ID'")
-	}
-	o.clusterID = args[0]
+func (o *validatePullSecretExtOptions) preRun(cmd *cobra.Command) error {
 	o.useAccessToken = true
 	o.useRegCreds = true
 

docs/README.md

@@ -77,7 +77,7 @@
     - `status --cluster-id <cluster-identifier>` - Shows the support status of a specified cluster
   - `transfer-owner` - Transfer cluster ownership to a new user (to be done by Region Lead)
   - `validate-pull-secret --cluster-id <cluster-identifier>` - Checks if the pull secret email matches the owner email
-  - `validate-pull-secret-ext [CLUSTER_ID]` - Extended checks to confirm pull-secret data is synced with current OCM data
+  - `validate-pull-secret-ext --cluster-id $CLUSTER_ID` - Extended checks to confirm pull-secret data is synced with current OCM data
   - `verify-dns --cluster-id <cluster-id>` - Verify DNS resolution for HCP cluster public endpoints
 - `cost` - Cost Management related utilities
   - `carbon-report` - Generate carbon emissions report csv to stdout for a given AWS Account and Usage Period
@@ -2334,14 +2334,15 @@ osdctl cluster validate-pull-secret --cluster-id <cluster-identifier> [flags]
 
 
 ```
-osdctl cluster validate-pull-secret-ext [CLUSTER_ID] [flags]
+osdctl cluster validate-pull-secret-ext --cluster-id $CLUSTER_ID [flags]
 ```
 
 #### Flags
 
 ```
       --as string                        Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
       --cluster string                   The name of the kubeconfig cluster to use
+  -C, --cluster-id string                Provide internal ID of the cluster
       --context string                   The name of the kubeconfig context to use
   -h, --help                             help for validate-pull-secret-ext
       --insecure-skip-tls-verify         If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

docs/osdctl_cluster_validate-pull-secret-ext.md

@@ -12,24 +12,25 @@ Extended checks to confirm pull-secret data is synced with current OCM data
 
 
 ```
-osdctl cluster validate-pull-secret-ext [CLUSTER_ID] [flags]
+osdctl cluster validate-pull-secret-ext --cluster-id $CLUSTER_ID [flags]
 ```
 
 ### Examples
 
 ```
 
 	# Compare OCM Access-Token, OCM Registry-Credentials, and OCM Account Email against cluster's pull secret
-	osdctl cluster validate-pull-secret-ext ${CLUSTER_ID} --reason "OSD-XYZ"
+	osdctl cluster validate-pull-secret-ext --cluster-id ${CLUSTER_ID} --reason "OSD-XYZ"
 
 	# Exclude Access-Token, and Registry-Credential checks...
-	osdctl cluster validate-pull-secret-ext ${CLUSTER_ID} --reason "OSD-XYZ" --skip-access-token --skip-registry-creds
+	osdctl cluster validate-pull-secret-ext --cluster-id ${CLUSTER_ID} --reason "OSD-XYZ" --skip-access-token --skip-registry-creds
 
 ```
 
 ### Options
 
 ```
+  -C, --cluster-id string     Provide internal ID of the cluster
   -h, --help                  help for validate-pull-secret-ext
   -l, --log-level string      debug, info, warn, error. (default=info) (default "info")
       --reason string         Mandatory reason for this command to be run (usually includes an OHSS or PD ticket)