Skip to content

Commit a6e0165

Browse files
stillalearnerstillalearner
committed
fixed help section to be using oc oadp uniformly
1 parent b4d6566 commit a6e0165

22 files changed

Lines changed: 123 additions & 123 deletions

‎cmd/nabsl-request/approve.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ func NewApproveCommand(f client.Factory) *cobra.Command {
4040
Long: "Approve a pending backup storage location request to allow the controller to create the corresponding BackupStorageLocation",
4141
Args: cobra.ExactArgs(1),
4242
Example: ` # Approve a request by NABSL name (admin access required)
43-
kubectl oadp nabsl-request approve user-test-bsl
43+
oc oadp nabsl-request approve user-test-bsl
4444
4545
# Approve a request by UUID with reason
46-
kubectl oadp nabsl-request approve nacuser01-user-test-bsl-96dfa8b7-3f6f-4c8d-a168-8527b00fbed8 --reason "Approved for production use"`,
46+
oc oadp nabsl-request approve nacuser01-user-test-bsl-96dfa8b7-3f6f-4c8d-a168-8527b00fbed8 --reason "Approved for production use"`,
4747
Run: func(c *cobra.Command, args []string) {
4848
cmd.CheckError(o.Complete(args, f))
4949
cmd.CheckError(o.Validate(c, args, f))

‎cmd/nabsl-request/describe.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ func NewDescribeCommand(f client.Factory) *cobra.Command {
4444
cmd.CheckError(o.Run(c, f))
4545
},
4646
Example: ` # Describe a request by NABSL name
47-
kubectl oadp nabsl-request describe my-bsl-request
47+
oc oadp nabsl-request describe my-bsl-request
4848
4949
# Describe a request by UUID
50-
kubectl oadp nabsl-request describe nacuser01-my-bsl-96dfa8b7-3f6f-4c8d-a168-8527b00fbed8`,
50+
oc oadp nabsl-request describe nacuser01-my-bsl-96dfa8b7-3f6f-4c8d-a168-8527b00fbed8`,
5151
}
5252

5353
return c

