diff --git a/docs/products/kafka/howto/enable-governance.md b/docs/products/kafka/howto/enable-governance.md index ee71d217..eb0c7555 100644 --- a/docs/products/kafka/howto/enable-governance.md +++ b/docs/products/kafka/howto/enable-governance.md @@ -7,11 +7,13 @@ import ConsoleLabel from "@site/src/components/ConsoleIcons" Enable governance in Aiven for Apache Kafka® to establish a secure and compliant framework to manage your Aiven for Apache Kafka clusters efficiently. +By default, governance applies to the organization level, and admins can manually +select specific services to be governed through the Apache Kafka governance settings. + ## Impact of enabling governance - **Existing topics**: - - The selected default group is assigned as the owner of all existing Apache Kafka - resources. + - The default group will own all existing Apache Kafka resources. - Ownership details for Apache Kafka resources are visible in the [Apache Kafka topic catalog](/docs/products/kafka/concepts/topic-catalog-overview). - Users from different groups can still claim ownership of individual resources. @@ -19,18 +21,18 @@ Enable governance in Aiven for Apache Kafka® to establish a secure and complian - **Topic creation workflow**: - There is no impact on existing topics. - You can continue to [create topics](/docs/products/kafka/howto/create-topic) in your - Aiven for Apache Kafka service. Governance in Aiven for Apache Kafka introduces an - additional request-and-approval process to claim ownership of topics from the - Apache Kafka topic catalog. + Aiven for Apache Kafka service. Governance adds a request-and-approval process for + claiming topic ownership from the Apache Kafka topic catalog. - All topics align with your organization's data management policies. ## Prerequisites - This is a [limited availability feature](/docs/platform/concepts/beta_services). To try it out, contact the sales team at [sales@aiven.io](mailto:sales@aiven.io). -- You need [super admin](/docs/platform/howto/make-super-admin) permissions to +- Ensure you have [super admin](/docs/platform/howto/make-super-admin) permissions to enable governance. + ## Enable governance 1. Access the [Aiven Console](https://console.aiven.io/) and click **Admin**. @@ -43,22 +45,12 @@ Enable governance in Aiven for Apache Kafka® to establish a secure and complian 1. Click **Create group**. 1. Select the created user group. 1. Click **Next**. -1. Define resource visibility for the Apache Kafka topic catalog. -1. Select **Project** or **Organization** visibility. - - - **Project**: Users can view Aiven for Apache Kafka resources in the Apache Kafka - topic catalog if they are added to the project. - - **Organization**: Users can view all Aiven for Apache Kafka resources across the - organization in the Apache Kafka topic catalog, regardless of their access to - individual projects. - -1. Click **Next**. 1. Set global default topic configurations: - To use the default settings, click **Keep defaults** and review the default values on the confirmation window. - Click **Enable governance**. - Alternatively, to customize: + To customize the settings: - Enter your global default topic configurations. - Click **Enable governance** to apply your changes. @@ -68,22 +60,63 @@ Enable governance in Aiven for Apache Kafka® to establish a secure and complian updated. Existing topics are not be affected by these changes. ::: -### Change the default user group +## Select services for governance + +Select the Aiven for Apache Kafka services to include in governance. Topics from these +services become visible in the Topic Catalog, allowing users to claim ownership of +existing topics. + +1. On the **Administration** page, click . +1. In the **Governed services** section, click **Change**. +1. In the **Select services for governance** dialog, select the services. +1. Click **Save**. + +## Select the governance method + +You can manage governance for Aiven for Apache Kafka® service using either the +Aiven Console or the Terraform Provider. + +Depending on your workflow, choose between: + +- **Aiven Console**: Manage governance tasks visually through the Aiven Console. View + and claim ownership of resources in the Topic Catalog. This method is selected by + default. +- **Terraform Provider**: Automate governance with the Terraform Provider. It integrates + with GitOps workflows and allows governance management across multiple projects. + +:::note +When using the Terraform method, all governance actions must be performed through +Terraform Provider. The Aiven Console provides an audit log of created requests. +::: + +1. On the **Administration** page, click . +1. In the **Governance method** section, click **Change**. +1. In the **Select governance method** dialog, choose either **Aiven Console** or + **Terraform**. + + :::warning + Switching from the Aiven Console to the Terraform method results in losing any + pending requests. + ::: + +1. Click **Save**. + +## Change the default user group To change the default user group after enabling governance: -1. On the organization page, click . +1. On the **Administration** page, click . 1. Click **Change** next to **Default user group**. 1. Select a new user group from the list. 1. If no suitable group exists, [create a group](/docs/platform/howto/manage-groups#create-a-group) and select it. 1. Click **Save**. -### Update global topic configurations +## Update global topic configurations To change global topic configurations after enabling governance: -1. On the organization page, click . +1. On the **Administration** page, click . 1. Click **Change** next to **Global default topic configurations**. 1. Update the global default topic configurations as needed. 1. Modify retention policies, partition strategies, or other settings. @@ -91,7 +124,7 @@ To change global topic configurations after enabling governance: ## Disable governance -1. On the organization page, click . +1. On the **Administration** page, click . 1. Expand **Governance is enabled for your organization**. 1. Click **Disable**. diff --git a/docs/products/kafka/howto/view-kafka-topic-catalog.md b/docs/products/kafka/howto/view-kafka-topic-catalog.md index 1aca0763..66f20a49 100644 --- a/docs/products/kafka/howto/view-kafka-topic-catalog.md +++ b/docs/products/kafka/howto/view-kafka-topic-catalog.md @@ -10,7 +10,7 @@ The [Aiven for Apache Kafka® topic catalog](/docs/products/kafka/concepts/topic 1. Log in to the [Aiven console](https://console.aiven.io/). 1. Click **Tools**. -1. Select **Apache Kafka topic catalog**. +1. Select **Apache Kafka governance operations**. ## Browse the topic catalog