@redpanda-data/docs-extensions-and-macros 4.3.0 → 4.4.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 (44) hide show
  1. package/bin/doc-tools.js +328 -0
  2. package/cli-utils/add-caret-external-links.py +68 -0
  3. package/cli-utils/beta-from-antora.js +27 -0
  4. package/cli-utils/generate-cluster-docs.sh +83 -0
  5. package/cli-utils/install-test-dependencies.sh +158 -0
  6. package/cli-utils/python-venv.sh +20 -0
  7. package/cli-utils/start-cluster.sh +53 -0
  8. package/docker-compose/bootstrap.yml +67 -0
  9. package/docker-compose/docker-compose.yml +414 -0
  10. package/docker-compose/generate-profiles.yaml +77 -0
  11. package/docker-compose/rpk-profile.yaml +24 -0
  12. package/docker-compose/transactions-schema.json +37 -0
  13. package/docker-compose/transactions.md +46 -0
  14. package/docker-compose/transform/README.adoc +73 -0
  15. package/docker-compose/transform/go.mod +5 -0
  16. package/docker-compose/transform/go.sum +2 -0
  17. package/docker-compose/transform/regex.wasm +0 -0
  18. package/docker-compose/transform/transform.go +122 -0
  19. package/docker-compose/transform/transform.yaml +33 -0
  20. package/extension-utils/compute-out.js +38 -0
  21. package/extension-utils/create-asciidoc-file.js +15 -0
  22. package/macros/data-template.js +2 -2
  23. package/package.json +15 -3
  24. package/tools/docusaurus-to-antora-conversion-scripts/convert-docs.sh +114 -0
  25. package/tools/docusaurus-to-antora-conversion-scripts/get-file-changes.sh +9 -0
  26. package/tools/docusaurus-to-antora-conversion-scripts/post-process-asciidoc.js +63 -0
  27. package/tools/docusaurus-to-antora-conversion-scripts/pre-process-markdown.js +108 -0
  28. package/tools/fetch-from-github.js +63 -0
  29. package/tools/gen-rpk-ascii.py +477 -0
  30. package/tools/get-console-version.js +53 -0
  31. package/tools/get-redpanda-version.js +53 -0
  32. package/tools/metrics/metrics.py +199 -0
  33. package/tools/metrics/requirements.txt +1 -0
  34. package/tools/property-extractor/Makefile +99 -0
  35. package/tools/property-extractor/README.adoc +206 -0
  36. package/tools/property-extractor/definitions.json +245 -0
  37. package/tools/property-extractor/file_pair.py +7 -0
  38. package/tools/property-extractor/json-to-asciidoc/generate_docs.py +460 -0
  39. package/tools/property-extractor/parser.py +224 -0
  40. package/tools/property-extractor/property_bag.py +4 -0
  41. package/tools/property-extractor/property_extractor.py +243 -0
  42. package/tools/property-extractor/requirements.txt +2 -0
  43. package/tools/property-extractor/tests/transformers_test.py +376 -0
  44. package/tools/property-extractor/transformers.py +397 -0
package/tools/property-extractor/definitions.json ADDED
@@ -0,0 +1,245 @@
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
+ }
package/tools/property-extractor/file_pair.py ADDED
@@ -0,0 +1,7 @@
1
+ class FilePair:
2
+ def __init__(self, header, implementation) -> None:
3
+ self.header = header
4
+ self.implementation = implementation
5
+
6
+ def __repr__(self) -> str:
7
+ return f"(header={self.header}, implementation={self.implementation})"