‎cmd/nabsl-request/get.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,16 @@ func NewGetCommand(f client.Factory) *cobra.Command {
4747
cmd.CheckError(o.Run(c, f))
4848
},
4949
Example: ` # Get all backup storage location requests (admin access required)
50-
kubectl oadp nabsl-request get
50+
oc oadp nabsl-request get
5151
5252
# Get a specific request by NABSL name
53-
kubectl oadp nabsl-request get my-bsl-request
53+
oc oadp nabsl-request get my-bsl-request
5454
5555
# Get a specific request by UUID
56-
kubectl oadp nabsl-request get nacuser01-my-bsl-96dfa8b7-3f6f-4c8d-a168-8527b00fbed8
56+
oc oadp nabsl-request get nacuser01-my-bsl-96dfa8b7-3f6f-4c8d-a168-8527b00fbed8
5757
5858
# Get output in YAML format
59-
kubectl oadp nabsl-request get my-bsl-request -o yaml`,
59+
oc oadp nabsl-request get my-bsl-request -o yaml`,
6060
}
6161

6262
o.BindFlags(c.Flags())

‎cmd/nabsl-request/nabsl.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@ When users create NABSLs, approval requests are automatically generated for admi
3333
3434
Use these commands to view, approve, or reject pending NABSL requests.`,
3535
Example: ` # List all pending NABSL approval requests
36-
kubectl oadp nabsl-request get
36+
oc oadp nabsl-request get
3737
3838
# Describe a specific NABSL approval request
39-
kubectl oadp nabsl-request describe my-storage-request
39+
oc oadp nabsl-request describe my-storage-request
4040
4141
# Approve a NABSL approval request
42-
kubectl oadp nabsl-request approve my-storage-request
42+
oc oadp nabsl-request approve my-storage-request
4343
4444
# Reject a NABSL approval request
45-
kubectl oadp nabsl-request reject my-storage-request`,
45+
oc oadp nabsl-request reject my-storage-request`,
4646
}
4747

4848
c.AddCommand(

‎cmd/nabsl-request/reject.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ func NewRejectCommand(f client.Factory) *cobra.Command {
4040
Long: "Reject a pending backup storage location request to deny the user's request for a backup storage location",
4141
Args: cobra.ExactArgs(1),
4242
Example: ` # Deny a request by NABSL name (admin access required)
43-
kubectl oadp nabsl-request reject user-test-bsl --reason "Invalid configuration"
43+
oc oadp nabsl-request reject user-test-bsl --reason "Invalid configuration"
4444
4545
# Deny a request by UUID with detailed reason
46-
kubectl oadp nabsl-request reject nacuser01-user-test-bsl-96dfa8b7-3f6f-4c8d-a168-8527b00fbed8 --reason "Bucket does not exist in specified region"`,
46+
oc oadp nabsl-request reject nacuser01-user-test-bsl-96dfa8b7-3f6f-4c8d-a168-8527b00fbed8 --reason "Bucket does not exist in specified region"`,
4747
Run: func(c *cobra.Command, args []string) {
4848
cmd.CheckError(o.Complete(args, f))
4949
cmd.CheckError(o.Validate(c, args, f))

‎cmd/non-admin/backup/backup_test.go‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ func TestNonAdminBackupExamples(t *testing.T) {
259259

260260
t.Run("create examples use correct command format", func(t *testing.T) {
261261
expectedExamples := []string{
262-
"kubectl oadp nonadmin backup create",
262+
"oc oadp nonadmin backup create",
263263
"--storage-location",
264264
"--include-resources",
265265
"--exclude-resources",
@@ -365,13 +365,13 @@ func TestVerbNounOrderExamples(t *testing.T) {
365365
binaryPath := testutil.BuildCLIBinary(t)
366366

367367
t.Run("verb commands show proper examples", func(t *testing.T) {
368-
// Test that verb commands show examples with kubectl oadp prefix
368+
// Test that verb commands show examples with oc oadp prefix
369369
expectedExamples := []string{
370-
"kubectl oadp nonadmin get backup",
371-
"kubectl oadp nonadmin create backup",
372-
"kubectl oadp nonadmin delete backup",
373-
"kubectl oadp nonadmin describe backup",
374-
"kubectl oadp nonadmin logs backup",
370+
"oc oadp nonadmin get backup",
371+
"oc oadp nonadmin create backup",
372+
"oc oadp nonadmin delete backup",
373+
"oc oadp nonadmin describe backup",
374+
"oc oadp nonadmin logs backup",
375375
}
376376

377377
commands := [][]string{
@@ -390,11 +390,11 @@ func TestVerbNounOrderExamples(t *testing.T) {
390390
t.Run("verb commands with specific resources show proper examples", func(t *testing.T) {
391391
// Test that verb commands with specific resources show examples (noun-first format from underlying commands)
392392
expectedExamples := []string{
393-
"kubectl oadp nonadmin backup get",
394-
"kubectl oadp nonadmin backup create backup1",
395-
"kubectl oadp nonadmin backup delete my-backup",
396-
"kubectl oadp nonadmin backup describe my-backup",
397-
"kubectl oadp nonadmin backup logs my-backup",
393+
"oc oadp nonadmin backup get",
394+
"oc oadp nonadmin backup create backup1",
395+
"oc oadp nonadmin backup delete my-backup",
396+
"oc oadp nonadmin backup describe my-backup",
397+
"oc oadp nonadmin backup logs my-backup",
398398
}
399399

400400
commands := [][]string{
@@ -413,11 +413,11 @@ func TestVerbNounOrderExamples(t *testing.T) {
413413
t.Run("shorthand verb commands show proper examples", func(t *testing.T) {
414414
// Test that shorthand verb commands show examples
415415
expectedExamples := []string{
416-
"kubectl oadp nonadmin get backup",
417-
"kubectl oadp nonadmin create backup",
418-
"kubectl oadp nonadmin delete backup",
419-
"kubectl oadp nonadmin describe backup",
420-
"kubectl oadp nonadmin logs backup",
416+
"oc oadp nonadmin get backup",
417+
"oc oadp nonadmin create backup",
418+
"oc oadp nonadmin delete backup",
419+
"oc oadp nonadmin describe backup",
420+
"oc oadp nonadmin logs backup",
421421
}
422422

423423
commands := [][]string{
@@ -502,9 +502,9 @@ func TestNonAdminBackupDeleteAllFlagExamples(t *testing.T) {
502502
t.Run("delete help has examples section", func(t *testing.T) {
503503
// Test that examples section exists and shows various delete patterns
504504
expectedExamples := []string{
505-
"kubectl oadp nonadmin backup delete my-backup",
506-
"kubectl oadp nonadmin backup delete --all",
507-
"kubectl oadp nonadmin backup delete my-backup --confirm",
505+
"oc oadp nonadmin backup delete my-backup",
506+
"oc oadp nonadmin backup delete --all",
507+
"oc oadp nonadmin backup delete my-backup --confirm",
508508
}
509509

510510
testutil.TestHelpCommand(t, binaryPath,

‎cmd/non-admin/backup/create.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,22 @@ func NewCreateCommand(f client.Factory, use string) *cobra.Command {
5050
cmd.CheckError(o.Run(c, f))
5151
},
5252
Example: ` # Create a simple backup of all resources in the current namespace.
53-
kubectl oadp nonadmin backup create backup1
53+
oc oadp nonadmin backup create backup1
5454
5555
# Create a backup with specific resource types.
56-
kubectl oadp nonadmin backup create backup2 --include-resources deployments,services
56+
oc oadp nonadmin backup create backup2 --include-resources deployments,services
5757
5858
# Create a backup with label selector.
59-
kubectl oadp nonadmin backup create backup3 --selector app=myapp
59+
oc oadp nonadmin backup create backup3 --selector app=myapp
6060
6161
# Create a backup with snapshots and TTL.
62-
kubectl oadp nonadmin backup create backup4 --snapshot-volumes --ttl 720h
62+
oc oadp nonadmin backup create backup4 --snapshot-volumes --ttl 720h
6363
6464
# Create a backup with specific storage location.
65-
kubectl oadp nonadmin backup create backup5 --storage-location my-nabsl
65+
oc oadp nonadmin backup create backup5 --storage-location my-nabsl
6666
6767
# View the YAML for a backup without sending it to the server.
68-
kubectl oadp nonadmin backup create backup6 -o yaml`,
68+
oc oadp nonadmin backup create backup6 -o yaml`,
6969
}
7070

7171
o.BindFlags(c.Flags())

‎cmd/non-admin/backup/delete.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,16 @@ func NewDeleteCommand(f client.Factory, use string) *cobra.Command {
5858
cmd.CheckError(o.Run())
5959
},
6060
Example: ` # Delete a specific backup
61-
kubectl oadp nonadmin backup delete my-backup
61+
oc oadp nonadmin backup delete my-backup
6262
6363
# Delete multiple backups
64-
kubectl oadp nonadmin backup delete backup1 backup2 backup3
64+
oc oadp nonadmin backup delete backup1 backup2 backup3
6565
6666
# Delete all backups in the current namespace
67-
kubectl oadp nonadmin backup delete --all
67+
oc oadp nonadmin backup delete --all
6868
6969
# Delete without confirmation prompt
70-
kubectl oadp nonadmin backup delete my-backup --confirm`,
70+
oc oadp nonadmin backup delete my-backup --confirm`,
7171
}
7272

7373
o.BindFlags(c.Flags())
@@ -204,7 +204,7 @@ func (o *DeleteOptions) Run() error {
204204
fmt.Println()
205205
fmt.Println("ℹ️ Note: The actual backup deletion will be performed asynchronously by the OADP controller.")
206206
fmt.Println(" This may take some time to complete. You can monitor progress with:")
207-
fmt.Printf(" kubectl get nonadminbackup -n %s\n", o.Namespace)
207+
fmt.Printf(" oc get nonadminbackup -n %s\n", o.Namespace)
208208
}
209209

210210
if len(failed) > 0 {

‎cmd/non-admin/backup/describe.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ func NewDescribeCommand(f client.Factory, use string) *cobra.Command {
8383

8484
return nil
8585
},
86-
Example: ` kubectl oadp nonadmin backup describe my-backup
87-
kubectl oadp nonadmin backup describe my-backup --details
88-
kubectl oadp nonadmin backup describe my-backup --details --request-timeout=30m`,
86+
Example: ` oc oadp nonadmin backup describe my-backup
87+
oc oadp nonadmin backup describe my-backup --details
88+
oc oadp nonadmin backup describe my-backup --details --request-timeout=30m`,
8989
}
9090

9191
c.Flags().DurationVar(&requestTimeout, "request-timeout", 0, fmt.Sprintf("The length of time to wait before giving up on a single server request (e.g., 30s, 5m, 1h). Overrides %s env var. Default: %v", shared.TimeoutEnvVar, shared.DefaultHTTPTimeout))

‎cmd/non-admin/backup/get.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,16 +87,16 @@ func NewGetCommand(f client.Factory, use string) *cobra.Command {
8787
}
8888
},
8989
Example: ` # Get all non-admin backups in the current namespace
90-
kubectl oadp nonadmin backup get
90+
oc oadp nonadmin backup get
9191
9292
# Get a specific non-admin backup
93-
kubectl oadp nonadmin backup get my-backup
93+
oc oadp nonadmin backup get my-backup
9494
9595
# Get backups in YAML format
96-
kubectl oadp nonadmin backup get -o yaml
96+
oc oadp nonadmin backup get -o yaml
9797
9898
# Get a specific backup in JSON format
99-
kubectl oadp nonadmin backup get my-backup -o json`,
99+
oc oadp nonadmin backup get my-backup -o json`,
100100
}
101101

102102
output.BindFlags(c.Flags())

0 commit comments

Comments
 (0)