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

[D&M] ECE roles tokens pages merged #528

Merged
merged 10 commits into from
Feb 21, 2025
100 changes: 89 additions & 11 deletions deploy-manage/deploy/cloud-enterprise/generate-roles-tokens.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,103 @@
---
applies_to:
deployment:
ece: all
mapped_urls:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-generate-roles-token.html
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-revoke-roles-token.html
---

# Generate roles tokens
# Manage roles tokens

% What needs to be done: Refine
At the end of the {{ece}} installation process on the first host, you are provided with a roles token. This token can be used to install {{ece}} on additional hosts, but it does not include any role permissions.

% GitHub issue: https://github.com/elastic/docs-projects/issues/339
You can [assign roles](./assign-roles-to-hosts.md) to the additional hosts through the Cloud UI later on, but this role assignment is a manual process.

% Scope notes: merge these two pages
For automation purposes, you need to generate a new *ephemeral* or *persistent* token with the right role permissions, so that you can install {{ece}} on hosts and add the right roles at the same time.

% Use migrated content from existing pages that map to this page:
In this section, you'll learn how to perform the following tasks:

% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md
* [](#ece-generate-roles-token)
* [](#ece-revoke-roles-token)

⚠️ **This page is a work in progress.** ⚠️
## Ephemeral and persistent roles tokens

The documentation team is working to combine content pulled from the following pages:
Ephemeral and persistent tokens differ as follows:

* [/raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md](/raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md](/raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md)
Ephemeral token
: Available for use during {{ece}} installation on additional hosts for one hour before the token is revoked automatically. Cannot be revoked manually.

Persistent token
: Available for use during {{ece}} installation on additional hosts indefinitely. [Can be revoked](./generate-roles-tokens.md) at any time.

The permitted roles are the same as those you can [assign in the Cloud UI](./assign-roles-to-hosts.md):

`allocator`
: Allocates the available computing resources to Elasticsearch nodes or Kibana instances. In larger installations, a majority of the machines will be allocators.

`coordinator`
: Serves as a distributed coordination system and resource scheduler.

`proxy`
: Manages communication between a user and an Elasticsearch or Kibana instance.

`director`
: Manages the ZooKeeper datastore. This role is typically shared with the coordinator role. In production deployments it can be separated from a coordinator.

## Generate roles tokens [ece-generate-roles-token]

To generate an ephemeral token for additional allocators:

```sh
curl -H 'Content-Type: application/json' -u USER:PASSWORD https://COORDINATOR_HOST_IP:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": false, "roles": [ "allocator"] }'
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0Njk3N2I3ZC1hM2U2LTQ2MDUtYjcwZC0xNzIzMTI5YWY4ZTQiLCJyb2xlcyI6WyJwcm94eSIsImFsbG9jYXRvciJdLCJpc3MiOiJib290c3RyYXAtaW5pdGlhbCIsImV4cCI6MTQ5MzY0NjIxM30.xsaRb72CsNMuXKy6Y-PJgqLc0qmjCljlB4Smcx_MRxg"
}
```

To generate a persistent token for additional allocators:

```sh
curl -H 'Content-Type: application/json' -u USER:PASSWORD https://COORDINATOR_HOST_IP:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": true, "roles": [ "allocator"] }'
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0Yzg5OTBkZi0xZmI3LTQ4MjAtYjg2OC02YmM5ZTg4NjA4MTQiLCJyb2xlcyI6WyJwcm94eSIsImFsbG9jYXRvciJdLCJpc3MiOiJib290c3RyYXAtaW5pdGlhbCJ9.mfTkO4j8uZJ-qwB2jmBuMScyYfLmcJpvKgSTLx2WV24",
"token_id": "4c8990df-1fb7-4820-b868-6bc9e8860814"
}
```

## Revoke roles tokens [ece-revoke-roles-token]

At the end of the {{ece}} installation process on the first host, you are provided with a roles token. You can also generate new roles tokens yourself, either as ephemeral tokens that get deleted after 24 hours or as persistent tokens that get stored by {{ece}}. These tokens enable additional hosts to join an {{ece}} installation and should be kept secure or deleted if they are no longer needed.

If you delete all tokens and need to add further hosts to your installation later on, you can [generate a new token](../../../deploy-manage/deploy/cloud-enterprise/generate-roles-tokens.md) first.

::::{important}
During installation, an emergency token gets generated that enables you to install {{ece}} on additional hosts with all roles already assigned, except the allocator role. The emergency token can save your installation if all coordinators fail or are removed and you can no longer use the Cloud UI or the RESTful API. You should not delete this token. To learn more, check [Using the Emergency Roles Token](../../../troubleshoot/deployments/cloud-enterprise/use-emergency-roles-token.md).
::::

To delete a token:

1. Retrieve the list of available tokens through the RESTful API :

```sh
curl -u USER:PASSWORD https://localhost:12443/api/v1/platform/configuration/security/enrollment-tokens
{
"tokens": [{
"token_id": "5f9cad2f-c6e7-4ee2-8f6e-53225df45be5",
"roles": []
}, {
"token_id": "4c8990df-1fb7-4820-b868-6bc9e8860814",
"roles": ["proxy", "allocator"]
}]
}
```

2. Use the token ID to delete the tokens you no longer need, here `4c8990df-1fb7-4820-b868-6bc9e8860814`:

```sh
curl -XDELETE -u USER:PASSWORD 'https://localhost:12443/api/v1/platform/configuration/security/enrollment-tokens/4c8990df-1fb7-4820-b868-6bc9e8860814'
{
}
```

3. Optional: To check that the token has been deleted, repeat Step 1 and make sure that the token is no longer listed.