Skip to content

Commit b2183e3

Browse files
adwk67claude
andcommitted
docs: remove product-config CLI param + env var; gut config-spec; changelog
Removes the --product-config section from the commandline reference and the PRODUCT_CONFIG section from the environment-variables reference (the flag/var is now a no-op via the shared RunArguments), reduces the product-config properties.yaml files to an empty shell (retained pending a later Helm config refactor), and notes the product-config removal in the changelog. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 3215d08 commit b2183e3

5 files changed

Lines changed: 8 additions & 337 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ All notable changes to this project will be documented in this file.
1818
Previously, arbitrary file names were silently accepted and ignored ([#960]).
1919
- Bump `stackable-operator` to 0.111.1 and snafu to 0.9 ([#960], [#961]).
2020
- Internal operator refactoring: introduce dereference() and validate() steps in the reconciler ([#968]).
21+
- Removed the product-config based configuration validation. Config and environment overrides are
22+
now merged directly from the CRD into the validated cluster, the Java-properties writer is
23+
vendored locally, and the `product-config` crate dependency is dropped. The `--product-config`
24+
CLI flag is now a no-op ([#XXX]).
2125
- test: Bump vector-aggregator to 0.55.0, replace /graphql call with gRPC call ([#971]).
2226

2327
[#953]: https://github.com/stackabletech/kafka-operator/pull/953

deploy/config-spec/properties.yaml

Lines changed: 2 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,5 @@
11
---
22
version: 0.1.0
33
spec:
4-
units:
5-
- unit: &unitPort
6-
name: "port"
7-
regex: "^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$"
8-
9-
- unit: &unitUrl
10-
name: "url"
11-
regex: "^((https?|ftp|file)://)?[-a-zA-Z0-9+&@#}/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
12-
examples:
13-
- "https://www.stackable.de/blog/"
14-
15-
- unit: &unitCapacity
16-
name: "capacity"
17-
regex: "^[1-9]\\d*$"
18-
19-
- unit: &unitMilliseconds
20-
name: "milliseconds"
21-
regex: "^[1-9]\\d*$"
22-
23-
properties:
24-
- property:
25-
propertyNames:
26-
- name: "networkaddress.cache.ttl"
27-
kind:
28-
type: "file"
29-
file: "security.properties"
30-
datatype:
31-
type: "integer"
32-
min: "0"
33-
recommendedValues:
34-
- fromVersion: "0.0.0"
35-
value: "30"
36-
roles:
37-
- name: "broker"
38-
required: true
39-
- name: "controller"
40-
required: true
41-
asOfVersion: "0.0.0"
42-
comment: "TTL for successfully resolved domain names."
43-
description: "TTL for successfully resolved domain names."
44-
45-
- property:
46-
propertyNames:
47-
- name: "networkaddress.cache.negative.ttl"
48-
kind:
49-
type: "file"
50-
file: "security.properties"
51-
datatype:
52-
type: "integer"
53-
min: "0"
54-
recommendedValues:
55-
- fromVersion: "0.0.0"
56-
value: "0"
57-
roles:
58-
- name: "broker"
59-
required: true
60-
- name: "controller"
61-
required: true
62-
asOfVersion: "0.0.0"
63-
comment: "TTL for domain names that cannot be resolved."
64-
description: "TTL for domain names that cannot be resolved."
65-
66-
- property: &opaAuthorizerClassName
67-
propertyNames:
68-
- name: "authorizer.class.name"
69-
kind:
70-
type: "file"
71-
file: "broker.properties"
72-
datatype:
73-
type: "string"
74-
defaultValues:
75-
- fromVersion: "0.0.0"
76-
value: "com.bisnode.kafka.authorization.OpaAuthorizer"
77-
- fromVersion: "3.0.0"
78-
value: "org.openpolicyagent.kafka.OpaAuthorizer"
79-
roles:
80-
- name: "broker"
81-
required: false
82-
asOfVersion: "0.0.0"
83-
description: "OPA Authorizer class name"
84-
85-
- property: &opaAuthorizerUrl
86-
propertyNames:
87-
- name: "opa.authorizer.url"
88-
kind:
89-
type: "file"
90-
file: "broker.properties"
91-
datatype:
92-
type: "string"
93-
unit: *unitUrl
94-
roles:
95-
- name: "broker"
96-
required: false
97-
asOfVersion: "0.0.0"
98-
description: "OPA Authorizer URL"
99-
100-
- property: &opaAuthorizerInitialCacheCapacity
101-
propertyNames:
102-
- name: "opa.authorizer.cache.initial.capacity"
103-
kind:
104-
type: "file"
105-
file: "broker.properties"
106-
datatype:
107-
type: "integer"
108-
unit: *unitCapacity
109-
defaultValues:
110-
- fromVersion: "0.0.0"
111-
value: "0"
112-
roles:
113-
- name: "broker"
114-
required: false
115-
asOfVersion: "0.0.0"
116-
description: "OPA Authorizer initial cache capacity"
117-
118-
- property: &opaAuthorizerMaxCacheSize
119-
propertyNames:
120-
- name: "opa.authorizer.cache.maximum.size"
121-
kind:
122-
type: "file"
123-
file: "broker.properties"
124-
datatype:
125-
type: "integer"
126-
unit: *unitCapacity
127-
defaultValues:
128-
- fromVersion: "0.0.0"
129-
value: "0"
130-
roles:
131-
- name: "broker"
132-
required: false
133-
asOfVersion: "0.0.0"
134-
description: "OPA authorizer max cache size"
135-
136-
- property: &opaAuthorizerCacheExpireAfterSeconds
137-
propertyNames:
138-
- name: "opa.authorizer.cache.expire.after.seconds"
139-
kind:
140-
type: "file"
141-
file: "broker.properties"
142-
datatype:
143-
type: "integer"
144-
unit: *unitCapacity
145-
defaultValues:
146-
- fromVersion: "0.0.0"
147-
value: "0"
148-
roles:
149-
- name: "broker"
150-
required: false
151-
asOfVersion: "0.0.0"
152-
description: "The number of seconds after which the OPA authorizer cache expires"
4+
units: []
5+
properties: []
Lines changed: 2 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,5 @@
11
---
22
version: 0.1.0
33
spec:
4-
units:
5-
- unit: &unitPort
6-
name: "port"
7-
regex: "^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$"
8-
9-
- unit: &unitUrl
10-
name: "url"
11-
regex: "^((https?|ftp|file)://)?[-a-zA-Z0-9+&@#}/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
12-
examples:
13-
- "https://www.stackable.de/blog/"
14-
15-
- unit: &unitCapacity
16-
name: "capacity"
17-
regex: "^[1-9]\\d*$"
18-
19-
- unit: &unitMilliseconds
20-
name: "milliseconds"
21-
regex: "^[1-9]\\d*$"
22-
23-
properties:
24-
- property:
25-
propertyNames:
26-
- name: "networkaddress.cache.ttl"
27-
kind:
28-
type: "file"
29-
file: "security.properties"
30-
datatype:
31-
type: "integer"
32-
min: "0"
33-
recommendedValues:
34-
- fromVersion: "0.0.0"
35-
value: "30"
36-
roles:
37-
- name: "broker"
38-
required: true
39-
- name: "controller"
40-
required: true
41-
asOfVersion: "0.0.0"
42-
comment: "TTL for successfully resolved domain names."
43-
description: "TTL for successfully resolved domain names."
44-
45-
- property:
46-
propertyNames:
47-
- name: "networkaddress.cache.negative.ttl"
48-
kind:
49-
type: "file"
50-
file: "security.properties"
51-
datatype:
52-
type: "integer"
53-
min: "0"
54-
recommendedValues:
55-
- fromVersion: "0.0.0"
56-
value: "0"
57-
roles:
58-
- name: "broker"
59-
required: true
60-
- name: "controller"
61-
required: true
62-
asOfVersion: "0.0.0"
63-
comment: "TTL for domain names that cannot be resolved."
64-
description: "TTL for domain names that cannot be resolved."
65-
66-
- property: &opaAuthorizerClassName
67-
propertyNames:
68-
- name: "authorizer.class.name"
69-
kind:
70-
type: "file"
71-
file: "broker.properties"
72-
datatype:
73-
type: "string"
74-
defaultValues:
75-
- fromVersion: "0.0.0"
76-
value: "com.bisnode.kafka.authorization.OpaAuthorizer"
77-
- fromVersion: "3.0.0"
78-
value: "org.openpolicyagent.kafka.OpaAuthorizer"
79-
roles:
80-
- name: "broker"
81-
required: false
82-
asOfVersion: "0.0.0"
83-
description: "OPA Authorizer class name"
84-
85-
- property: &opaAuthorizerUrl
86-
propertyNames:
87-
- name: "opa.authorizer.url"
88-
kind:
89-
type: "file"
90-
file: "broker.properties"
91-
datatype:
92-
type: "string"
93-
unit: *unitUrl
94-
roles:
95-
- name: "broker"
96-
required: false
97-
asOfVersion: "0.0.0"
98-
description: "OPA Authorizer URL"
99-
100-
- property: &opaAuthorizerInitialCacheCapacity
101-
propertyNames:
102-
- name: "opa.authorizer.cache.initial.capacity"
103-
kind:
104-
type: "file"
105-
file: "broker.properties"
106-
datatype:
107-
type: "integer"
108-
unit: *unitCapacity
109-
defaultValues:
110-
- fromVersion: "0.0.0"
111-
value: "0"
112-
roles:
113-
- name: "broker"
114-
required: false
115-
asOfVersion: "0.0.0"
116-
description: "OPA Authorizer initial cache capacity"
117-
118-
- property: &opaAuthorizerMaxCacheSize
119-
propertyNames:
120-
- name: "opa.authorizer.cache.maximum.size"
121-
kind:
122-
type: "file"
123-
file: "broker.properties"
124-
datatype:
125-
type: "integer"
126-
unit: *unitCapacity
127-
defaultValues:
128-
- fromVersion: "0.0.0"
129-
value: "0"
130-
roles:
131-
- name: "broker"
132-
required: false
133-
asOfVersion: "0.0.0"
134-
description: "OPA authorizer max cache size"
135-
136-
- property: &opaAuthorizerCacheExpireAfterSeconds
137-
propertyNames:
138-
- name: "opa.authorizer.cache.expire.after.seconds"
139-
kind:
140-
type: "file"
141-
file: "broker.properties"
142-
datatype:
143-
type: "integer"
144-
unit: *unitCapacity
145-
defaultValues:
146-
- fromVersion: "0.0.0"
147-
value: "0"
148-
roles:
149-
- name: "broker"
150-
required: false
151-
asOfVersion: "0.0.0"
152-
description: "The number of seconds after which the OPA authorizer cache expires"
4+
units: []
5+
properties: []

docs/modules/kafka/pages/reference/commandline-parameters.adoc

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,6 @@
22

33
This operator accepts the following command line parameters:
44

5-
== product-config
6-
7-
*Default value*: `/etc/stackable/kafka-operator/config-spec/properties.yaml`
8-
9-
*Required*: false
10-
11-
*Multiple values:* false
12-
13-
[source]
14-
----
15-
stackable-kafka-operator run --product-config /foo/bar/properties.yaml
16-
----
17-
185
== watch-namespace
196

207
*Default value*: All namespaces

docs/modules/kafka/pages/reference/environment-variables.adoc

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -33,32 +33,6 @@ docker run \
3333
oci.stackable.tech/sdp/kafka-operator:0.0.0-dev
3434
----
3535

36-
== PRODUCT_CONFIG
37-
38-
*Default value*: `/etc/stackable/kafka-operator/config-spec/properties.yaml`
39-
40-
*Required*: false
41-
42-
*Multiple values*: false
43-
44-
[source]
45-
----
46-
export PRODUCT_CONFIG=/foo/bar/properties.yaml
47-
stackable-kafka-operator run
48-
----
49-
50-
or via docker:
51-
52-
----
53-
docker run \
54-
--name kafka-operator \
55-
--network host \
56-
--env KUBECONFIG=/home/stackable/.kube/config \
57-
--env PRODUCT_CONFIG=/my/product/config.yaml \
58-
--mount type=bind,source="$HOME/.kube/config",target="/home/stackable/.kube/config" \
59-
oci.stackable.tech/sdp/kafka-operator:0.0.0-dev
60-
----
61-
6236
== WATCH_NAMESPACE
6337

6438
*Default value*: All namespaces

0 commit comments

Comments
 (0)