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

Improve documentation page on ES privileges #3355

Open
akeller opened this issue Feb 20, 2024 · 1 comment · May be fixed by #4704
Open

Improve documentation page on ES privileges #3355

akeller opened this issue Feb 20, 2024 · 1 comment · May be fixed by #4704
Assignees
Labels
component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed support Issues related to support tickets

Comments

@akeller
Copy link
Member

akeller commented Feb 20, 2024

Add justification/reasoning for privileges

See below for inspiration 👇

The following is a breakdown of Elasticsearch permissions and how they are used by Camunda to perform the necessary Elasticsearch actions :

  • manage_index_templates - when Camunda Operate is booted up/started for the first time, Operate will check if the necessary index templates exist, if not, the index templates will be created. After the startup/initialization phase, this privilege is not required anymore, and can be revoked.
  • manage_pipeline - a pipeline privilege is only used when an upgrade is performed for Camunda 8 from version x to y. If you don't need to perform an upgrade, this privilege is not required. It can be granted temporarily, while performing an upgrade.
  • monitor - this privilege is required to check the Elasticsearch cluster health. This privilege provides us with read-only cluster operations permissions. We believe it is safe to use from your cluster's perspective, as it will not affect any other tenants of your Elasticsearch cluster. Let us know if you think otherwise.
  • manage_index_templates and manage_ilm - these privileges are only required when Operate starts for the first time, meaning, it will create the necessary index templates and ILM policies. You can start Operate, for the first time with these two privileges granted. Once completed and the index templates and ILM policies are created, you can stop Operate, remove the privileges, and then start Operate again.
  • manage_index_templates, manage_pipeline, and manage_ilm - these privileges only needed during an upgrade to a newer version. At the time you want to upgrade your Camunda instance, you can perform the following steps:
    • Stop Operate component
    • Grant these privileges.
    • Perform the upgrade
    • Once the upgrade and migration have been completed, stop the Operate and remove the privileges
    • Start Operate
  • create_snapshot and monitor_snapshot - only needed to perform backups, if you don't plan to use the backup feature, then these privileges are not needed at all. If you want to perform a backup you can provide Operate with the privileges before you create a backup and revoke them after the backup has been completed.

All info should be reviewed by @romansmirnov.

From internal Slack channel -https://camunda.slack.com/archives/C06KJPVS5CG

@akeller akeller added component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Feb 20, 2024
@akeller akeller added the support Issues related to support tickets label Feb 20, 2024
@akeller
Copy link
Member Author

akeller commented May 31, 2024

@conceptualshark this is a beefier topic that came from an incident/support ticket, but it would give you a good topic to introduce yourself to @romansmirnov and discuss priority.

@conceptualshark conceptualshark moved this from 🆕 Inbox to 📋 Backlog in Developer Experience Jun 3, 2024
@conceptualshark conceptualshark self-assigned this Jun 3, 2024
@conceptualshark conceptualshark moved this from 📋 Backlog to 🔖 Ready in Developer Experience Aug 15, 2024
@conceptualshark conceptualshark linked a pull request Dec 3, 2024 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed support Issues related to support tickets
Projects
Status: 👀 In Review
2 participants