Adding/updating documentation
The `update-golden` make target generates updated documentation for each command, but has not been run for recently merged changesets. This leads to out of date documentation, and requires remediation in two steps: 1. (This patch) update documentation 2. Update gates to determine if commands have changed that warrants new documentation, and prevent patches from being merged without running `make update-golden` first. This can be added to tools/git_diff_check Change-Id: Ide31f24caf8818e811d15397616805ed79bdea10 Signed-off-by: Alexander Hughes <Alexander.Hughes@pm.me>
This commit is contained in:
parent
4af678018c
commit
15d2684c50
@ -26,10 +26,12 @@ Manage the airshipctl config file
|
|||||||
* [airshipctl config get-cluster](airshipctl_config_get-cluster.md) - Get cluster information from the airshipctl config
|
* [airshipctl config get-cluster](airshipctl_config_get-cluster.md) - Get cluster information from the airshipctl config
|
||||||
* [airshipctl config get-context](airshipctl_config_get-context.md) - Get context information from the airshipctl config
|
* [airshipctl config get-context](airshipctl_config_get-context.md) - Get context information from the airshipctl config
|
||||||
* [airshipctl config get-credential](airshipctl_config_get-credential.md) - Get user credentials from the airshipctl config
|
* [airshipctl config get-credential](airshipctl_config_get-credential.md) - Get user credentials from the airshipctl config
|
||||||
|
* [airshipctl config get-management-config](airshipctl_config_get-management-config.md) - View a management config or all management configs defined in the airshipctl config
|
||||||
* [airshipctl config import](airshipctl_config_import.md) - Merge information from a kubernetes config file
|
* [airshipctl config import](airshipctl_config_import.md) - Merge information from a kubernetes config file
|
||||||
* [airshipctl config init](airshipctl_config_init.md) - Generate initial configuration files for airshipctl
|
* [airshipctl config init](airshipctl_config_init.md) - Generate initial configuration files for airshipctl
|
||||||
* [airshipctl config set-cluster](airshipctl_config_set-cluster.md) - Manage clusters
|
* [airshipctl config set-cluster](airshipctl_config_set-cluster.md) - Manage clusters
|
||||||
* [airshipctl config set-context](airshipctl_config_set-context.md) - Manage contexts
|
* [airshipctl config set-context](airshipctl_config_set-context.md) - Manage contexts
|
||||||
* [airshipctl config set-credentials](airshipctl_config_set-credentials.md) - Manage user credentials
|
* [airshipctl config set-credentials](airshipctl_config_set-credentials.md) - Manage user credentials
|
||||||
|
* [airshipctl config set-management-config](airshipctl_config_set-management-config.md) - Modify an out-of-band management configuration
|
||||||
* [airshipctl config use-context](airshipctl_config_use-context.md) - Switch to a different context
|
* [airshipctl config use-context](airshipctl_config_use-context.md) - Switch to a different context
|
||||||
|
|
||||||
|
42
docs/source/cli/airshipctl_config_get-management-config.md
Normal file
42
docs/source/cli/airshipctl_config_get-management-config.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
## airshipctl config get-management-config
|
||||||
|
|
||||||
|
View a management config or all management configs defined in the airshipctl config
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
View a management config or all management configs defined in the airshipctl config
|
||||||
|
|
||||||
|
```
|
||||||
|
airshipctl config get-management-config [NAME] [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
# View all defined management configurations
|
||||||
|
airshipctl config get-management-configs
|
||||||
|
|
||||||
|
# View a specific management configuration named "default"
|
||||||
|
airshipctl config get-management-config default
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for get-management-config
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
--airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config")
|
||||||
|
--debug enable verbose output
|
||||||
|
--kubeconfig string Path to kubeconfig associated with airshipctl configuration. (default "$HOME/.airship/kubeconfig")
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file
|
||||||
|
|
33
docs/source/cli/airshipctl_config_set-management-config.md
Normal file
33
docs/source/cli/airshipctl_config_set-management-config.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
## airshipctl config set-management-config
|
||||||
|
|
||||||
|
Modify an out-of-band management configuration
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Modify an out-of-band management configuration
|
||||||
|
|
||||||
|
```
|
||||||
|
airshipctl config set-management-config NAME [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for set-management-config
|
||||||
|
--insecure Ignore SSL certificate verification on out-of-band management requests
|
||||||
|
--management-type string Set the out-of-band management type (default "redfish")
|
||||||
|
--use-proxy Use the proxy configuration specified in the local environment (default true)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
--airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config")
|
||||||
|
--debug enable verbose output
|
||||||
|
--kubeconfig string Path to kubeconfig associated with airshipctl configuration. (default "$HOME/.airship/kubeconfig")
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file
|
||||||
|
|
Loading…
x
Reference in New Issue
Block a user