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.

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

docs(concepts): add org tokens #3871

Merged
merged 1 commit into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: environment-tokens
title: Environment Tokens
description: Environment Tokens are strings used to authenticate Tracetest CLI against an organization and environment.
description: Environment Tokens are strings used to authenticate Tracetest CLI against an environment.
hide_table_of_contents: false
keywords:
- tracetest
Expand All @@ -12,7 +12,7 @@ keywords:
image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
---

Environment Tokens are strings used to authenticate the Tracetest CLI against an organization and environment.
Environment Tokens are strings used to authenticate the Tracetest CLI against an environment in an organization.

![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1701296331/docs/environment-tokens_gkt9kx.png)

Expand Down
34 changes: 34 additions & 0 deletions docs/docs/concepts/organization-tokens.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: organization-tokens
title: Organization Tokens
description: Organization Tokens are strings used to authenticate Tracetest CLI against an organization and the environments and resources within the organization.
hide_table_of_contents: false
keywords:
- tracetest
- trace-based testing
- observability
- distributed tracing
- testing
image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
---

Organization Tokens are strings used to authenticate Tracetest CLI against an organization and the environments and resources within the organization.

![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1716818893/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_tokens_veklnd.png)

These tokens are used to configure environments with the Tracetest CLI. You can configure detailed environment automation with an organization token.

Create a new token by clicking on the `Create a new token` button, choosing a name, role and expiration and then clicking on `Create`.

![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1716819703/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_tokens_1_mx7cr1.png)

Two roles are available:

- **Admin** - This token will enable authenticating both the CLI and Tracetest Agent with a single token.
- **Agent** - Thsi token will only be for authenticating and running the Tracetest Agent.

This will create a token that you can copy and use to configure Tracetest CLI with:

```bash
tracetest configure --token {ADD_YOUR_TOKEN_HERE}
```
5 changes: 5 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -752,6 +752,11 @@ const sidebars = {
id: "concepts/roles-and-permissions",
label: "Roles and Permissions",
},
{
type: "doc",
id: "concepts/organization-tokens",
label: "Organization Tokens",
},
{
type: "doc",
id: "concepts/environment-tokens",
Expand Down
Loading