diff --git a/doc/ovhcloud.md b/doc/ovhcloud.md index 1045801..6fdea2a 100644 --- a/doc/ovhcloud.md +++ b/doc/ovhcloud.md @@ -101,7 +101,7 @@ Below is the full list of primary sub‑commands available at the time of writin * [ovhcloud location](ovhcloud_location.md) - Retrieve information and manage your Location services * [ovhcloud login](ovhcloud_login.md) - Login to your OVHcloud account to create API credentials * [ovhcloud nutanix](ovhcloud_nutanix.md) - Retrieve information and manage your Nutanix services -* [ovhcloud okms](ovhcloud_okms.md) - Retrieve information and manage your Okms services +* [ovhcloud okms](ovhcloud_okms.md) - Retrieve information and manage your OKMS (Key Management Services) * [ovhcloud overthebox](ovhcloud_overthebox.md) - Retrieve information and manage your OverTheBox services * [ovhcloud ovhcloudconnect](ovhcloud_ovhcloudconnect.md) - Retrieve information and manage your OvhCloudConnect services * [ovhcloud pack-xdsl](ovhcloud_pack-xdsl.md) - Retrieve information and manage your PackXDSL services diff --git a/doc/ovhcloud_cloud_rancher.md b/doc/ovhcloud_cloud_rancher.md index e20d36e..945b39c 100644 --- a/doc/ovhcloud_cloud_rancher.md +++ b/doc/ovhcloud_cloud_rancher.md @@ -23,6 +23,8 @@ Manage Rancher services in the given cloud project ### SEE ALSO * [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe +* [ovhcloud cloud rancher create](ovhcloud_cloud_rancher_create.md) - Create a new Rancher service +* [ovhcloud cloud rancher delete](ovhcloud_cloud_rancher_delete.md) - Delete a specific Rancher service * [ovhcloud cloud rancher edit](ovhcloud_cloud_rancher_edit.md) - Edit the given Rancher service * [ovhcloud cloud rancher get](ovhcloud_cloud_rancher_get.md) - Get a specific Rancher service * [ovhcloud cloud rancher list](ovhcloud_cloud_rancher_list.md) - List Rancher services diff --git a/doc/ovhcloud_cloud_rancher_create.md b/doc/ovhcloud_cloud_rancher_create.md new file mode 100644 index 0000000..3803c60 --- /dev/null +++ b/doc/ovhcloud_cloud_rancher_create.md @@ -0,0 +1,78 @@ +## ovhcloud cloud rancher create + +Create a new Rancher service + +### Synopsis + +Use this command to create a managed Rancher service in the given public cloud project. +There are three ways to define the creation parameters: + +1. Using only CLI flags: + + ovhcloud cloud rancher create --name MyNewRancher --plan OVHCLOUD_EDITION --version 2.11.3 + +2. Using a configuration file: + + First you can generate an example of installation file using the following command: + + ovhcloud cloud rancher create --init-file ./params.json + + You will be able to choose from several examples of parameters. Once an example has been selected, the content is written in the given file. + After editing the file to set the correct creation parameters, run: + + ovhcloud cloud rancher create --from-file ./params.json + + Note that you can also pipe the content of the parameters file, like the following: + + cat ./params.json | ovhcloud cloud rancher create + + In both cases, you can override the parameters in the given file using command line flags, for example: + + ovhcloud cloud rancher create --from-file ./params.json --name NameOverriden + +3. Using your default text editor: + + ovhcloud cloud rancher create --editor + + You will be able to choose from several examples of parameters. Once an example has been selected, the CLI will open your + default text editor to update the parameters. When saving the file, the creation will start. + + Note that it is also possible to override values in the presented examples using command line flags like the following: + + ovhcloud cloud rancher create --editor --region BHS5 + + +``` +ovhcloud cloud rancher create [flags] +``` + +### Options + +``` + --editor Use a text editor to define parameters + --from-file string File containing parameters + -h, --help help for create + --iam-auth-enabled Allow Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access + --init-file string Create a file with example parameters + --name string Name of the managed Rancher service + --plan string Plan of the managed Rancher service (available plans can be listed using 'cloud reference rancher list-plans' command) + --replace Replace parameters file if it already exists + --version string Version of the managed Rancher service (available versions can be listed using 'cloud reference rancher list-versions' command) +``` + +### Options inherited from parent commands + +``` + --cloud-project string Cloud project ID + -d, --debug Activate debug mode (will log all HTTP requests details) + -f, --format string Output value according to given format (expression using gval format) + -e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution + -i, --interactive Interactive output + -j, --json Output in JSON + -y, --yaml Output in YAML +``` + +### SEE ALSO + +* [ovhcloud cloud rancher](ovhcloud_cloud_rancher.md) - Manage Rancher services in the given cloud project + diff --git a/doc/ovhcloud_cloud_rancher_delete.md b/doc/ovhcloud_cloud_rancher_delete.md new file mode 100644 index 0000000..8df2674 --- /dev/null +++ b/doc/ovhcloud_cloud_rancher_delete.md @@ -0,0 +1,30 @@ +## ovhcloud cloud rancher delete + +Delete a specific Rancher service + +``` +ovhcloud cloud rancher delete [flags] +``` + +### Options + +``` + -h, --help help for delete +``` + +### Options inherited from parent commands + +``` + --cloud-project string Cloud project ID + -d, --debug Activate debug mode (will log all HTTP requests details) + -f, --format string Output value according to given format (expression using gval format) + -e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution + -i, --interactive Interactive output + -j, --json Output in JSON + -y, --yaml Output in YAML +``` + +### SEE ALSO + +* [ovhcloud cloud rancher](ovhcloud_cloud_rancher.md) - Manage Rancher services in the given cloud project + diff --git a/doc/ovhcloud_cloud_reference.md b/doc/ovhcloud_cloud_reference.md index 205f5b4..f176dd1 100644 --- a/doc/ovhcloud_cloud_reference.md +++ b/doc/ovhcloud_cloud_reference.md @@ -26,4 +26,5 @@ Fetch reference data in the given cloud project * [ovhcloud cloud reference container-registry](ovhcloud_cloud_reference_container-registry.md) - Fetch container registry reference data in the given cloud project * [ovhcloud cloud reference list-flavors](ovhcloud_cloud_reference_list-flavors.md) - List available flavors in the given cloud project * [ovhcloud cloud reference list-images](ovhcloud_cloud_reference_list-images.md) - List available images in the given cloud project +* [ovhcloud cloud reference rancher](ovhcloud_cloud_reference_rancher.md) - Fetch Rancher reference data in the given cloud project diff --git a/doc/ovhcloud_cloud_reference_rancher.md b/doc/ovhcloud_cloud_reference_rancher.md new file mode 100644 index 0000000..952097a --- /dev/null +++ b/doc/ovhcloud_cloud_reference_rancher.md @@ -0,0 +1,28 @@ +## ovhcloud cloud reference rancher + +Fetch Rancher reference data in the given cloud project + +### Options + +``` + -h, --help help for rancher +``` + +### Options inherited from parent commands + +``` + --cloud-project string Cloud project ID + -d, --debug Activate debug mode (will log all HTTP requests details) + -f, --format string Output value according to given format (expression using gval format) + -e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution + -i, --interactive Interactive output + -j, --json Output in JSON + -y, --yaml Output in YAML +``` + +### SEE ALSO + +* [ovhcloud cloud reference](ovhcloud_cloud_reference.md) - Fetch reference data in the given cloud project +* [ovhcloud cloud reference rancher list-plans](ovhcloud_cloud_reference_rancher_list-plans.md) - List available Rancher plans in the given cloud project +* [ovhcloud cloud reference rancher list-versions](ovhcloud_cloud_reference_rancher_list-versions.md) - List available Rancher versions in the given cloud project + diff --git a/doc/ovhcloud_cloud_reference_rancher_list-plans.md b/doc/ovhcloud_cloud_reference_rancher_list-plans.md new file mode 100644 index 0000000..3e057d0 --- /dev/null +++ b/doc/ovhcloud_cloud_reference_rancher_list-plans.md @@ -0,0 +1,32 @@ +## ovhcloud cloud reference rancher list-plans + +List available Rancher plans in the given cloud project + +``` +ovhcloud cloud reference rancher list-plans [flags] +``` + +### Options + +``` + --filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax' + -h, --help help for list-plans + -r, --rancher-id string Rancher service ID to filter available plans +``` + +### Options inherited from parent commands + +``` + --cloud-project string Cloud project ID + -d, --debug Activate debug mode (will log all HTTP requests details) + -f, --format string Output value according to given format (expression using gval format) + -e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution + -i, --interactive Interactive output + -j, --json Output in JSON + -y, --yaml Output in YAML +``` + +### SEE ALSO + +* [ovhcloud cloud reference rancher](ovhcloud_cloud_reference_rancher.md) - Fetch Rancher reference data in the given cloud project + diff --git a/doc/ovhcloud_cloud_reference_rancher_list-versions.md b/doc/ovhcloud_cloud_reference_rancher_list-versions.md new file mode 100644 index 0000000..b7a9289 --- /dev/null +++ b/doc/ovhcloud_cloud_reference_rancher_list-versions.md @@ -0,0 +1,32 @@ +## ovhcloud cloud reference rancher list-versions + +List available Rancher versions in the given cloud project + +``` +ovhcloud cloud reference rancher list-versions [flags] +``` + +### Options + +``` + --filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax' + -h, --help help for list-versions + -r, --rancher-id string Rancher service ID to filter available versions +``` + +### Options inherited from parent commands + +``` + --cloud-project string Cloud project ID + -d, --debug Activate debug mode (will log all HTTP requests details) + -f, --format string Output value according to given format (expression using gval format) + -e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution + -i, --interactive Interactive output + -j, --json Output in JSON + -y, --yaml Output in YAML +``` + +### SEE ALSO + +* [ovhcloud cloud reference rancher](ovhcloud_cloud_reference_rancher.md) - Fetch Rancher reference data in the given cloud project + diff --git a/doc/ovhcloud_okms.md b/doc/ovhcloud_okms.md index 4cde705..639fb34 100644 --- a/doc/ovhcloud_okms.md +++ b/doc/ovhcloud_okms.md @@ -1,6 +1,6 @@ ## ovhcloud okms -Retrieve information and manage your Okms services +Retrieve information and manage your OKMS (Key Management Services) ### Options @@ -22,6 +22,6 @@ Retrieve information and manage your Okms services ### SEE ALSO * [ovhcloud](ovhcloud.md) - CLI to manage your OVHcloud services -* [ovhcloud okms get](ovhcloud_okms_get.md) - Retrieve information of a specific Okms +* [ovhcloud okms get](ovhcloud_okms_get.md) - Retrieve information of a specific OKMS * [ovhcloud okms list](ovhcloud_okms_list.md) - List your Okms services diff --git a/doc/ovhcloud_okms_get.md b/doc/ovhcloud_okms_get.md index 733c113..62e58bd 100644 --- a/doc/ovhcloud_okms_get.md +++ b/doc/ovhcloud_okms_get.md @@ -1,6 +1,6 @@ ## ovhcloud okms get -Retrieve information of a specific Okms +Retrieve information of a specific OKMS ``` ovhcloud okms get [flags] @@ -25,5 +25,5 @@ ovhcloud okms get [flags] ### SEE ALSO -* [ovhcloud okms](ovhcloud_okms.md) - Retrieve information and manage your Okms services +* [ovhcloud okms](ovhcloud_okms.md) - Retrieve information and manage your OKMS (Key Management Services) diff --git a/doc/ovhcloud_okms_list.md b/doc/ovhcloud_okms_list.md index ddcd284..cb08eb3 100644 --- a/doc/ovhcloud_okms_list.md +++ b/doc/ovhcloud_okms_list.md @@ -26,5 +26,5 @@ ovhcloud okms list [flags] ### SEE ALSO -* [ovhcloud okms](ovhcloud_okms.md) - Retrieve information and manage your Okms services +* [ovhcloud okms](ovhcloud_okms.md) - Retrieve information and manage your OKMS (Key Management Services) diff --git a/internal/cmd/okms.go b/internal/cmd/okms.go index 4db0902..b847aa2 100644 --- a/internal/cmd/okms.go +++ b/internal/cmd/okms.go @@ -12,7 +12,7 @@ import ( func init() { okmsCmd := &cobra.Command{ Use: "okms", - Short: "Retrieve information and manage your Okms services", + Short: "Retrieve information and manage your OKMS (Key Management Services)", } // Command to list Okms services @@ -27,7 +27,7 @@ func init() { // Command to get a single Okms okmsCmd.AddCommand(&cobra.Command{ Use: "get ", - Short: "Retrieve information of a specific Okms", + Short: "Retrieve information of a specific OKMS", Args: cobra.ExactArgs(1), Run: okms.GetOkms, })