-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update auto-generated documentation (#1185)
* Autogenerate reference docs Signed-off-by: rad-ci-bot <[email protected]> * Update en-custom.txt Signed-off-by: Reshma Abdul Rahim <[email protected]> --------- Signed-off-by: rad-ci-bot <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> Co-authored-by: rad-ci-bot <[email protected]> Co-authored-by: Reshma Abdul Rahim <[email protected]>
- Loading branch information
3 people
authored
Aug 6, 2024
1 parent
f7ce928
commit cb26ca8
Showing
6 changed files
with
140 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1253,3 +1253,4 @@ envSecrets | |
| RecipeConfigPropertiesEnvSecrets | ||
| SecretReference | ||
| ProviderConfigPropertiesSecrets | ||
| irsa | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
docs/content/reference/cli/rad_credential_register_aws_access-key.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <access-key-id> --secret-access-key <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. | ||
|
|
61 changes: 61 additions & 0 deletions
61
docs/content/reference/cli/rad_credential_register_aws_irsa.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <roleARN> | ||
| ``` | ||
|
|
||
| ### 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. | ||
|
|