From cb26ca8645c55cbd0284ef057a51b3b2c3433d8a Mon Sep 17 00:00:00 2001 From: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Date: Tue, 6 Aug 2024 16:41:24 -0700 Subject: [PATCH] Update auto-generated documentation (#1185) * Autogenerate reference docs Signed-off-by: rad-ci-bot * Update en-custom.txt Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: rad-ci-bot Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: rad-ci-bot Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --- .github/config/en-custom.txt | 1 + docs/content/reference/cli/rad_credential.md | 6 +- .../reference/cli/rad_credential_register.md | 6 +- .../cli/rad_credential_register_aws.md | 25 +++----- .../rad_credential_register_aws_access-key.md | 62 +++++++++++++++++++ .../cli/rad_credential_register_aws_irsa.md | 61 ++++++++++++++++++ 6 files changed, 140 insertions(+), 21 deletions(-) create mode 100644 docs/content/reference/cli/rad_credential_register_aws_access-key.md create mode 100644 docs/content/reference/cli/rad_credential_register_aws_irsa.md diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index 8be985a0e..9aa34b40d 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -1253,3 +1253,4 @@ envSecrets RecipeConfigPropertiesEnvSecrets SecretReference ProviderConfigPropertiesSecrets +irsa diff --git a/docs/content/reference/cli/rad_credential.md b/docs/content/reference/cli/rad_credential.md index 48099004c..150cc2602 100644 --- a/docs/content/reference/cli/rad_credential.md +++ b/docs/content/reference/cli/rad_credential.md @@ -32,8 +32,10 @@ rad credential list rad credential register azure sp --client-id --client-secret --tenant-id # Register (Add or Update) cloud provider credential for Azure with workload identity authentication rad credential register azure wi --client-id --tenant-id -# Register (Add or Update) cloud provider credential for AWS with IAM authentication -rad credential register aws --access-key-id --secret-access-key +# Register (Add or update) cloud provider credential for AWS with access key authentication. +rad credential register aws access-key --access-key-id --secret-access-key +# Register (Add or update) cloud provider credential for AWS with IRSA (IAM Roles for Service Accounts). +rad credential register aws irsa --iam-role # Show cloud provider credential details for Azure rad credential show azure diff --git a/docs/content/reference/cli/rad_credential_register.md b/docs/content/reference/cli/rad_credential_register.md index 81eff4d5c..1623e104c 100644 --- a/docs/content/reference/cli/rad_credential_register.md +++ b/docs/content/reference/cli/rad_credential_register.md @@ -29,8 +29,10 @@ or credentials will affect all Radius Environments and applications of the affec rad credential register azure sp --client-id --client-secret --tenant-id # Register (Add or update) cloud provider credential for Azure with workload identity authentication rad credential register azure wi --client-id --tenant-id -# Register (Add or Update) cloud provider credential for AWS with IAM authentication -rad credential register aws --access-key-id --secret-access-key +# Register (Add or update) cloud provider credential for AWS with access key authentication. +rad credential register aws access-key --access-key-id --secret-access-key +# Register (Add or update) cloud provider credential for AWS with IRSA (IAM Roles for service Accounts). +rad credential register aws irsa --iam-role ``` diff --git a/docs/content/reference/cli/rad_credential_register_aws.md b/docs/content/reference/cli/rad_credential_register_aws.md index ac35f2301..08d5d12b4 100644 --- a/docs/content/reference/cli/rad_credential_register_aws.md +++ b/docs/content/reference/cli/rad_credential_register_aws.md @@ -14,12 +14,6 @@ Register (Add or update) AWS cloud provider credential for a Radius installation Register (Add or update) AWS cloud provider credential for a Radius installation.. -This command is intended for scripting or advanced use-cases. See 'rad init' for a user-friendly way -to configure these settings. - -Radius will use the provided IAM credential for all interactions with AWS. - - Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS). The Radius control-plane stores credentials for use when accessing cloud resources. @@ -27,36 +21,33 @@ Cloud providers are configured per-Radius-installation. Configuration commands w or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration or credentials will affect all Radius Environments and applications of the affected installation. -``` -rad credential register aws [flags] -``` - ### Examples ``` -# Register (Add or update) cloud provider credential for AWS with IAM authentication -rad credential register aws --access-key-id --secret-access-key +# Register (Add or update) cloud provider credential for AWS with access key authentication. +rad credential register aws access-key --access-key-id --secret-access-key +# Register (Add or update) cloud provider credential for AWS with IRSA. +rad credential register aws irsa --iam-role ``` ### Options ``` - --access-key-id string The AWS IAM access key id. - -h, --help help for aws - -o, --output string output format (supported formats are json, table) (default "table") - --secret-access-key string The AWS IAM secret access key. - -w, --workspace string The workspace name + -h, --help help for aws ``` ### Options inherited from parent commands ``` --config string config file (default "$HOME/.rad/config.yaml") + -o, --output string output format (supported formats are json, table) (default "table") ``` ### SEE ALSO * [rad credential register]({{< ref rad_credential_register.md >}}) - Register (Add or update) cloud provider credential for a Radius installation. +* [rad credential register aws access-key]({{< ref rad_credential_register_aws_access-key.md >}}) - Register (Add or update) AWS cloud provider credential for a Radius installation. +* [rad credential register aws irsa]({{< ref rad_credential_register_aws_irsa.md >}}) - Register (Add or update) AWS cloud provider credential for a Radius installation. diff --git a/docs/content/reference/cli/rad_credential_register_aws_access-key.md b/docs/content/reference/cli/rad_credential_register_aws_access-key.md new file mode 100644 index 000000000..221f7cb66 --- /dev/null +++ b/docs/content/reference/cli/rad_credential_register_aws_access-key.md @@ -0,0 +1,62 @@ +--- +type: docs +title: "rad credential register aws access-key CLI reference" +linkTitle: "rad credential register aws access-key" +slug: rad_credential_register_aws_access-key +url: /reference/cli/rad_credential_register_aws_access-key/ +description: "Details on the rad credential register aws access-key Radius CLI command" +--- +## rad credential register aws access-key + +Register (Add or update) AWS cloud provider credential for a Radius installation. + +### Synopsis + +Register (Add or update) AWS cloud provider credential for a Radius installation.. + +This command is intended for scripting or advanced use-cases. See 'rad init' for a user-friendly way +to configure these settings. + +Radius will use the provided IAM credential for all interactions with AWS. + + +Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS). +The Radius control-plane stores credentials for use when accessing cloud resources. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius Environments and applications of the affected installation. + +``` +rad credential register aws access-key [flags] +``` + +### Examples + +``` + +# Register (Add or update) cloud provider credential for AWS with IAM authentication +rad credential register aws access-key --access-key-id --secret-access-key + +``` + +### Options + +``` + --access-key-id string The AWS IAM access key id. + -h, --help help for access-key + -o, --output string output format (supported formats are json, table) (default "table") + --secret-access-key string The AWS IAM secret access key. + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad credential register aws]({{< ref rad_credential_register_aws.md >}}) - Register (Add or update) AWS cloud provider credential for a Radius installation. + diff --git a/docs/content/reference/cli/rad_credential_register_aws_irsa.md b/docs/content/reference/cli/rad_credential_register_aws_irsa.md new file mode 100644 index 000000000..be45cb57b --- /dev/null +++ b/docs/content/reference/cli/rad_credential_register_aws_irsa.md @@ -0,0 +1,61 @@ +--- +type: docs +title: "rad credential register aws irsa CLI reference" +linkTitle: "rad credential register aws irsa" +slug: rad_credential_register_aws_irsa +url: /reference/cli/rad_credential_register_aws_irsa/ +description: "Details on the rad credential register aws irsa Radius CLI command" +--- +## rad credential register aws irsa + +Register (Add or update) AWS cloud provider credential for a Radius installation. + +### Synopsis + +Register (Add or update) AWS cloud provider credential for a Radius installation.. + +This command is intended for scripting or advanced use-cases. See 'rad init' for a user-friendly way +to configure these settings. + +Radius will use the provided IAM credential for all interactions with AWS. + + +Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS). +The Radius control-plane stores credentials for use when accessing cloud resources. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius Environments and applications of the affected installation. + +``` +rad credential register aws irsa [flags] +``` + +### Examples + +``` + +# Register (Add or update) cloud provider credential for AWS with IRSA (IAM roles for service accounts) authentication +rad credential register aws irsa --iam-role + +``` + +### Options + +``` + -h, --help help for irsa + --iam-role string RoleARN for AWS IRSA identity. + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad credential register aws]({{< ref rad_credential_register_aws.md >}}) - Register (Add or update) AWS cloud provider credential for a Radius installation. +