Skip to content

Commit

Permalink
Add new category Setup and configuration
Browse files Browse the repository at this point in the history
Signed-off-by: Mirjam Aulbach <[email protected]>
  • Loading branch information
programmiri committed Feb 2, 2024
1 parent c4d2b34 commit cb7e2f2
Show file tree
Hide file tree
Showing 20 changed files with 85 additions and 63 deletions.
27 changes: 19 additions & 8 deletions _redirects
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
/docs/category/Releases/* /docs/releases/:splat 301
/docs/category/Releases /docs/releases 301
/docs/category/Releases/* /docs/releases/:splat 301
/docs/category/Releases /docs/releases 301

/docs/category/concepts /docs/Concepts/clusters-environments 301
/docs/category/howto /docs/HowTo/analytics 301
/docs/category/concepts /docs/Concepts/clusters-environments 301
/docs/category/howto /docs/HowTo/analytics 301

/docs/features /docs/getting-started/features 301
/docs/getstarted /docs/getting-started/getstarted 301
/docs/quickstart /docs/getting-started/quickstart 301
/docs/features /docs/getting-started/features 301
/docs/getstarted /docs/getting-started/getstarted 301
/docs/quickstart /docs/getting-started/quickstart 301

/docs/HowTo/analytics /docs/dashboard/analytics 301
/docs/HowTo/analytics /docs/dashboard/analytics 301

/docs/HowTo/installation /docs/setup-configuration/klaw-installation 301
/docs/HowTo/installation/configure-klaw-wizard /docs/setup-configuration/klaw-installation/configure-klaw-wizard 301
/docs/HowTo/installation/run-docker /docs/setup-configuration/klaw-installation/run-docker 301
/docs/HowTo/installation/run-source /docs/setup-configuration/klaw-installation/run-source 301
/docs/HowTo/kafka-cluster-migration/tenant-config /docs/setup-configuration/tenant-configuration 301
/docs/HowTo/tenant /docs/setup-configuration/tenant-configuration 301

/docs/Concepts/config /docs/setup-configuration/klaw-api-ssl-with-kafka 301
/docs/Concepts/high-availability /docs/setup-configuration/high-availability 310
/docs/HowTo/settings /docs/setup-configuration/settings 310
17 changes: 8 additions & 9 deletions current-routes.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@
"/blog/tags/transparency",
"/docs/",
"/docs/Concepts/clusters-environments",
"/docs/Concepts/config",
"/docs/Concepts/high-availability",
"/docs/Concepts/metastore",
"/docs/Concepts/promotion",
"/docs/Concepts/switch-teams",
Expand Down Expand Up @@ -75,10 +73,6 @@
"/docs/HowTo/exportimport/",
"/docs/HowTo/exportimport/exportdata",
"/docs/HowTo/exportimport/importdata",
"/docs/HowTo/installation/",
"/docs/HowTo/installation/configure-klaw-wizard",
"/docs/HowTo/installation/run-docker",
"/docs/HowTo/installation/run-source",
"/docs/HowTo/kafka-cluster-migration/",
"/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster",
"/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster",
Expand All @@ -87,7 +81,6 @@
"/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster",
"/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster",
"/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster",
"/docs/HowTo/kafka-cluster-migration/tenant-config",
"/docs/HowTo/notifications/",
"/docs/HowTo/notifications/email-notification",
"/docs/HowTo/notifications/slack-notification",
Expand All @@ -99,7 +92,6 @@
"/docs/HowTo/schemas/My-schema-requests",
"/docs/HowTo/schemas/Promote-a-schema",
"/docs/HowTo/schemas/Request-a-schema",
"/docs/HowTo/settings",
"/docs/HowTo/subscriptions/",
"/docs/HowTo/subscriptions/Approve-a-subscription",
"/docs/HowTo/subscriptions/Delete-a-subscription",
Expand All @@ -108,7 +100,6 @@
"/docs/HowTo/teams/",
"/docs/HowTo/teams/manage-teams",
"/docs/HowTo/teams/switch-teams",
"/docs/HowTo/tenant",
"/docs/HowTo/topics/",
"/docs/HowTo/topics/Approve-a-topic",
"/docs/HowTo/topics/Claim-a-topic",
Expand Down Expand Up @@ -137,5 +128,13 @@
"/docs/releases/release260",
"/docs/releases/release261",
"/docs/releases/release270",
"/docs/setup-configuration/high-availability",
"/docs/setup-configuration/klaw-api-ssl-with-kafka",
"/docs/setup-configuration/klaw-installation/",
"/docs/setup-configuration/klaw-installation/configure-klaw-wizard",
"/docs/setup-configuration/klaw-installation/run-docker",
"/docs/setup-configuration/klaw-installation/run-source",
"/docs/setup-configuration/settings",
"/docs/setup-configuration/tenant-configuration",
"/"
]
2 changes: 1 addition & 1 deletion docs/HowTo/kafka-cluster-migration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ uninterrupted operations.

## Quick links

- [Tenant Configuration](tenant-config.md)
- [Tenant Configuration](../../setup-configuration/tenant-configuration.md)

- [Synchronize topics from cluster](sync-topics-from-cluster.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ in Klaw.
## Prerequisites

1. **Environment configuration**: Make sure that the `klaw.tenant.config` property is set up as described in
the [tenant configuration](tenant-config.md) documentation.
the [tenant configuration](../../setup-configuration/tenant-configuration.md) documentation.
2. **User permissions**: Log in with a user account with either `SUPERADMIN` or `SYNC_SUBSCRIPTIONS` permissions.

## Steps to synchronize ACLs
Expand Down
2 changes: 1 addition & 1 deletion docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ them on the Apache Kafka cluster.
## Prerequisites

1. **Environment configuration**: Make sure the `klaw.tenant.config` property is correctly configured, as outlined in
the [tenant configuration](tenant-config.md) guide.
the [tenant configuration](../../setup-configuration/tenant-configuration.md) guide.
2. **User permissions**: Log in with a user account with either `SUPERADMIN` or a user granted
the `SYNC_BACK_SUBSCRIPTIONS` permission.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ them to a team in Klaw.
## Prerequisites

1. **Environment configuration**: Make sure to configure your environments and set the `klaw.tenant.config` property as
described in the [tenant configuration](tenant-config.md) guide.
described in the [tenant configuration](../../setup-configuration/tenant-configuration.md) guide.
2. **User permissions**: You need to be logged in as a `SUPERADMIN` or a user with the `SYNC_CONNECTORS` permission.

## Steps to synchronize connectors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ topics from an existing Apache Kafka cluster and assigning them to a Klaw team.
## Prerequisites

- **Configuration**: Ensure that your environments and the `klaw.tenant.config` property are configured as specified in
the [Tenant Configuration](tenant-config.md) documentation.
the [Tenant Configuration](../../setup-configuration/tenant-configuration.md) documentation.
- **User Permissions**: Log in as either a `SUPERADMIN` or as a user with the `SYNC_TOPICS` permission.

## Steps to synchronize topics
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ them on the Apache Kafka cluster.
## Prerequisites

- **Configuration**: Make sure to configure the environments and the `klaw.tenant.config` property. Refer to
the [Tenant Configuration](tenant-config.md) documentation for more information.
the [Tenant Configuration](../../setup-configuration/tenant-configuration.md) documentation for more information.
- **User Permissions**: Log in with a user account with either `SUPERADMIN` or as a user with the `SYNC_BACK_TOPICS`
permission.

Expand Down
25 changes: 0 additions & 25 deletions docs/HowTo/tenant.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/HowTo/topics/Request-a-new-topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ List requests made against the topic.
for the steps to configure the environments.
- The Superadmin must also update the server configuration to include the
environments, see
[Configure Klaw](../installation/configure-klaw-wizard.md)
[Configure Klaw](../../setup-configuration/klaw-installation/configure-klaw-wizard.md)
for the steps to configure the server settings.

## Make a request
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/getstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3

## With Klaw and Apache Kafka®

If you have not setup Klaw, see [Klaw installation](../HowTo/installation).
If you have not setup Klaw, see [Klaw installation](../setup-configuration/klaw-installation).
Once Klaw is up and running, the next step is to connect it to your
Apache Kafka service. Whether you are running this locally, or using a
hosted service, the steps below will get you started.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Advanced configuration
# Klaw API and SSL with Apache Kafka®

To configure the API component of Klaw, supply an
`application.properties` file when starting the service. We have
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@

Klaw can be installed and configured in two ways:

- [Run From Source](run-source.md)
- [Run from Docker](run-docker.md)
- [Run From Source](run-source.md)

Once Klaw is installed, you can use the [Configure Klaw Wizard](configure-klaw-wizard.md) to configure your Apache Kafka®
cluster
and start managing your Apache Kafka resources.
cluster and start managing your Apache Kafka resources.

Read [Deploying Klaw recommendations](../deployklaw.md)
Read [Deploying Klaw recommendations](../../HowTo/deployklaw.md)
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ To verify the installation and access Klaw, follow the steps below:
### 5. Next Steps

After successfully verifying your installation,
follow the documentation in [Configure Klaw with Wizard](../installation/configure-klaw-wizard.md).
follow the documentation in [Configure Klaw with Wizard](configure-klaw-wizard.md).

## Klaw Docker Scripts

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ notification templates and roles, under **Dashboard -\> Settings**.
- **Tenant Configuration**
A tenant is an isolated environment that
has its own set of clusters, environments, users, teams, and topics.
For more information, see [Tenant configuration](./kafka-cluster-migration/tenant-config.md). You can change the hierarchy of environments and a few other configurations by updating the property
For more information, see [Tenant configuration](../setup-configuration/tenant-configuration.md). You can change the hierarchy of environments and a few other configurations by updating the property
`klaw.tenant.config`.
- **Environment names**
When adding a new Environment, predefined
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,24 @@ instance.

Every installation of Klaw comes with a single (default) tenant.

![image](../../static/images/Tenants.png)

## Add new tenant

To add a new tenant, a superadmin or user with the `ADD_TENANT`
permission can do so under the **Environments -\> Tenants** menu.

:::note
If the application should be limited to only one tenant, you can
configure it with the below property in `application.properties` file.

#maximum tenants can be created
klaw.max.tenants=200

:::

## Configure a tenant

You can configure the following in a tenant:

- Base sync environment
Expand All @@ -16,47 +34,47 @@ You can configure the following in a tenant:
environments. Make sure this environment already exists under
Environments (Apache Kafka).

Field: baseSyncEnvironment
Field: `baseSyncEnvironment`

- Order of Apache Kafka topics promotion environments

Define a set of environments in order to promote a
Apache Kafka topic. Ex: \[\"DEV\", \"TST\"\]. Make sure this
environment already exists under Environments (Apache Kafka)

Field: orderOfTopicPromotionEnvsList
Field: `orderOfTopicPromotionEnvsList`

- Request topics Environments List

Define a set of environments for which Apache Kafka topics can be
requested directly. Other environments cannot be requested
directly, and topics can only be promoted to them.

Field: requestTopicsEnvironmentsList
Field: `requestTopicsEnvironmentsList`

- Base sync environment Apache Kafka Connector

This is the base Apache Kafka Connect environment in a hierarchy of
environments. Make sure this environment already exists under
Environments (Apache Kafka Connect).

Field: baseSyncKafkaConnectCluster
Field: `baseSyncKafkaConnectCluster`

- Order of Apache Kafka Connect promotion environments

Define a set of environments in order to promote a Apache
Kafka connector. Ex: \[\"DEV\", \"TST\"\]. Make sure this
environment already exists under Environments (Apache Kafka Connect)

Field: orderOfConnectorsPromotionEnvsList
Field: `orderOfConnectorsPromotionEnvsList`

- Request Connectors Environments List

Define a set of environments for which Apache Kafka connectors can be
requested directly. Other environments cannot be requested
directly, and connectors can only be promoted to them.

Field: requestConnectorsEnvironmentsList
Field: `requestConnectorsEnvironmentsList`

Sample Tenant configuration for Property: `klaw.tenant.config`:

Expand Down
20 changes: 20 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,26 @@ const sidebars = {
},
],
},
{
type: "category",
label: "Setup and configuration",
items: [
{
type: "category",
label: "Klaw installation",
link: {
type: "doc",
id: "setup-configuration/klaw-installation/index",
},
items: [
"setup-configuration/klaw-installation/run-docker",
"setup-configuration/klaw-installation/run-source",
"setup-configuration/klaw-installation/configure-klaw-wizard",
],
},
"setup-configuration/tenant-configuration",
],
},
{
type: "category",
label: "Concepts",
Expand Down

0 comments on commit cb7e2f2

Please sign in to comment.