chore(docs): Update docs

Signed-off-by: spbsoluble <[email protected]>
Keyfactor · Oct 23, 2024 · ebfac47 · ebfac47
1 parent 61cbfaa
commit ebfac47
Show file tree

Hide file tree

Showing 57 changed files with 60 additions and 4 deletions.
diff --git a/cmd/inventory.go b/cmd/inventory.go
@@ -607,11 +607,11 @@ var inventoryFixRFPKCS12 = &cobra.Command{
 	Long:       `Fix RFPKCS12 stores that contain 2 or more leaf certificates, by removing the certificate with the earliest issued date.`,
 	Example: `
 # The below will create a CSV file that can be reviewed and modified before running the command with the --file option.
-kfutil stores inventory fixrfpkcs12
+kfutil stores inventory fixrfpkcs12 --exp
 
 # The below will read the CSV file and schedule remove jobs as specified in the file where the 'Action' col is "REMOVE".
 # The --force flag is *required* to actually schedule the remove jobs for the certificates.
-kfutil stores inventory fixrfpkcs12 --file rfpkcs12_fix.csv --force
+kfutil stores inventory fixrfpkcs12 --file rfpkcs12_fix.csv --force --exp
 `,
 	ValidArgs:              nil,
 	ValidArgsFunction:      nil,

diff --git a/docs/kfutil.md b/docs/kfutil.md
@@ -21,6 +21,7 @@ A CLI wrapper around the Keyfactor Platform API.
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_completion.md b/docs/kfutil_completion.md
@@ -28,6 +28,7 @@ See each sub-command's help for details on how to use the generated script.
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_completion_bash.md b/docs/kfutil_completion_bash.md
@@ -51,6 +51,7 @@ kfutil completion bash
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_completion_fish.md b/docs/kfutil_completion_fish.md
@@ -42,6 +42,7 @@ kfutil completion fish [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_completion_powershell.md b/docs/kfutil_completion_powershell.md
@@ -39,6 +39,7 @@ kfutil completion powershell [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_completion_zsh.md b/docs/kfutil_completion_zsh.md
@@ -53,6 +53,7 @@ kfutil completion zsh [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_containers.md b/docs/kfutil_containers.md
@@ -26,6 +26,7 @@ A collections of APIs and utilities for interacting with Keyfactor certificate s
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_containers_get.md b/docs/kfutil_containers_get.md
@@ -31,6 +31,7 @@ kfutil containers get [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_containers_list.md b/docs/kfutil_containers_list.md
@@ -30,6 +30,7 @@ kfutil containers list [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_export.md b/docs/kfutil_export.md
@@ -42,6 +42,7 @@ kfutil export [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_helm.md b/docs/kfutil_helm.md
@@ -32,6 +32,7 @@ kubectl helm uo | helm install -f - keyfactor-universal-orchestrator keyfactor/k
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_helm_uo.md b/docs/kfutil_helm_uo.md
@@ -37,6 +37,7 @@ kfutil helm uo [-t <token>] [-o <path>] [-f <file, url, or '-'>] [-e <extension
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_import.md b/docs/kfutil_import.md
@@ -41,6 +41,7 @@ kfutil import [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_login.md b/docs/kfutil_login.md
@@ -39,6 +39,7 @@ kfutil login [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_logout.md b/docs/kfutil_logout.md
@@ -30,6 +30,7 @@ kfutil logout [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_orchs.md b/docs/kfutil_orchs.md
@@ -26,6 +26,7 @@ A collections of APIs and utilities for interacting with Keyfactor orchestrators
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_orchs_approve.md b/docs/kfutil_orchs_approve.md
@@ -31,6 +31,7 @@ kfutil orchs approve [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_orchs_disapprove.md b/docs/kfutil_orchs_disapprove.md
@@ -31,6 +31,7 @@ kfutil orchs disapprove [flags]
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.

diff --git a/docs/kfutil_orchs_ext.md b/docs/kfutil_orchs_ext.md
@@ -47,6 +47,7 @@ ext -t <token> -e <extension>@<version>,<extension>@<version> -o ./app/extension
       --hostname string                Hostname to use for authenticating to Keyfactor Command.
       --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
       --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
+      --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.
       --username string                Username to use for authenticating to Keyfactor Command.