Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EDU-3500: Fix tcld commands in keygen docs #3208

Merged
merged 2 commits into from
Nov 13, 2024
Merged

EDU-3500: Fix tcld commands in keygen docs #3208

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d976b0
EDU-3500: Fix tcld commands in keygen docs
fairlydurable Nov 13, 2024
d69e5a4
Merge branch 'main' into EDU-3500
fairlydurable Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions docs/production-deployment/cloud/api-keys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,16 +152,16 @@ Then select **Create API key** and provide the following information:

Finish by selecting **Generate API key**.

#### Generate API keys with `tcld`
#### Generate API keys with tcld

To generate an API key, log into your account and issue the following command:

```command
tcld login
tcld apikey create \
--name "<key-name>" \
--description "<key-description>" \
--duration "<key-duration>"
--name <api-key-name> \
--description "<api-key-description>" \
--duration <api-key-duration>
```

Duration specifies the time until the API key expires, for example: "30d", "4d12h", etc.
Expand All @@ -180,7 +180,7 @@ Follow these steps:
1. Select the three vertical dots next to the API key’s row.
1. Choose **Enable** or **Disable**.

#### Manage API Key State with `tcld`
#### Manage API Key State with tcld

To manage an API key, log into your account and use one of the following commands to enable or disable it:

Expand Down Expand Up @@ -210,7 +210,7 @@ Follow these steps to remove API keys:
1. Select the three vertical dots next to the API key's row.
1. Choose **Delete**.

#### Delete API keys with `tcld`
#### Delete API keys with tcld

To delete an API key, log into your account and issue the following:

Expand Down Expand Up @@ -261,12 +261,13 @@ In the "Mapped to identity" input box, select a Service account and provide the

Finish by selecting **Generate API key**.

#### Generate API keys with `tcld`
#### Generate API keys with tcld

To create an API key for a Service Account, use `tcld apikey create` with the `--service-account-id` flag:

```
tcld apikey create --namespace <namespace_id>.<account_id> \
tcld apikey create \
--name <api-key-name> \
--description "<api-key-description>" \
--duration <api-key-duration> \
--service-account-id <service-account-id>
Expand All @@ -286,7 +287,7 @@ Follow these steps:
There may be a delay after changing the status.
Once successful, the updated API key status will be shown in the row.

#### Manage keys with `tcld`
#### Manage keys with tcld

Use the `tcld apikey disable` or `tcld apikey enable` command to disable or enable an API key:

Expand Down Expand Up @@ -314,7 +315,7 @@ Follow these steps:
There may be a delay after deleting the API key.
1. Once successful, the updated API key status will be reflected in the row.

#### Delete a Service Account API key with `tcld`
#### Delete a Service Account API key with tcld

Use the `tcld apikey delete` command to delete an API key.
The process for deleting an API key is the same for a user or Service Account.
Expand Down Expand Up @@ -683,7 +684,7 @@ const worker = await Worker.create({
});
```

### `tcld`
### tcld

To use an API key with `tcld`, choose one of these methods:

Expand Down