Skip to content

Commit 1bad662

Browse files
committed
chore(docs): run docs ./docs/command/
this is not run per-commit, and as such has a large drift to our current setup. should we use these docs? or remove them altogether
1 parent bb55118 commit 1bad662

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+506
-158
lines changed

docs/command/osdctl.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ osdctl [flags]
3232

3333
### SEE ALSO
3434

35+
* [osdctl aao](osdctl_aao.md) - AWS Account Operator Debugging Utilities
3536
* [osdctl account](osdctl_account.md) - AWS Account related utilities
37+
* [osdctl cluster](osdctl_cluster.md) - Provides vitals of an AWS cluster
3638
* [osdctl clusterdeployment](osdctl_clusterdeployment.md) - cluster deployment related utilities
3739
* [osdctl completion](osdctl_completion.md) - Output shell completion code for the specified shell (bash or zsh)
3840
* [osdctl cost](osdctl_cost.md) - Cost Management related utilities
@@ -41,4 +43,5 @@ osdctl [flags]
4143
* [osdctl network](osdctl_network.md) - network related utilities
4244
* [osdctl options](osdctl_options.md) - Print the list of flags inherited by all commands
4345
* [osdctl servicelog](osdctl_servicelog.md) - OCM/Hive Service log
46+
* [osdctl sts](osdctl_sts.md) - STS related utilities
4447

docs/command/osdctl_aao.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## osdctl aao
2+
3+
AWS Account Operator Debugging Utilities
4+
5+
```
6+
osdctl aao [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for aao
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--alsologtostderr log to standard error as well as files
19+
--as string Username to impersonate for the operation
20+
--cluster string The name of the kubeconfig cluster to use
21+
--context string The name of the kubeconfig context to use
22+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
23+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
24+
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
25+
--log_dir string If non-empty, write log files in this directory
26+
--logtostderr log to standard error instead of files
27+
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
28+
-s, --server string The address and port of the Kubernetes API server
29+
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
30+
-v, --v Level log level for V logs
31+
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
32+
```
33+
34+
### SEE ALSO
35+
36+
* [osdctl](osdctl.md) - OSD CLI
37+
* [osdctl aao pool](osdctl_aao_pool.md) - Get the status of the AWS Account Operator AccountPool
38+

docs/command/osdctl_aao_pool.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## osdctl aao pool
2+
3+
Get the status of the AWS Account Operator AccountPool
4+
5+
```
6+
osdctl aao pool [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for pool
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--alsologtostderr log to standard error as well as files
19+
--as string Username to impersonate for the operation
20+
--cluster string The name of the kubeconfig cluster to use
21+
--context string The name of the kubeconfig context to use
22+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
23+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
24+
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
25+
--log_dir string If non-empty, write log files in this directory
26+
--logtostderr log to standard error instead of files
27+
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
28+
-s, --server string The address and port of the Kubernetes API server
29+
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
30+
-v, --v Level log level for V logs
31+
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
32+
```
33+
34+
### SEE ALSO
35+
36+
* [osdctl aao](osdctl_aao.md) - AWS Account Operator Debugging Utilities
37+

docs/command/osdctl_account.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
AWS Account related utilities
44

5-
### Synopsis
6-
7-
AWS Account related utilities
8-
95
```
106
osdctl account [flags]
117
```
@@ -44,6 +40,7 @@ osdctl account [flags]
4440
* [osdctl account generate-secret](osdctl_account_generate-secret.md) - Generate IAM credentials secret
4541
* [osdctl account get](osdctl_account_get.md) - Get resources
4642
* [osdctl account list](osdctl_account_list.md) - List resources
43+
* [osdctl account mgmt](osdctl_account_mgmt.md) - AWS Account Management
4744
* [osdctl account reset](osdctl_account_reset.md) - Reset AWS Account CR
4845
* [osdctl account rotate-secret](osdctl_account_rotate-secret.md) - Rotate IAM credentials secret
4946
* [osdctl account servicequotas](osdctl_account_servicequotas.md) - Interact with AWS service-quotas

docs/command/osdctl_account_clean-velero-snapshots.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Cleans up S3 buckets whose name start with managed-velero
44

5-
### Synopsis
6-
7-
Cleans up S3 buckets whose name start with managed-velero
8-
95
```
106
osdctl account clean-velero-snapshots [flags]
117
```

docs/command/osdctl_account_cli.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Generate temporary AWS CLI credentials on demand
44

5-
### Synopsis
6-
7-
Generate temporary AWS CLI credentials on demand
8-
95
```
106
osdctl account cli [flags]
117
```

docs/command/osdctl_account_console.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Generate an AWS console URL on the fly
44

5-
### Synopsis
6-
7-
Generate an AWS console URL on the fly
8-
95
```
106
osdctl account console [flags]
117
```
@@ -22,6 +18,7 @@ osdctl account console [flags]
2218
-C, --cluster-id string The Internal Cluster ID from Hive to create AWS console URL for
2319
-d, --duration int The duration of the console session. Default value is 3600 seconds(1 hour) (default 3600)
2420
-h, --help help for console
21+
--launch Launch web browser directly
2522
--verbose Verbose output
2623
```
2724

docs/command/osdctl_account_generate-secret.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Generate IAM credentials secret
44

5-
### Synopsis
6-
7-
Generate IAM credentials secret
8-
95
```
106
osdctl account generate-secret <IAM User name> [flags]
117
```

docs/command/osdctl_account_get.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Get resources
44

5-
### Synopsis
6-
7-
Get resources
8-
95
```
106
osdctl account get [flags]
117
```

docs/command/osdctl_account_get_account-claim.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Get AWS Account Claim CR
44

5-
### Synopsis
6-
7-
Get AWS Account Claim CR
8-
95
```
106
osdctl account get account-claim [flags]
117
```

0 commit comments

Comments
 (0)