-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update cli docs for octopus(go) (#2583)
Co-authored-by: Bob <[email protected]>
- Loading branch information
1 parent
f8c9fe8
commit 5fc38d5
Showing
174 changed files
with
474 additions
and
324 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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-aws-create.mdx
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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx
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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-azure-create.mdx
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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-azure-list.mdx
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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create.mdx
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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-list.mdx
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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc.mdx
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
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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-create.mdx
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
2 changes: 1 addition & 1 deletion
2
src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-list.mdx
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
49 changes: 49 additions & 0 deletions
49
src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-create.mdx
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,49 @@ | ||
| --- | ||
| layout: src/layouts/Default.astro | ||
| pubDate: 2023-01-01 | ||
| modDate: 2024-12-05 | ||
| title: octopus account generic-oidc create | ||
| description: Create an Generic OpenID Connect account | ||
| navOrder: 17 | ||
| --- | ||
| import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; | ||
|
|
||
| Create an Generic OpenID Connect account in Octopus Deploy | ||
|
|
||
| ``` | ||
| Usage: | ||
| octopus account generic-oidc create [flags] | ||
| Aliases: | ||
| create, new | ||
| Flags: | ||
| -d, -- string A summary explaining the use of the account to other users. | ||
| --audience string The audience claim for the federated credentials. Defaults to api://default | ||
| -D, --description-file file Read the description from file | ||
| -e, --environment stringArray The environments that are allowed to use this account | ||
| -E, --execution-subject-keys stringArray The subject keys used for a deployment or runbook | ||
| -n, --name string A short, memorable, unique name for this account. | ||
| Global Flags: | ||
| -h, --help Show help for a command | ||
| --no-prompt Disable prompting in interactive mode | ||
| -f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table") | ||
| -s, --space string Specify the space for operations | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| <SamplesInstance /> | ||
|
|
||
| ``` | ||
| $ octopus account generic-oidc create | ||
| ``` | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Octopus CLI](/docs/octopus-rest-api/cli) | ||
| - [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) |
40 changes: 40 additions & 0 deletions
40
src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-list.mdx
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,40 @@ | ||
| --- | ||
| layout: src/layouts/Default.astro | ||
| pubDate: 2023-01-01 | ||
| modDate: 2024-12-05 | ||
| title: octopus account generic-oidc list | ||
| description: List Generic OpenID Connect accounts | ||
| navOrder: 18 | ||
| --- | ||
| import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; | ||
|
|
||
| List Generic OpenID Connect accounts in Octopus Deploy | ||
|
|
||
| ``` | ||
| Usage: | ||
| octopus account generic-oidc list [flags] | ||
| Aliases: | ||
| list, ls | ||
| Global Flags: | ||
| -h, --help Show help for a command | ||
| --no-prompt Disable prompting in interactive mode | ||
| -f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table") | ||
| -s, --space string Specify the space for operations | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| <SamplesInstance /> | ||
|
|
||
| ``` | ||
| $ octopus account generic-oidc list | ||
| ``` | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Octopus CLI](/docs/octopus-rest-api/cli) | ||
| - [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) |
44 changes: 44 additions & 0 deletions
44
src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc.mdx
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,44 @@ | ||
| --- | ||
| layout: src/layouts/Default.astro | ||
| pubDate: 2023-01-01 | ||
| modDate: 2024-12-05 | ||
| title: octopus account generic-oidc | ||
| description: Manage Generic OpenID Connect accounts | ||
| navOrder: 16 | ||
| --- | ||
| import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; | ||
|
|
||
| Manage Generic OpenID Connect accounts in Octopus Deploy | ||
|
|
||
| ``` | ||
| Usage: | ||
| octopus account generic-oidc [command] | ||
| Available Commands: | ||
| create Create an Generic OpenID Connect account | ||
| help Help about any command | ||
| list List Generic OpenID Connect accounts | ||
| Global Flags: | ||
| -h, --help Show help for a command | ||
| --no-prompt Disable prompting in interactive mode | ||
| -f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table") | ||
| -s, --space string Specify the space for operations | ||
| Use "octopus account generic-oidc [command] --help" for more information about a command. | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| <SamplesInstance /> | ||
|
|
||
| ``` | ||
| $ octopus account generic-oidc list | ||
| ``` | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Octopus CLI](/docs/octopus-rest-api/cli) | ||
| - [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) |
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
4 changes: 2 additions & 2 deletions
4
src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-create.mdx
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
4 changes: 2 additions & 2 deletions
4
src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-list.mdx
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
4 changes: 2 additions & 2 deletions
4
src/pages/docs/octopus-rest-api/cli/octopus-account-token-create.mdx
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
4 changes: 2 additions & 2 deletions
4
src/pages/docs/octopus-rest-api/cli/octopus-account-token-list.mdx
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
4 changes: 2 additions & 2 deletions
4
src/pages/docs/octopus-rest-api/cli/octopus-account-token.mdx
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
4 changes: 2 additions & 2 deletions
4
src/pages/docs/octopus-rest-api/cli/octopus-account-username-create.mdx
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
4 changes: 2 additions & 2 deletions
4
src/pages/docs/octopus-rest-api/cli/octopus-account-username-list.mdx
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
Oops, something went wrong.