@redpanda-data/docs-extensions-and-macros 4.11.1 → 4.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/bin/doc-tools.js +4 -2
  2. package/package.json +3 -1
  3. package/tools/property-extractor/COMPUTED_CONSTANTS.md +173 -0
  4. package/tools/property-extractor/Makefile +12 -1
  5. package/tools/property-extractor/README.adoc +828 -97
  6. package/tools/property-extractor/compare-properties.js +38 -13
  7. package/tools/property-extractor/constant_resolver.py +610 -0
  8. package/tools/property-extractor/file_pair.py +42 -0
  9. package/tools/property-extractor/generate-handlebars-docs.js +41 -8
  10. package/tools/property-extractor/helpers/gt.js +9 -0
  11. package/tools/property-extractor/helpers/includes.js +17 -0
  12. package/tools/property-extractor/helpers/index.js +3 -0
  13. package/tools/property-extractor/helpers/isEnterpriseEnum.js +24 -0
  14. package/tools/property-extractor/helpers/renderPropertyExample.js +6 -5
  15. package/tools/property-extractor/overrides.json +248 -0
  16. package/tools/property-extractor/parser.py +254 -32
  17. package/tools/property-extractor/property_bag.py +40 -0
  18. package/tools/property-extractor/property_extractor.py +1417 -430
  19. package/tools/property-extractor/requirements.txt +1 -0
  20. package/tools/property-extractor/templates/property-backup.hbs +161 -0
  21. package/tools/property-extractor/templates/property.hbs +104 -49
  22. package/tools/property-extractor/templates/topic-property-backup.hbs +148 -0
  23. package/tools/property-extractor/templates/topic-property.hbs +72 -34
  24. package/tools/property-extractor/tests/test_known_values.py +617 -0
  25. package/tools/property-extractor/tests/transformers_test.py +81 -6
  26. package/tools/property-extractor/topic_property_extractor.py +23 -10
  27. package/tools/property-extractor/transformers.py +2191 -369
  28. package/tools/property-extractor/type_definition_extractor.py +669 -0
  29. package/tools/property-extractor/definitions.json +0 -245
