From 3f8db12edc8f12a906614cd8fe8215cdd8e69827 Mon Sep 17 00:00:00 2001 From: Piotr Kazmierczak <470696+pkazmierczak@users.noreply.github.com> Date: Fri, 3 Jan 2025 16:36:49 +0100 Subject: [PATCH] documentation --- command/operator_root_keyring_remove.go | 2 +- website/content/api-docs/operator/keyring.mdx | 5 +++++ .../content/docs/commands/operator/root/keyring-remove.mdx | 6 ++++++ 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/command/operator_root_keyring_remove.go b/command/operator_root_keyring_remove.go index 8b29075403c..b3afc92c127 100644 --- a/command/operator_root_keyring_remove.go +++ b/command/operator_root_keyring_remove.go @@ -31,7 +31,7 @@ General Options: ` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + ` -Keyring Options: +Remove Options: -force Remove the key even if it was used to sign an existing variable diff --git a/website/content/api-docs/operator/keyring.mdx b/website/content/api-docs/operator/keyring.mdx index 7080d4828e4..feeb0b237af 100644 --- a/website/content/api-docs/operator/keyring.mdx +++ b/website/content/api-docs/operator/keyring.mdx @@ -233,6 +233,11 @@ The table below shows this endpoint's support for [blocking queries] and |------------------|--------------| | `NO` | `management` | +### Parameters + +- `force` `(bool: false)` - Remove the key even if it was used to sign an existing variable +or workload identity. + ### Sample Request ```shell-session diff --git a/website/content/docs/commands/operator/root/keyring-remove.mdx b/website/content/docs/commands/operator/root/keyring-remove.mdx index bcf701378e2..252e6d741a2 100644 --- a/website/content/docs/commands/operator/root/keyring-remove.mdx +++ b/website/content/docs/commands/operator/root/keyring-remove.mdx @@ -23,6 +23,12 @@ nomad operator root keyring remove [options] @include 'general_options.mdx' +## Remove Options + +- `-force`: Remove the key even if it was used to sign an existing variable +or workload identity. + + ## Examples ```shell-session