Skip to content

Commit

Permalink
chore(docs): Update autogen docs with --skip-tls-verify flag.
Browse files Browse the repository at this point in the history
Signed-off-by: spbsoluble <1661003+spbsoluble@users.noreply.github.com>
  • Loading branch information
spbsoluble committed Dec 12, 2024
1 parent d18d4e6 commit d715266
Show file tree
Hide file tree
Showing 51 changed files with 105 additions and 54 deletions.
5 changes: 3 additions & 2 deletions docs/kfutil.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ A CLI wrapper around the Keyfactor Platform API.
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -37,12 +38,12 @@ A CLI wrapper around the Keyfactor Platform API.
* [kfutil helm](kfutil_helm.md) - Helm utilities for configuring Keyfactor Helm charts
* [kfutil import](kfutil_import.md) - Keyfactor instance import utilities.
* [kfutil login](kfutil_login.md) - User interactive login to Keyfactor. Stores the credentials in the config file '$HOME/.keyfactor/command_config.json'.
* [kfutil logout](kfutil_logout.md) - Removes the credentials file '$HOME/.keyfactor/command_config.json'.
* [kfutil logout](kfutil_logout.md) - Unsets environment variables and removes the stored credentials file.
* [kfutil orchs](kfutil_orchs.md) - Keyfactor agents/orchestrators APIs and utilities.
* [kfutil pam](kfutil_pam.md) - Keyfactor PAM Provider APIs.
* [kfutil status](kfutil_status.md) - List the status of Keyfactor services.
* [kfutil store-types](kfutil_store-types.md) - Keyfactor certificate store types APIs and utilities.
* [kfutil stores](kfutil_stores.md) - Keyfactor certificate stores APIs and utilities.
* [kfutil version](kfutil_version.md) - Shows version of kfutil

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ See each sub-command's help for details on how to use the generated script.
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -44,4 +45,4 @@ See each sub-command's help for details on how to use the generated script.
* [kfutil completion powershell](kfutil_completion_powershell.md) - Generate the autocompletion script for powershell
* [kfutil completion zsh](kfutil_completion_zsh.md) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ kfutil completion bash
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -63,4 +64,4 @@ kfutil completion bash

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ kfutil completion fish [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -54,4 +55,4 @@ kfutil completion fish [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ kfutil completion powershell [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -51,4 +52,4 @@ kfutil completion powershell [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ kfutil completion zsh [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -65,4 +66,4 @@ kfutil completion zsh [flags]

* [kfutil completion](kfutil_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -40,4 +41,4 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
* [kfutil containers get](kfutil_containers_get.md) - Get certificate store container by ID or name.
* [kfutil containers list](kfutil_containers_list.md) - List certificate store containers.

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_containers_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ kfutil containers get [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -43,4 +44,4 @@ kfutil containers get [flags]

* [kfutil containers](kfutil_containers.md) - Keyfactor certificate store container API and utilities.

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_containers_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ kfutil containers list [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -42,4 +43,4 @@ kfutil containers list [flags]

* [kfutil containers](kfutil_containers.md) - Keyfactor certificate store container API and utilities.

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ kfutil export [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -54,4 +55,4 @@ kfutil export [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ kubectl helm uo | helm install -f - keyfactor-universal-orchestrator keyfactor/k
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -45,4 +46,4 @@ kubectl helm uo | helm install -f - keyfactor-universal-orchestrator keyfactor/k
* [kfutil](kfutil.md) - Keyfactor CLI utilities
* [kfutil helm uo](kfutil_helm_uo.md) - Configure the Keyfactor Universal Orchestrator Helm Chart

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_helm_uo.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ kfutil helm uo [-t <token>] [-o <path>] [-f <file, url, or '-'>] [-e <extension
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -49,4 +50,4 @@ kfutil helm uo [-t <token>] [-o <path>] [-f <file, url, or '-'>] [-e <extension

* [kfutil helm](kfutil_helm.md) - Helm utilities for configuring Keyfactor Helm charts

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ kfutil import [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -53,4 +54,4 @@ kfutil import [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ kfutil login [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -53,4 +54,4 @@ kfutil login [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
7 changes: 4 additions & 3 deletions docs/kfutil_logout.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kfutil logout

Removes the credentials file '$HOME/.keyfactor/command_config.json'.
Unsets environment variables and removes the stored credentials file.

### Synopsis

Removes the credentials file '$HOME/.keyfactor/command_config.json'.
Unsets environment variables and removes the stored credentials file.

```
kfutil logout [flags]
Expand Down Expand Up @@ -34,6 +34,7 @@ kfutil logout [flags]
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -42,4 +43,4 @@ kfutil logout [flags]

* [kfutil](kfutil.md) - Keyfactor CLI utilities

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
3 changes: 2 additions & 1 deletion docs/kfutil_orchs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ A collections of APIs and utilities for interacting with Keyfactor orchestrators
--offline Will not attempt to connect to GitHub for latest release information and resources.
--password string Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
--profile string Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
--skip-tls-verify Disable TLS verification for API requests to Keyfactor Command.
--token-url string OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
--username string Username to use for authenticating to Keyfactor Command.
```
Expand All @@ -45,4 +46,4 @@ A collections of APIs and utilities for interacting with Keyfactor orchestrators
* [kfutil orchs logs](kfutil_orchs_logs.md) - Get orchestrator logs by machine/client name.
* [kfutil orchs reset](kfutil_orchs_reset.md) - Reset orchestrator by machine/client name.

###### Auto generated by spf13/cobra on 9-Dec-2024
###### Auto generated by spf13/cobra on 12-Dec-2024
Loading

0 comments on commit d715266

Please sign in to comment.