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(console): Update Cluster settings page #4059

Merged
merged 5 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
43 changes: 40 additions & 3 deletions docs/components/console/manage-clusters/settings.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,50 @@
---
id: settings
title: Settings
description: "Set up resource-based authorizations to authorize access and assign permissions to process and decision definitions."
description: "Manage your cluster settings or permanently delete the cluster."
---

Set up resource-based authorizations to authorize access and assign permissions to process and decision definitions in the **Settings** tab. You can enable resource-based authorizations on a per-cluster basis. It's possible to disable the feature at any time.
In this document, learn how to manage your cluster settings using resource-based authorizations, automatic cluster updates, and user task restrictions, or permanently delete the cluster.
mesellings marked this conversation as resolved.
Show resolved Hide resolved

![Cluster settings](./img/cluster-settings.png)

## Resource-based authorizations

You can enable resource-based authorization on a per-cluster basis to control the level of access users have over system resources.

- Enable this setting to use resource-based authorization in the cluster. You must define resource access for each user as users no longer have access to all process and decision definitions.
- Disable this setting if you do not want to use resource-based authorization in the cluster. You can still configure resource authorizations, but they are only applied to cluster users when you enable this setting.
akeller marked this conversation as resolved.
Show resolved Hide resolved

:::tip
For more information on resource-based authorization, see [resource authorizations](/components/concepts/resource-authorizations.md) and [resource-based authorization](/components/console/manage-organization/manage-users.md/#resource-based-authorizations).
:::

## Automatic cluster updates

You can set the cluster to automatically update to newer versions of Camunda 8 when they are released.

- Enable this setting to automatically update the cluster when a new patch release is available. During an update, the cluster may be unavailable for a short time. You can still manually update the cluster.
- Disable this setting if you do not want the cluster to automatically update. You must manually update the cluster.

:::tip
To learn more about creating resource-based authorizations, visit our [resource-based authorization documentation](../manage-organization/manage-users.md#resource-based-authorizations)
For more information on updating clusters, see [update your cluster](/components/console/manage-clusters/update-cluster.md).
:::

## Enforce user task restrictions

You can enable user task access restrictions in the cluster to restrict Tasklist task access to assigned/candidate users and groups.

- Enable this setting to use user task access restrictions in the cluster. Tasks assigned to users or candidate groups are only visible to assigned users or respective group members.
- Disable this setting if you do not want to use user task access restrictions in the cluster. Any user can see any task, regardless of the assignment. Use this mode in development environments to test assignment rules.

:::tip
For more information on user task access restrictions, see [user task access restrictions](/components/concepts/access-control/user-task-access-restrictions.md).
:::

## Delete this cluster

You can _permanently_ delete the selected cluster. See [delete your cluster](/components/console/manage-clusters/delete-cluster.md) for additional details.

:::caution
Deleting a cluster is permanent. You cannot reuse a cluster after it has been deleted.
:::
Original file line number Diff line number Diff line change
@@ -1,13 +1,50 @@
---
id: settings
title: Settings
description: "Set up resource-based authorizations to authorize access and assign permissions to process and decision definitions."
description: "Manage your cluster settings or permanently delete the cluster."
---

Set up resource-based authorizations to authorize access and assign permissions to process and decision definitions in the **Settings** tab. You can enable resource-based authorizations on a per-cluster basis. It's possible to disable the feature at any time.
In this document, learn how to manage your cluster settings using resource-based authorizations, automatic cluster updates, and user task restrictions, or permanently delete the cluster.

![Cluster settings](./img/cluster-settings.png)

## Resource-based authorizations

You can enable resource-based authorization on a per-cluster basis to control the level of access users have over system resources.

- Enable this setting to use resource-based authorization in the cluster. You must define resource access for each user as users no longer have access to all process and decision definitions.
- Disable this setting if you do not want to use resource-based authorization in the cluster. You can still configure resource authorizations, but they are only applied to cluster users when you enable this setting.

:::tip
For more information on resource-based authorization, see [resource authorizations](/components/concepts/resource-authorizations.md) and [resource-based authorization](/components/console/manage-organization/manage-users.md/#resource-based-authorizations).
:::

## Automatic cluster updates

You can set the cluster to automatically update to newer versions of Camunda 8 when they are released.

- Enable this setting to automatically update the cluster when a new patch release is available. During an update, the cluster may be unavailable for a short time. You can still manually update the cluster.
- Disable this setting if you do not want the cluster to automatically update. You must manually update the cluster.

:::tip
To learn more about creating resource-based authorizations, visit our [resource-based authorization documentation](../manage-organization/manage-users.md#resource-based-authorizations)
For more information on updating clusters, see [update your cluster](/components/console/manage-clusters/update-cluster.md).
:::

## Enforce user task restrictions

You can enable user task access restrictions in the cluster to restrict Tasklist task access to assigned/candidate users and groups.

- Enable this setting to use user task access restrictions in the cluster. Tasks assigned to users or candidate groups are only visible to assigned users or respective group members.
- Disable this setting if you do not want to use user task access restrictions in the cluster. Any user can see any task, regardless of the assignment. Use this mode in development environments to test assignment rules.

:::tip
For more information on user task access restrictions, see [user task access restrictions](/components/concepts/access-control/user-task-access-restrictions.md).
:::

## Delete this cluster

You can _permanently_ delete the selected cluster. See [delete your cluster](/components/console/manage-clusters/delete-cluster.md) for additional details.

:::caution
Deleting a cluster is permanent. You cannot reuse a cluster after it has been deleted.
:::
Original file line number Diff line number Diff line change
@@ -1,13 +1,50 @@
---
id: settings
title: Settings
description: "Set up resource-based authorizations to authorize access and assign permissions to process and decision definitions."
description: "Manage your cluster settings or permanently delete the cluster."
---

Set up resource-based authorizations to authorize access and assign permissions to process and decision definitions in the **Settings** tab. You can enable resource-based authorizations on a per-cluster basis. It's possible to disable the feature at any time.
In this document, learn how to manage your cluster settings using resource-based authorizations, automatic cluster updates, and user task restrictions, or permanently delete the cluster.

![Cluster settings](./img/cluster-settings.png)

## Resource-based authorizations

You can enable resource-based authorization on a per-cluster basis to control the level of access users have over system resources.

- Enable this setting to use resource-based authorization in the cluster. You must define resource access for each user as users no longer have access to all process and decision definitions.
- Disable this setting if you do not want to use resource-based authorization in the cluster. You can still configure resource authorizations, but they are only applied to cluster users when you enable this setting.

:::tip
For more information on resource-based authorization, see [resource authorizations](/components/concepts/resource-authorizations.md) and [resource-based authorization](/components/console/manage-organization/manage-users.md/#resource-based-authorizations).
:::

## Automatic cluster updates

You can set the cluster to automatically update to newer versions of Camunda 8 when they are released.

- Enable this setting to automatically update the cluster when a new patch release is available. During an update, the cluster may be unavailable for a short time. You can still manually update the cluster.
- Disable this setting if you do not want the cluster to automatically update. You must manually update the cluster.

:::tip
To learn more about creating resource-based authorizations, visit our [resource-based authorization documentation](../manage-organization/manage-users.md#resource-based-authorizations)
For more information on updating clusters, see [update your cluster](/components/console/manage-clusters/update-cluster.md).
:::

## Enforce user task restrictions

You can enable user task access restrictions in the cluster to restrict Tasklist task access to assigned/candidate users and groups.

- Enable this setting to use user task access restrictions in the cluster. Tasks assigned to users or candidate groups are only visible to assigned users or respective group members.
- Disable this setting if you do not want to use user task access restrictions in the cluster. Any user can see any task, regardless of the assignment. Use this mode in development environments to test assignment rules.

:::tip
For more information on user task access restrictions, see [user task access restrictions](/components/concepts/access-control/user-task-access-restrictions.md).
:::

## Delete this cluster

You can _permanently_ delete the selected cluster. See [delete your cluster](/components/console/manage-clusters/delete-cluster.md) for additional details.

:::caution
Deleting a cluster is permanent. You cannot reuse a cluster after it has been deleted.
:::
Original file line number Diff line number Diff line change
@@ -1,13 +1,50 @@
---
id: settings
title: Settings
description: "Set up resource-based authorizations to authorize access and assign permissions to process and decision definitions."
description: "Manage your cluster settings or permanently delete the cluster."
---

Set up resource-based authorizations to authorize access and assign permissions to process and decision definitions in the **Settings** tab. You can enable resource-based authorizations on a per-cluster basis. It's possible to disable the feature at any time.
In this document, learn how to manage your cluster settings using resource-based authorizations, automatic cluster updates, and user task restrictions, or permanently delete the cluster.

![Cluster settings](./img/cluster-settings.png)

## Resource-based authorizations

You can enable resource-based authorization on a per-cluster basis to control the level of access users have over system resources.

- Enable this setting to use resource-based authorization in the cluster. You must define resource access for each user as users no longer have access to all process and decision definitions.
- Disable this setting if you do not want to use resource-based authorization in the cluster. You can still configure resource authorizations, but they are only applied to cluster users when you enable this setting.

:::tip
For more information on resource-based authorization, see [resource authorizations](/components/concepts/resource-authorizations.md) and [resource-based authorization](/components/console/manage-organization/manage-users.md/#resource-based-authorizations).
:::

## Automatic cluster updates

You can set the cluster to automatically update to newer versions of Camunda 8 when they are released.

- Enable this setting to automatically update the cluster when a new patch release is available. During an update, the cluster may be unavailable for a short time. You can still manually update the cluster.
- Disable this setting if you do not want the cluster to automatically update. You must manually update the cluster.

:::tip
To learn more about creating resource-based authorizations, visit our [resource-based authorization documentation](../manage-organization/manage-users.md#resource-based-authorizations)
For more information on updating clusters, see [update your cluster](/components/console/manage-clusters/update-cluster.md).
:::

## Enforce user task restrictions

You can enable user task access restrictions in the cluster to restrict Tasklist task access to assigned/candidate users and groups.

- Enable this setting to use user task access restrictions in the cluster. Tasks assigned to users or candidate groups are only visible to assigned users or respective group members.
- Disable this setting if you do not want to use user task access restrictions in the cluster. Any user can see any task, regardless of the assignment. Use this mode in development environments to test assignment rules.

:::tip
For more information on user task access restrictions, see [user task access restrictions](/components/concepts/access-control/user-task-access-restrictions.md).
:::

## Delete this cluster

You can _permanently_ delete the selected cluster. See [delete your cluster](/components/console/manage-clusters/delete-cluster.md) for additional details.

:::caution
Deleting a cluster is permanent. You cannot reuse a cluster after it has been deleted.
:::
Loading