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

update: Kafka enable REST proxy updates #111

Merged
merged 7 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from 6 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
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Aiven for Apache Kafka® services.
## Related pages

- [Enable OAuth2/OIDC support for Apache Kafka® REST proxy](/docs/products/kafka/karapace/howto/enable-oauth-oidc-kafka-rest-proxy)
- [Manage Apache Kafka® REST proxy authorization](/docs/products/kafka/karapace/howto/manage-kafka-rest-proxy-authorization)
- [Enable Apache Kafka® REST proxy authorization](/docs/products/kafka/karapace/howto/enable-kafka-rest-proxy-authorization)
4 changes: 2 additions & 2 deletions docs/products/kafka/karapace/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Get started with Karapace
---

To use Karapace, you need to enable **Karapace Schema registry** and
To use Karapace, enable **Karapace Schema registry** and
**REST APIs** on your Aiven for Apache Kafka® service. This can be
enabled through the Aiven console. To know how to enable it, see
[Enable Karapace schema registry and REST APIs](/docs/products/kafka/karapace/howto/enable-karapace).
Expand All @@ -17,7 +17,7 @@ enabled through the Aiven console. To know how to enable it, see
[manage Karapace schema registry authorization](/docs/products/kafka/karapace/howto/manage-schema-registry-authorization).
- Learn more about how to enable
[Apache Kafka REST proxy authorization](/docs/products/kafka/karapace/howto/enable-oauth-oidc-kafka-rest-proxy) and how to
[manage Karapace Kafka REST authorization](/docs/products/kafka/karapace/howto/manage-kafka-rest-proxy-authorization).
[Enable Karapace Kafka REST authorization](//docs/products/kafka/karapace/howto/enable-kafka-rest-proxy-authorization).

## More resources

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Enable Apache Kafka® REST proxy authorization
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Apache Kafka® REST proxy authorization enables you to use the RESTful interface to connect to Apache Kafka clusters, produce and consume messages, and perform administrative activities via the Aiven CLI. It secures Apache Kafka resources by ensuring only authorized operations are permitted through the REST interface.

When you enable Apache Kafka REST proxy authorization, Karapace sends
the HTTP basic authentication credentials to Apache Kafka®. The
authentication and authorization are then performed by Apache Kafka,
depending on the ACL defined in Apache Kafka. To configure the ACLs for
authorization, see
[Apache Kafka Access Control Lists (ACLs)](/docs/products/kafka/concepts/acl).

When Apache Kafka REST proxy authorization is disabled, the REST Proxy
bypasses the Apache Kafka ACLs, so any operation via REST API call is
performed without any restrictions.

## Configure Apache Kafka REST Proxy Authorization


<Tabs groupId="sync">
<TabItem value="Console" label="Console" default>

1. In the [Aiven Console](https://console.aiven.io/), select your project and
choose your Aiven for Apache Kafka® service.
1. Click **Service settings** from the sidebar.
1. Scroll down to the **Advanced configuration** section, and click **Configure**.
1. In the **Advanced configuration** dialog, click **Add configuration options**.
1. Locate the `kafka_rest_authorization` parameter and set it to `True` to enable.


</TabItem>
<TabItem value="CLI" label="CLI">

To **enable** REST proxy authorization, use the following command in the Aiven CLI,
replacing `SERVICE_NAME` with your actual service name:

```bash
avn service update -c kafka_rest=true SERVICE_NAME
```

To disable REST proxy authorization, use:

```bash
avn service update -c kafka_rest=false SERVICE_NAME
```
</TabItem>
</Tabs>
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@
title: Enable OAuth2/OIDC support for Apache Kafka® REST proxy
---

Secure your Apache Kafka® resources by integrating OAuth 2.0/OpenID
Connect (OIDC) with the Karapace REST proxy and enabling REST proxy
authorization. This setup ensures that only authorized individuals can
manage Apache Kafka resources through both token-based authentication
and access control rules.
Secure your Apache Kafka® resources by integrating OAuth 2.0/OpenID Connect (OIDC) with the Karapace REST proxy and enabling REST proxy authorization. This setup ensures that only authorized individuals can manage Apache Kafka resources through both token-based authentication and access control rules.

## OAuth2/OIDC token handling

Expand Down Expand Up @@ -68,8 +64,8 @@ complete the following prerequisites and configuration steps:

### Configuration via Aiven Console

1. In [Aiven Console](https://console.aiven.io/), select your project
and then choose your Aiven for Apache Kafka® service.
1. In [Aiven Console](https://console.aiven.io/), select your project,
and choose your Aiven for Apache Kafka® service.
1. In the service page, select **Service settings** from the sidebar.
1. On the **Service settings** page, scroll down to the **Advanced configuration**
section, and click **Configure**.
Expand All @@ -95,5 +91,5 @@ avn service update -c kafka_rest_authorization=false SERVICE_NAME
Enabling Apache Kafka REST proxy authorization can disrupt access for
users if the Kafka access control rules have not been configured
properly. For more information, see
[Manage Apache Kafka® REST proxy authorization](/docs/products/kafka/karapace/howto/manage-kafka-rest-proxy-authorization).
[Enable Apache Kafka® REST proxy authorization](/docs/products/kafka/karapace/howto/enable-kafka-rest-proxy-authorization).
:::

This file was deleted.

2 changes: 1 addition & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -963,9 +963,9 @@ const sidebars: SidebarsConfig = {
items: [
'products/kafka/karapace/howto/enable-karapace',
'products/kafka/karapace/howto/enable-schema-registry-authorization',
'products/kafka/karapace/howto/enable-kafka-rest-proxy-authorization',
'products/kafka/karapace/howto/enable-oauth-oidc-kafka-rest-proxy',
'products/kafka/karapace/howto/manage-schema-registry-authorization',
'products/kafka/karapace/howto/manage-kafka-rest-proxy-authorization',
],
},
],
Expand Down
1 change: 1 addition & 0 deletions static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@
/platform/howto/static-ip-addresses https://aiven.io/docs/platform/concepts/static-ips
/tools/terraform/concepts/data-sources https://aiven.io/docs/tools/terraform
/tools/terraform/howto/terraform-logging https://aiven.io/docs/tools/terraform
/products/kafka/karapace/howto/manage-kafka-rest-proxy-authorization https://aiven.io/docs/products/kafka/karapace/howto/enable-kafka-rest-proxy-authorization