From ff5e9216b98f1cd718c5be7abebf4ef1cdc924d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Rahi=C4=87?= Date: Tue, 28 May 2024 15:17:13 +0200 Subject: [PATCH] docs(concepts): add org tokens (#3871) --- ...nment-token.mdx => environment-tokens.mdx} | 4 +-- docs/docs/concepts/organization-tokens.mdx | 34 +++++++++++++++++++ docs/sidebars.js | 5 +++ 3 files changed, 41 insertions(+), 2 deletions(-) rename docs/docs/concepts/{environment-token.mdx => environment-tokens.mdx} (91%) create mode 100644 docs/docs/concepts/organization-tokens.mdx diff --git a/docs/docs/concepts/environment-token.mdx b/docs/docs/concepts/environment-tokens.mdx similarity index 91% rename from docs/docs/concepts/environment-token.mdx rename to docs/docs/concepts/environment-tokens.mdx index 9b243e3530..055dd90199 100644 --- a/docs/docs/concepts/environment-token.mdx +++ b/docs/docs/concepts/environment-tokens.mdx @@ -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 @@ -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) diff --git a/docs/docs/concepts/organization-tokens.mdx b/docs/docs/concepts/organization-tokens.mdx new file mode 100644 index 0000000000..c710731cc1 --- /dev/null +++ b/docs/docs/concepts/organization-tokens.mdx @@ -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} +``` diff --git a/docs/sidebars.js b/docs/sidebars.js index 665bc927e6..73d886415c 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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",