package/tools/property-extractor/definitions.json DELETED
@@ -1,245 +0,0 @@
1
- {
2
- "client_group_quota": {
3
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/client_group_byte_rate_quota.h#L29",
4
- "type": "object",
5
- "properties": {
6
- "group_name": {
7
- "type": "string"
8
- },
9
- "clients_prefix": {
10
- "type": "string"
11
- },
12
- "quota": {
13
- "type": "integer",
14
- "minimum": -9223372036854775808,
15
- "maximum": 9223372036854775807
16
- }
17
- }
18
- },
19
- "config::broker_authn_endpoint": {
20
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/broker_authn_endpoint.h#L42",
21
- "type": "object",
22
- "properties": {
23
- "name": {
24
- "type": "string"
25
- },
26
- "address": {
27
- "type": "string"
28
- },
29
- "port": {
30
- "type": "integer",
31
- "minimum": 0,
32
- "maximum": 4294967295
33
- }
34
- }
35
- },
36
- "config::endpoint_tls_config": {
37
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/endpoint_tls_config.h#L21",
38
- "type": "object",
39
- "properties": {
40
- "name": {
41
- "type": "string"
42
- },
43
- "config": {
44
- "$ref": "#/definitions/config::tls_config"
45
- }
46
- }
47
- },
48
- "config::tls_config": {
49
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/tls_config.h#L49",
50
- "type": "object",
51
- "properties": {
52
- "enabled": {
53
- "type": "boolean"
54
- },
55
- "require_client_auth": {
56
- "type": "boolean"
57
- },
58
- "key_file": {
59
- "type": "string"
60
- },
61
- "cert_file": {
62
- "type": "string"
63
- },
64
- "truststore_file": {
65
- "type": "string"
66
- }
67
- }
68
- },
69
- "tls_config": {
70
- "$ref": "#/definitions/config::tls_config"
71
- },
72
- "config::rest_authn_endpoint": {
73
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/rest_authn_endpoint.h#L42",
74
- "type": "object",
75
- "properties": {
76
- "name": {
77
- "type": "string"
78
- },
79
- "address": {
80
- "type": "string"
81
- },
82
- "port": {
83
- "type": "integer",
84
- "minimum": 0,
85
- "maximum": 4294967295
86
- },
87
- "authentication_method": {
88
- "$ref": "#/definitions/config::rest_authn_method"
89
- }
90
- }
91
- },
92
- "config::rest_authn_method": {
93
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/rest_authn_endpoint.h#L31",
94
- "enum": [
95
- "none",
96
- "http_basic"
97
- ]
98
- },
99
- "endpoint_tls_config": {
100
- "$ref": "#/definitions/config::endpoint_tls_config"
101
- },
102
- "model::broker_endpoint": {
103
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L88",
104
- "type": "object",
105
- "properties": {
106
- "name": {
107
- "type": "string"
108
- },
109
- "address": {
110
- "type": "string"
111
- },
112
- "port": {
113
- "type": "integer",
114
- "minimum": 0,
115
- "maximum": 4294967295
116
- }
117
- }
118
- },
119
- "model::cleanup_policy_bitflags": {
120
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/fundamental.h#L72",
121
- "enum": [
122
- "none",
123
- "delete",
124
- "compact"
125
- ]
126
- },
127
- "model::cloud_credentials_source": {
128
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L454",
129
- "enum": [
130
- "config_file",
131
- "aws_instance_metadata",
132
- "sts",
133
- "gcp_instance_metadata"
134
- ]
135
- },
136
- "model::cloud_storage_backend": {
137
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L481",
138
- "enum": [
139
- "aws",
140
- "google_s3_compat",
141
- "azure",
142
- "minio",
143
- "unknown"
144
- ]
145
- },
146
- "model::cloud_storage_chunk_eviction_strategy": {
147
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L524",
148
- "enum": [
149
- "eager",
150
- "capped",
151
- "predictive"
152
- ]
153
- },
154
- "model::compression": {
155
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/compression.h#L36",
156
- "enum": [
157
- "none",
158
- "gzip",
159
- "snappy",
160
- "lz4",
161
- "zstd",
162
- "producer"
163
- ]
164
- },
165
- "model::leader_balancer_mode": {
166
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L504",
167
- "enum": [
168
- "greedy_balanced_shards",
169
- "random_hill_climbing"
170
- ]
171
- },
172
- "model::node_id": {
173
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L36",
174
- "type": "integer",
175
- "minimum": -2147483648,
176
- "maximum": 2147483647
177
- },
178
- "model::partition_autobalancing_mode": {
179
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L463",
180
- "enum": [
181
- "off",
182
- "node_add",
183
- "continuous"
184
- ]
185
- },
186
- "model::rack_id": {
187
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L60",
188
- "type": "string"
189
- },
190
- "model::timestamp_type": {
191
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/timestamp.h#L30",
192
- "enum": [
193
- "create_time",
194
- "append_time"
195
- ]
196
- },
197
- "net::unresolved_address": {
198
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/net/unresolved_address.h#L27",
199
- "properties": {
200
- "address": {
201
- "type": "string"
202
- },
203
- "port": {
204
- "type": "integer",
205
- "minimum": 0,
206
- "maximum": 4294967295
207
- }
208
- }
209
- },
210
- "pandaproxy::schema_registry::schema_id_validation_mode": {
211
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/pandaproxy/schema_registry/schema_id_validation.h#L22",
212
- "enum": [
213
- "none",
214
- "redpanda",
215
- "compat"
216
- ]
217
- },
218
- "retention_duration_property": {
219
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/property.h#L878",
220
- "type": "integer",
221
- "minimum": -2147483648,
222
- "maximum": 2147483647
223
- },
224
- "seed_server": {
225
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/seed_server.h#L24",
226
- "type": "object",
227
- "properties": {
228
- "host": {
229
- "$ref": "#/definitions/net::unresolved_address"
230
- }
231
- }
232
- },
233
- "throughput_control_group": {
234
- "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/throughput_control_group.h#L36",
235
- "type": "object",
236
- "properties": {
237
- "name": {
238
- "type": "string"
239
- },
240
- "client_id": {
241
- "type": "string"
242
- }
243
- }
244
- }
245
- }