Skip to content

Commit dcab4df

Browse files
committed
Prepare v0.21.0 release documentation
Signed-off-by: robobario <1667008+robobario@users.noreply.github.com>
1 parent a162c9a commit dcab4df

643 files changed

Lines changed: 105606 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_data/documentation/0_21_0.yaml

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
docs:
2+
- title: Proxy Quick Start
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
rank: '000'
7+
path: html/proxy-quick-start
8+
- title: Proxy Guide
9+
description: "Using the Proxy, including configuration, security and operation."
10+
tags:
11+
- proxy
12+
- security
13+
rank: '010'
14+
path: html/kroxylicious-proxy
15+
- title: Record Encryption Quick Start
16+
description: Start here for an encryption-at-rest solution for Apache Kafka®.
17+
tags:
18+
- security
19+
- filter
20+
rank: '011'
21+
path: html/record-encryption-quick-start
22+
- title: Kroxylicious Operator for Kubernetes
23+
description: Using the Kroxylicious Operator to deploy and run the Proxy in a
24+
Kubernetes environment.
25+
tags:
26+
- kubernetes
27+
rank: '020'
28+
path: html/kroxylicious-operator
29+
- title: Record Encryption Guide
30+
description: Using the record encryption filter to provide encryption-at-rest
31+
for Apache Kafka®.
32+
tags:
33+
- security
34+
- filter
35+
rank: '020'
36+
path: html/record-encryption-guide
37+
- title: Kroxylicious Admission Webhook
38+
description: Using the Kroxylicious Admission Webhook to inject proxy sidecars
39+
into application pods in a Kubernetes environment.
40+
tags:
41+
- kubernetes
42+
rank: '021'
43+
path: html/admission-webhook-guide
44+
- title: Record Validation Guide
45+
description: "Using the record validation filter to ensure records follow certain\
46+
\ rules, including schema and signature validity."
47+
tags:
48+
- governance
49+
- filter
50+
rank: '021'
51+
path: html/record-validation-guide
52+
- title: Multi-tenancy Guide
53+
description: Using the multi-tenancy filter to present a single Kafka® cluster
54+
as if it were multiple clusters.
55+
tags:
56+
- filter
57+
rank: '022'
58+
path: html/multi-tenancy-guide
59+
- title: Oauth Bearer Validation guide
60+
description: "Using the Oauth Bearer validation filter to validate JWT tokens\
61+
\ received \nfrom Kafka® clients during authentication.\n"
62+
tags:
63+
- filter
64+
- security
65+
rank: '023'
66+
path: html/oauth-bearer-validation
67+
- title: SASL Inspection Guide
68+
description: Using the SASL Inspection filter to infer the client's subject from
69+
its successful authentication exchange with a broker.
70+
tags:
71+
- filter
72+
- security
73+
rank: '023'
74+
path: html/sasl-inspection-guide
75+
- title: Authorization Guide
76+
description: Using the Authorization filter to provide Kafka®-equivalent access
77+
controls within the proxy.
78+
tags:
79+
- security
80+
- filter
81+
rank: '024'
82+
path: html/authorization-guide
83+
- title: Entity Isolation Guide
84+
description: Using the entity isolation filter to give authenticated Kafka® clients
85+
a private namespace within a Kafka cluster.
86+
tags:
87+
- filter
88+
rank: '025'
89+
path: html/entity-isolation-guide
90+
- title: Connection Expiration Guide
91+
description: Using the connection expiration filter to avoid connection skew in
92+
Kubernetes environments.
93+
tags:
94+
- kubernetes
95+
- filter
96+
rank: '030'
97+
path: html/connection-expiration-guide
98+
- title: Developer Quick Start
99+
description: Start here if you're developing a filter for the first time.
100+
tags:
101+
- developer
102+
rank: '031'
103+
path: html/developer-quick-start
104+
- title: Kroxylicious Developer Guide
105+
description: Writing plugins for the proxy in the Java programming language.
106+
tags:
107+
- developer
108+
rank: '032'
109+
path: html/developer-guide
110+
- title: Kroxylicious Javadocs
111+
description: The Java API documentation for plugin developers.
112+
tags:
113+
- developer
114+
path: javadoc/index.html
115+
rank: '033'

_data/kroxylicious.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# The version number of the latest release
2-
latestRelease: 0.20.0
2+
latestRelease: 0.21.0
33

_data/release/0_21_0.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#
2+
# Copyright Kroxylicious Authors.
3+
#
4+
# Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
5+
#
6+
7+
releaseNotesUrl: https://github.com/kroxylicious/kroxylicious/releases/tag/v$(VERSION)/
8+
assetBaseUrl: https://github.com/kroxylicious/kroxylicious/releases/download/v$(VERSION)/
9+
assets:
10+
- name: Proxy
11+
description: The proxy application.
12+
downloads:
13+
- format: zip
14+
path: kroxylicious-app-$(VERSION)-bin.zip
15+
- format: tar.gz
16+
path: kroxylicious-app-$(VERSION)-bin.tar.gz
17+
- name: Operator
18+
description: The Kubernetes operator.
19+
downloads:
20+
- format: zip
21+
path: kroxylicious-operator-$(VERSION).zip
22+
- format: tar.gz
23+
path: kroxylicious-operator-$(VERSION).tar.gz
24+
images:
25+
- name: Proxy
26+
url: https://quay.io/repository/kroxylicious/proxy?tab=tags
27+
registry: quay.io/kroxylicious/proxy
28+
tag: $(VERSION)
29+
digest: sha256:REPLACE_WITH_SHA_AFTER_IMAGE_RELEASE
30+
- name: Operator
31+
url: https://quay.io/repository/kroxylicious/operator?tab=tags
32+
registry: quay.io/kroxylicious/operator
33+
tag: $(VERSION)
34+
digest: sha256:REPLACE_WITH_SHA_AFTER_IMAGE_RELEASE

0 commit comments

Comments
 (0)