Skip to content

Commit

Permalink
Revert "update: Kafka enable REST proxy updates (#111)"
Browse files Browse the repository at this point in the history
This reverts commit a95b5fb.
  • Loading branch information
harshini-rangaswamy authored Apr 15, 2024
1 parent 705574e commit b913b17
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 63 deletions.
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)
- [Enable Apache Kafka® REST proxy authorization](/docs/products/kafka/karapace/howto/enable-kafka-rest-proxy-authorization)
- [Manage Apache Kafka® REST proxy authorization](/docs/products/kafka/karapace/howto/manage-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, enable **Karapace Schema registry** and
To use Karapace, you need to 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
[Enable Karapace Kafka REST authorization](//docs/products/kafka/karapace/howto/enable-kafka-rest-proxy-authorization).
[manage Karapace Kafka REST authorization](/docs/products/kafka/karapace/howto/manage-kafka-rest-proxy-authorization).

## More resources

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
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 @@ -64,8 +68,8 @@ complete the following prerequisites and configuration steps:

### Configuration via Aiven Console

1. In [Aiven Console](https://console.aiven.io/), select your project,
and choose your Aiven for Apache Kafka® service.
1. In [Aiven Console](https://console.aiven.io/), select your project
and then 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 @@ -91,5 +95,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
[Enable Apache Kafka® REST proxy authorization](/docs/products/kafka/karapace/howto/enable-kafka-rest-proxy-authorization).
[Manage Apache Kafka® REST proxy authorization](/docs/products/kafka/karapace/howto/manage-kafka-rest-proxy-authorization).
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Manage Apache Kafka® REST proxy authorization
---

Apache Kafka® REST proxy authorization allows you to use the RESTful
interface to connect to Kafka clusters, produce and consume messages
easily, and execute administrative activities using Aiven CLI. This
feature is disabled by default, and you need to
[enable Apache Kafka REST proxy authorization](/docs/products/kafka/karapace/howto/enable-oauth-oidc-kafka-rest-proxy).

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
[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.
2 changes: 1 addition & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -940,9 +940,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
4 changes: 0 additions & 4 deletions static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,9 @@
/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

/platform/howto/billing-google-cloud-platform-marketplace-subscription https://aiven.io/docs/marketplace-setup
/platform/howto/billing-aws-marketplace-subscription https://aiven.io/docs/marketplace-setup
/platform/howto/billing-azure-marketplace-subscription https://aiven.io/docs/marketplace-setup
/platform/howto/move-to-azure-marketplace-billing https://aiven.io/docs/platform/howto/list-marketplace-payments
/platform/howto/move-to-gcp-marketplace-billing https://aiven.io/docs/platform/howto/list-marketplace-payments
/platform/howto/move-to-aws-marketplace-billing https://aiven.io/docs/platform/howto/list-marketplace-payments

0 comments on commit b913b17

Please sign in to comment.