Skip to content

Commit c8e51c8

Browse files
Haaroleangitbook-bot
authored andcommitted
GITBOOK-21: Refactoring, reordering
1 parent 07d3555 commit c8e51c8

File tree

17 files changed

+72
-50
lines changed

17 files changed

+72
-50
lines changed

SUMMARY.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* [MSK (+Serverless) Setup](quick-start/prerequisites/permissions/msk-+serverless-setup.md)
3030
* [Demo run](quick-start/demo-run.md)
3131
* [AWS Marketplace](quick-start/via-aws-marketplace.md)
32-
* [Persistent start](quick-start/persistent-start.md)
32+
* [Persisting config](quick-start/persistent-start.md)
3333
* [K8s / Helm](quick-start/k8s-helm.md)
3434

3535
## 🛠️ Configuration
@@ -46,14 +46,16 @@
4646
* [Misc configuration properties](configuration/misc-configuration-properties.md)
4747
* [Complex configuration examples](configuration/configuration/complex-configuration-examples/README.md)
4848
* [Kraft mode + multiple brokers](configuration/configuration/complex-configuration-examples/kraft-mode-+-multiple-brokers.md)
49-
* [Kafka w/ SSL](configuration/ssl.md)
49+
* [Kafka secured with SSL](configuration/ssl.md)
5050
* [Authentication](configuration/authentication/README.md)
51-
* [Basic Authentication](configuration/authentication/basic-authentication.md)
52-
* [OAuth2](configuration/authentication/oauth2.md)
53-
* [AWS IAM](configuration/authentication/aws-iam.md)
54-
* [LDAP / Active Directory](configuration/authentication/ldap-active-directory.md)
55-
* [SSO Guide](configuration/authentication/sso-guide.md)
56-
* [SASL\_SCRAM](configuration/authentication/sasl_scram.md)
51+
* [For the UI](configuration/authentication/for-the-ui/README.md)
52+
* [Basic Authentication](configuration/authentication/for-the-ui/basic-authentication.md)
53+
* [OAuth2](configuration/authentication/for-the-ui/oauth2.md)
54+
* [LDAP / Active Directory](configuration/authentication/for-the-ui/ldap-active-directory.md)
55+
* [SSO Guide (Deprecated)](configuration/authentication/for-the-ui/sso-guide.md)
56+
* [For Kafka](configuration/authentication/for-kafka/README.md)
57+
* [AWS IAM](configuration/authentication/for-kafka/aws-iam.md)
58+
* [SASL\_SCRAM](configuration/authentication/for-kafka/sasl_scram.md)
5759
* [RBAC (Role based access control)](configuration/rbac-role-based-access-control/README.md)
5860
* [Supported Identity Providers](configuration/rbac-role-based-access-control/supported-identity-providers.md)
5961
* [Data masking](configuration/data-masking.md)
@@ -65,4 +67,4 @@
6567

6668
* [Common problems](faq/common-problems.md)
6769
* [FAQ](faq/faq.md)
68-
* [Authentication](faq/authentication.md)
70+
* [Authentication Issues](faq/authentication.md)

configuration/audit-log.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ kafka:
2222
2323
### Note
2424
25-
If you create the Audit Topic manually, it **should not** be compacted, as the audit documents do not have a key, which is required for Kafka topic compaction.
25+
If you create the audit topic manually, it **should not** be compacted, as the audit documents do not have a key, which is required for Kafka topic compaction.
2626
2727
Other than **compaction**, the Kafka UI does not expect specific requirements for additional topic properties. However, as always, consider configuring the following:
2828
29-
- **Retention period** How long the data should be stored in Kafka.
30-
- **Number of partitions** This affects parallelism and how the data will be consumed.
29+
* **Retention period** How long the data should be stored in Kafka.
30+
* **Number of partitions** This affects parallelism and how the data will be consumed.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description: List of authentication methods to kafka itself
3+
---
4+
5+
# For Kafka
6+

configuration/authentication/aws-iam.md renamed to configuration/authentication/for-kafka/aws-iam.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You could pass SASL configs in the properties section for each cluster.
1010

1111
More details could be found here: [aws-msk-iam-auth](https://github.com/aws/aws-msk-iam-auth)
1212

13-
More about permissions: [msk-+serverless-setup.md](../../quick-start/prerequisites/permissions/msk-+serverless-setup.md "mention")
13+
More about permissions: [msk-+serverless-setup.md](../../../quick-start/prerequisites/permissions/msk-+serverless-setup.md "mention")
1414

1515
### Examples:
1616

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description: Authentication methods for authenticating your users into the UI itself
3+
---
4+
5+
# For the UI
6+

configuration/authentication/basic-authentication.md renamed to configuration/authentication/for-the-ui/basic-authentication.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ description: Basic username+password authentication
44

55
# Basic Authentication
66

7-
In order to enable basic username+passworda authentication add these properties:
7+
Basic authentication supports only one local user. If you need multiple, running a Keycloak instance is the easiest way.
8+
9+
To enable basic username+password authentication, add these properties:
810

911
```properties
1012
AUTH_TYPE: "LOGIN_FORM"
@@ -25,4 +27,4 @@ spring:
2527
password: pass
2628
```
2729
28-
Please note that basic auth is not compatible with neither any other auth method nor RBAC.
30+
Please note that basic auth is incompatible with any other auth method or RBAC.

configuration/authentication/ldap-active-directory.md renamed to configuration/authentication/for-the-ui/ldap-active-directory.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@ spring:
1212
user-filter-search-base: "dc=planetexpress,dc=com"
1313
user-filter-search-filter: "(&(uid={0})(objectClass=inetOrgPerson))"
1414
group-filter-search-base: "ou=people,dc=planetexpress,dc=com" # required for RBAC
15+
```
16+
17+
If you're running AD rather than LDAP, also add these:
18+
19+
```
1520
oauth2:
1621
ldap:
17-
activeDirectory: false
22+
activeDirectory: true
1823
aсtiveDirectory:
1924
domain: memelord.lol
2025
```

configuration/authentication/sso-guide.md renamed to configuration/authentication/for-the-ui/sso-guide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# SSO Guide
1+
---
2+
description: Deprecated. See OAuth2 guides
3+
---
4+
5+
# SSO Guide (Deprecated)
26

37
## How to configure SSO
48

0 commit comments

Comments
 (0)