-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcloud-controlplane.yaml
More file actions
9069 lines (9028 loc) · 319 KB
/
Copy pathcloud-controlplane.yaml
File metadata and controls
9069 lines (9028 loc) · 319 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
components:
schemas:
ACLAccessFilter:
properties:
host:
title: |-
The host to match. If not set, will default to match all hosts
with the specified `operation` and `permission_type`. Note that
the asterisk `*` is literal and matches hosts that are set to `*`
type: string
operation:
$ref: '#/components/schemas/ACLOperation'
permission_type:
$ref: '#/components/schemas/ACLPermissionType'
principal:
title: |-
The name of the principal, if not set will default to match
all principals with the specified `operation` and `permission_type`
type: string
title: Filter an ACL based on its access
type: object
ACLFilter:
properties:
access_filter:
$ref: '#/components/schemas/ACLAccessFilter'
resource_filter:
$ref: '#/components/schemas/ACLResourceFilter'
title: A filter for ACLs
type: object
ACLOperation:
enum:
- ACL_OPERATION_ANY
- ACL_OPERATION_READ
- ACL_OPERATION_WRITE
- ACL_OPERATION_CREATE
- ACL_OPERATION_REMOVE
- ACL_OPERATION_ALTER
- ACL_OPERATION_DESCRIBE
- ACL_OPERATION_CLUSTER_ACTION
- ACL_OPERATION_DESCRIBE_CONFIGS
- ACL_OPERATION_ALTER_CONFIGS
- ACL_OPERATION_IDEMPOTENT_WRITE
title: The ACL operation to match
type: string
ACLPattern:
description: |-
- ACL_PATTERN_ANY: Wildcard to match any pattern
- ACL_PATTERN_LITERAL: Match a literal string
- ACL_PATTERN_PREFIXED: Match a prefix
- ACL_PATTERN_PREFIX: Match a prefix
- ACL_PATTERN_MATCH: Match serves as a catch-all for all the names of a topic
the principal is authorized to access
enum:
- ACL_PATTERN_ANY
- ACL_PATTERN_LITERAL
- ACL_PATTERN_PREFIXED
- ACL_PATTERN_PREFIX
- ACL_PATTERN_MATCH
title: The ACL pattern type
type: string
ACLPermissionType:
enum:
- ACL_PERMISSION_TYPE_ANY
- ACL_PERMISSION_TYPE_ALLOW
- ACL_PERMISSION_TYPE_DENY
title: ACL permission types
type: string
ACLResource:
description: |-
- ACL_RESOURCE_ANY: Wildcard for selecting any ACL resource
- ACL_RESOURCE_CLUSTER: Cluster wide resource
- ACL_RESOURCE_GROUP: Consumer group resource
- ACL_RESOURCE_TOPIC: Topic resource
- ACL_RESOURCE_TXN_ID: Transaction ID resource
- ACL_RESOURCE_SR_SUBJECT: Schema Registry subject resource
- ACL_RESOURCE_SR_REGISTRY: Schema Registry wide resource
- ACL_RESOURCE_SR_ANY: Wildcard to match any SR ACL resource
enum:
- ACL_RESOURCE_ANY
- ACL_RESOURCE_CLUSTER
- ACL_RESOURCE_GROUP
- ACL_RESOURCE_TOPIC
- ACL_RESOURCE_TXN_ID
- ACL_RESOURCE_SR_SUBJECT
- ACL_RESOURCE_SR_REGISTRY
- ACL_RESOURCE_SR_ANY
title: The ACL resource types
type: string
ACLResourceFilter:
properties:
name:
title: |-
Name, if not given will default to match all items in `resource_type`.
Note that asterisk `*` is literal and matches resource ACLs
that are named `*`
type: string
pattern_type:
$ref: '#/components/schemas/ACLPattern'
resource_type:
$ref: '#/components/schemas/ACLResource'
title: A filter to match ACLs for resources
type: object
AWS.Role:
description: Role identifies AWS role.
properties:
arn:
description: AWS role ARN.
type: string
required:
- arn
title: Role
type: object
AWSInstanceProfile:
description: AWS instance profile.
properties:
arn:
description: AWS instance profile ARN.
type: string
required:
- arn
title: Instance Profile
type: object
AWSPeeringSpec:
properties:
peer_owner_id:
title: |-
their aws vpn id
these are aws terms
type: string
peer_vpc_id:
type: string
title: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVpcPeeringConnection.html
type: object
AWSPrivateLink:
properties:
allowed_principals:
description: The ARN of the principals that can access the Redpanda AWS PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).
example:
- arn:aws:iam::account-number-without-hyphens:user/username or arn:aws:iam::account-number-without-hyphens:root
items:
type: string
type: array
connect_console:
description: Whether Console is connected in Redpanda AWS Private Link Service.
type: boolean
enabled:
description: Whether Redpanda AWS Private Link Endpoint Service is enabled.
type: boolean
http_proxy_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
kafka_api_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
schema_registry_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
status:
$ref: '#/components/schemas/AWSPrivateLink.Status'
supported_regions:
description: List of supported regions in cross-region AWS PrivateLink.
items:
type: string
type: array
type: object
AWSPrivateLink.Status:
properties:
console_port:
description: The port of Redpanda Console.
format: int32
type: integer
created_at:
description: Redpanda AWS PrivateLink Endpoint Service creation timestamp.
format: date-time
type: string
deleted_at:
description: Redpanda AWS PrivateLink Service deletion timestamp.
format: date-time
type: string
kafka_api_node_base_port:
description: Kafka API node service base port. The port for node `i` (0 .. node_count-1) is kafka_api_node_base_port + `i`.
format: int32
type: integer
kafka_api_seed_port:
description: Kafka API seed service port.
format: int32
type: integer
redpanda_proxy_node_base_port:
description: HTTP Proxy node service base port. The port for node `i` (0 .. node_count-1) is redpanda_proxy_node_base_port + i.
format: int32
type: integer
redpanda_proxy_seed_port:
description: HTTP Proxy seed service port.
format: int32
type: integer
schema_registry_seed_port:
description: Schema Registry seed service port.
format: int32
type: integer
service_id:
description: ID of Redpanda AWS PrivateLink Endpoint Service.
example: vpce-svc-05fff2117d648da35
type: string
service_name:
description: Name of Redpanda AWS PrivateLink Endpoint Service.
example: com.amazonaws.vpce.us-west-2.vpce-svc-05fff2117d648da35
type: string
service_state:
description: State of Redpanda AWS PrivateLink Endpoint Service.
example: Pending | Available | Deleting | Deleted | Failed
type: string
vpc_endpoint_connections:
description: List of VPC endpoints with established connections to Redpanda AWS PrivateLink Endpoint Service.
items:
$ref: '#/components/schemas/VPCEndpointConnection'
type: array
type: object
AWSPrivateLinkSpec:
description: AWS PrivateLink specification.
properties:
allowed_principals:
description: The ARN of the principals that can access Redpanda AWS PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).
example:
- arn:aws:iam::account-number-without-hyphens:user/username or arn:aws:iam::account-number-without-hyphens:root
items:
type: string
type: array
connect_console:
description: Whether Console is connected in Redpanda AWS Private Link Service. The default is true if not set.
nullable: true
type: boolean
enabled:
description: Whether Redpanda AWS Private Link Endpoint Service is enabled.
type: boolean
http_proxy_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
kafka_api_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
schema_registry_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
supported_regions:
description: List of AWS regions allowed in cross region configuration.
example:
- us-east-1
- us-west-2
items:
type: string
type: array
type: object
AWSSecurityGroup:
description: Security Group identifies AWS security group.
properties:
arn:
description: AWS security group ARN.
type: string
required:
- arn
title: Security Group
type: object
AdpApi:
description: Cluster's ADP API properties.
properties:
url:
description: ADP API URL.
example: https://adp-api.cjb69h1c4vs42pca89s0.clusters.rdpa.co
readOnly: true
type: string
type: object
Anytime:
type: object
AuthenticationConfiguration:
properties:
plain_configuration:
$ref: '#/components/schemas/PlainConfig'
scram_configuration:
$ref: '#/components/schemas/ScramConfig'
title: |-
Authentication config. Supports:
* SASL/SCRAM
* SASL/PLAIN
type: object
AzurePeeringSpec:
properties:
peer_resource_group:
type: string
peer_subscription_id:
type: string
peer_tenant_id:
type: string
peer_vnet_name:
type: string
title: https://learn.microsoft.com/en-us/azure/virtual-network/virtual-network-manage-peering?tabs=peering-portal
type: object
AzurePrivateLink:
properties:
allowed_subscriptions:
description: The subscriptions that can access the Redpanda Azure PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).
example:
- 4a73b02e-90c1-4d76-af36-5c935dd41e7c
items:
type: string
type: array
connect_console:
description: Whether Console is connected in Redpanda Azure Private Link Service.
type: boolean
enabled:
description: Whether Redpanda AWS Private Link Endpoint Service is enabled.
type: boolean
http_proxy_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
kafka_api_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
schema_registry_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
status:
$ref: '#/components/schemas/AzurePrivateLink.Status'
type: object
AzurePrivateLink.Status:
properties:
approved_subscriptions:
items:
type: string
title: These are the approved subscriptions on the private link
type: array
console_port:
description: The port of Redpanda Console.
format: int32
type: integer
created_at:
description: Redpanda Azure PrivateLink Endpoint Service creation timestamp.
format: date-time
type: string
deleted_at:
description: Redpanda Azure PrivateLink Service deletion timestamp.
format: date-time
type: string
dns_a_record:
title: dns_a_dns_a_recordrecord is the DNS A record the customer will create pointing at the their PE
type: string
kafka_api_node_base_port:
description: Kafka API node service base port. The port for node `i` (0 .. node_count-1) is kafka_api_node_base_port + `i`.
format: int32
type: integer
kafka_api_seed_port:
description: Kafka API seed service port.
format: int32
type: integer
private_endpoint_connections:
description: List of private endpoint connections to Redpanda Azure Private Link Service.
items:
$ref: '#/components/schemas/PrivateEndpointConnection'
type: array
redpanda_proxy_node_base_port:
description: HTTP Proxy node service base port. The port for node `i` (0 .. node_count-1) is redpanda_proxy_node_base_port + i.
format: int32
type: integer
redpanda_proxy_seed_port:
description: HTTP Proxy seed service port.
format: int32
type: integer
schema_registry_seed_port:
description: Schema Registry seed service port.
format: int32
type: integer
service_id:
description: ID of Redpanda Azure PrivateLink Endpoint Service.
example: /subscriptions/<sub-id>/resourceGroups/<rg-id>/providers/Microsoft.Network/privateLinkServices/<name>
type: string
service_name:
description: Name of Redpanda Azure PrivateLink Endpoint Service.
example: pls-name
type: string
type: object
AzurePrivateLinkSpec:
properties:
allowed_subscriptions:
description: The subscriptions that can access the Redpanda Azure PrivateLink Endpoint Service.
example:
- 4a73b02e-90c1-4d76-af36-5c935dd41e7c
items:
type: string
type: array
connect_console:
description: Whether Console is connected in Redpanda Azure Private Link Service. The default is true if not set.
nullable: true
type: boolean
enabled:
description: Enabled controls if Azure Private Link Endpoint Service is enabled.
type: boolean
http_proxy_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
kafka_api_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
schema_registry_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
type: object
BadRequest:
description: |-
Describes violations in a client request. This error type focuses on the
syntactic aspects of the request.
properties:
field_violations:
description: Describes all violations in a client request.
items:
$ref: '#/components/schemas/FieldViolation'
type: array
title: BadRequest
type: object
CIDR:
description: Additional CIDRs allocated to Redpanda cluster.
properties:
aks_service_cidr:
description: CIDR used by AKS Kubernetes services.
type: string
required:
- aks_service_cidr
title: CIDR
type: object
CloudProvider:
description: Cloud provider where resources are created.
enum:
- CLOUD_PROVIDER_AWS
- CLOUD_PROVIDER_GCP
- CLOUD_PROVIDER_AZURE
type: string
CloudProviderStatus:
properties:
aws:
$ref: '#/components/schemas/CloudProviderStatus.AWS'
azure:
$ref: '#/components/schemas/CloudProviderStatus.Azure'
gcp:
$ref: '#/components/schemas/CloudProviderStatus.GCP'
type: object
CloudProviderStatus.AWS:
properties:
accepter_cidr_block:
type: string
expiration_time:
format: date-time
type: string
status:
type: string
status_message:
type: string
type: object
CloudProviderStatus.Azure:
properties:
peering_level:
type: string
peering_state:
type: string
status:
type: string
type: object
CloudProviderStatus.GCP:
properties:
status:
type: string
status_message:
type: string
type: object
Cluster:
description: Resource describing a Cluster.
properties:
adp_api:
$ref: '#/components/schemas/AdpApi'
ai_gateway:
$ref: '#/components/schemas/Cluster.AIGateway'
api_gateway_access:
$ref: '#/components/schemas/NetworkAccessMode'
aws_private_link:
$ref: '#/components/schemas/AWSPrivateLink'
azure_private_link:
$ref: '#/components/schemas/AzurePrivateLink'
cloud_provider:
$ref: '#/components/schemas/CloudProvider'
cloud_provider_tags:
additionalProperties:
type: string
description: |-
Tags placed on cloud resources.
If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag
is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag
is a normal tag.
For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named
"network-tag-foo" will be added to the Redpanda cluster GKE nodes.
Note: The value of a network tag will be ignored.
See the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.
type: object
cloud_storage:
$ref: '#/components/schemas/Cluster.CloudStorage'
cluster_configuration:
$ref: '#/components/schemas/Cluster.ClusterConfiguration'
connection_type:
$ref: '#/components/schemas/ConnectionType'
created_at:
description: Cluster creation timestamp.
format: date-time
type: string
current_redpanda_version:
description: Current Redpanda version of the cluster.
type: string
customer_managed_resources:
$ref: '#/components/schemas/v1.CustomerManagedResources'
dataplane_api:
$ref: '#/components/schemas/Cluster.DataplaneAPI'
desired_redpanda_version:
description: Desired Redpanda version of the cluster.
type: string
gcp_global_access_api_gateway_enabled:
description: |-
gcp_global_access_api_gateway_enabled reports whether global access is enabled on the internal
load balancer serving the Console/API Gateway endpoint. Applicable only for GCP.
nullable: true
type: boolean
gcp_global_access_enabled:
nullable: true
title: gcp_enable_global_access control if global access is enabled on the seed load balancer, applicable only for GCP. Default is false
type: boolean
gcp_private_service_connect:
$ref: '#/components/schemas/GCPPrivateServiceConnect'
http_proxy:
$ref: '#/components/schemas/HTTPProxyStatus'
id:
description: ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller.
type: string
kafka_api:
$ref: '#/components/schemas/Cluster.KafkaAPI'
kafka_connect:
$ref: '#/components/schemas/KafkaConnect'
maintenance_window_config:
$ref: '#/components/schemas/MaintenanceWindowConfig'
name:
description: Unique name of the cluster.
example: development-cluster
type: string
nat_gateways:
description: NAT gateway information for the cluster.
items:
type: string
readOnly: true
type: array
network_id:
description: Network ID where cluster is placed.
example: cjcuq79c4vs94fcufc2g
type: string
prometheus:
$ref: '#/components/schemas/Cluster.Prometheus'
read_replica_cluster_ids:
description: IDs of clusters which may create read-only topics from this cluster.
items:
type: string
type: array
redpanda_connect:
$ref: '#/components/schemas/RedpandaConnect'
redpanda_console:
$ref: '#/components/schemas/RedpandaConsole'
redpanda_node_count:
format: int32
title: Number of Redpanda broker nodes
type: integer
region:
description: Region represents the name of the region where the cluster will be provisioned.
example: us-central1
title: Cloud provider region.
type: string
resource_group_id:
description: Resource group ID of the cluster.
example: a0b40af9-0250-48ca-9417-783ed127ce42
type: string
sandbox:
$ref: '#/components/schemas/Sandbox'
schema_registry:
$ref: '#/components/schemas/Cluster.SchemaRegistryStatus'
state:
$ref: '#/components/schemas/Cluster.State'
state_description:
$ref: '#/components/schemas/rpc.Status'
throughput_tier:
description: Throughput tier of the cluster.
type: string
type:
$ref: '#/components/schemas/Cluster.Type'
updated_at:
description: Cluster update timestamp.
format: date-time
type: string
zones:
description: |-
Zones of the cluster. Must be valid zones within the selected region.
If multiple zones are used, the cluster is a multi-AZ cluster.
items:
type: string
type: array
title: Cluster
type: object
Cluster.AIGateway:
description: Cluster's AI Gateway properties.
properties:
url:
description: AI Gateway URL.
example: https://ai-gateway.cjb69h1c4vs42pca89s0.clusters.rdpa.co
readOnly: true
type: string
v2_url:
description: AI Gateway v2 URL.
example: https://aigw.cjb69h1c4vs42pca89s0.clusters.rdpa.co
readOnly: true
type: string
type: object
Cluster.CloudStorage:
properties:
aws:
$ref: '#/components/schemas/Cluster.CloudStorage.AWS'
azure:
$ref: '#/components/schemas/Cluster.CloudStorage.Azure'
gcp:
$ref: '#/components/schemas/Cluster.CloudStorage.GCP'
skip_destroy:
type: boolean
type: object
Cluster.CloudStorage.AWS:
properties:
arn:
type: string
type: object
Cluster.CloudStorage.Azure:
properties:
allowed_ips:
description: |-
List of public IP or IP ranges in CIDR Format.
- Only IPv4 addresses are allowed.
- Private IP address ranges as defined in RFC 1918 are not allowed.
- Private IP address ranges as defined in RFC 6598 are not allowed.
- Small address ranges using "/31" or "/32" prefix sizes are not
supported. These ranges should be configured using individual IP
address rules without prefix specified.
- allowed_ips have no effect on requests originating from the same
Azure region as the storage account. Use allowed_subnet_ids to allow
same-region requests. Services deployed in the same region as the
storage account use private Azure IP addresses for communication. Thus,
you cannot allow access to specific Azure services based on their
public outbound IP address range.
items:
type: string
type: array
allowed_subnet_ids:
description: |-
A list of virtual network subnet IDs that are allowed to access the
storage account.
items:
type: string
type: array
container_name:
type: string
resource_group_name:
type: string
storage_account_name:
type: string
subscription_id:
type: string
type: object
Cluster.CloudStorage.GCP:
properties:
name:
type: string
type: object
Cluster.ClusterConfiguration:
properties:
computed_properties:
type: object
custom_properties:
type: object
type: object
Cluster.DataplaneAPI:
description: Cluster's Data Plane API properties.
properties:
url:
description: Data Plane API URL.
example: https://api-ab1234l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com
readOnly: true
type: string
type: object
Cluster.KafkaAPI:
description: Cluster's Kafka API properties.
properties:
all_seed_brokers:
$ref: '#/components/schemas/SeedBrokers'
mtls:
$ref: '#/components/schemas/MTLSSpec'
sasl:
$ref: '#/components/schemas/SASLSpec'
seed_brokers:
description: Kafka API Seed Brokers (also known as Bootstrap servers).
items:
type: string
type: array
type: object
Cluster.Prometheus:
description: Prometheus metrics endpoint properties.
properties:
url:
description: Prometheus API URL.
example: https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
readOnly: true
type: string
readOnly: true
type: object
Cluster.SchemaRegistryStatus:
description: Cluster's Schema Registry properties.
properties:
all_urls:
$ref: '#/components/schemas/Endpoints'
mtls:
$ref: '#/components/schemas/MTLSSpec'
sasl:
$ref: '#/components/schemas/SASLSpec'
url:
description: Schema Registry URL.
type: string
type: object
Cluster.State:
description: State describes the state of the cluster.
enum:
- STATE_CREATING_AGENT
- STATE_CREATING
- STATE_READY
- STATE_DELETING
- STATE_DELETING_AGENT
- STATE_UPGRADING
- STATE_FAILED
- STATE_SUSPENDED
type: string
Cluster.Type:
description: Cluster type. Type is immutable and can only be set on cluster creation.
enum:
- TYPE_DEDICATED
- TYPE_BYOC
type: string
ClusterCreate:
description: Resource describing a Create Cluster.
properties:
api_gateway_access:
$ref: '#/components/schemas/NetworkAccessMode'
aws_private_link:
$ref: '#/components/schemas/AWSPrivateLinkSpec'
azure_private_link:
$ref: '#/components/schemas/AzurePrivateLinkSpec'
cloud_provider:
$ref: '#/components/schemas/CloudProvider'
cloud_provider_tags:
additionalProperties:
type: string
description: |-
Tags placed on cloud resources.
A tag is a key value pair.
If the cloud provider is GCP and the key of a tag has the prefix "gcp.network-tag.",
the tag is a network tag that will be added to the Redpanda cluster GKE nodes.
Otherwise, the tag is a normal provider tag or label.
For example, if the key of a tag is "gcp.network-tag.network-tag-foo",
the GCP network tag named "network-tag-foo" will be added to the Redpanda cluster GKE nodes.
Note: If a tag is GCP network tag, its value will be ignored.
See the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.
type: object
cloud_storage:
$ref: '#/components/schemas/ClusterCreate.CloudStorage'
cluster_configuration:
$ref: '#/components/schemas/ClusterCreate.ClusterConfiguration'
connection_type:
$ref: '#/components/schemas/ConnectionType'
customer_managed_resources:
$ref: '#/components/schemas/v1.CustomerManagedResources'
gcp_enable_global_access:
title: gcp_enable_global_access control if global access is enabled on the seed load balancer, applicable only for GCP. Default is false
type: boolean
gcp_enable_global_access_api_gateway:
description: |-
gcp_enable_global_access_api_gateway controls if global access is enabled on the internal load balancer
serving the Console/API Gateway endpoint. Applicable only for GCP. Default is false.
type: boolean
gcp_private_service_connect:
$ref: '#/components/schemas/GCPPrivateServiceConnectSpec'
http_proxy:
$ref: '#/components/schemas/HTTPProxySpec'
kafka_api:
$ref: '#/components/schemas/KafkaAPISpec'
kafka_connect:
$ref: '#/components/schemas/KafkaConnect'
maintenance_window_config:
$ref: '#/components/schemas/MaintenanceWindowConfig'
name:
description: Unique name of the cluster.
example: development-cluster
type: string
network_id:
description: Id of the network where the cluster will be placed.
example: cjcuq79c4vs94fcufc2g
type: string
read_replica_cluster_ids:
description: IDs of clusters that can create read-only topics from this cluster.
items:
type: string
type: array
redpanda_node_count:
description: redpanda_node_count defines the starting node count for the cluster.
format: int32
type: integer
redpanda_version:
description: Cluster's Redpanda version. Only `major.minor` semver is supported, e.g. `24.1`.
nullable: true
type: string
region:
description: Cloud provider region where the cluster will be provisioned.
type: string
resource_group_id:
description: Resource group ID of the cluster
example: a0b40af9-0250-48ca-9417-783ed127ce42
type: string
schema_registry:
$ref: '#/components/schemas/SchemaRegistrySpec'
throughput_tier:
description: '[Throughput tier](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).'
type: string
type:
$ref: '#/components/schemas/Cluster.Type'
zones:
description: |-
Cloud provider zones. Must be valid zones within the selected region.
If multiple zones are used, the cluster is a multi-AZ cluster.
items:
type: string
type: array
required:
- name
- resource_group_id
- throughput_tier
- type
- network_id
- cloud_provider
- region
- zones
title: ClusterCreate
type: object
ClusterCreate.CloudStorage:
properties:
aws:
$ref: '#/components/schemas/ClusterCreate.CloudStorage.AWS'
azure:
$ref: '#/components/schemas/ClusterCreate.CloudStorage.Azure'
gcp:
$ref: '#/components/schemas/ClusterCreate.CloudStorage.GCP'
skip_destroy:
type: boolean
type: object
ClusterCreate.CloudStorage.AWS:
type: object
ClusterCreate.CloudStorage.Azure:
properties:
allowed_ips:
description: |-
List of public IP or IP ranges in CIDR Format.
- Only IPv4 addresses are allowed.
- Private IP address ranges as defined in RFC 1918 are not allowed.
- Private IP address ranges as defined in RFC 6598 are not allowed.
- Small address ranges using "/31" or "/32" prefix sizes are not
supported. These ranges should be configured using individual IP
address rules without prefix specified.
- allowed_ips have no effect on requests originating from the same
Azure region as the storage account. Use allowed_subnet_ids to allow
same-region requests. Services deployed in the same region as the
storage account use private Azure IP addresses for communication. Thus,
you cannot allow access to specific Azure services based on their
public outbound IP address range.
items:
type: string
type: array
allowed_subnet_ids:
description: |-
A list of virtual network subnet ids that are allowed to access the
storage account.
items:
type: string
type: array
type: object
ClusterCreate.CloudStorage.GCP:
type: object
ClusterCreate.ClusterConfiguration:
properties:
custom_properties:
type: object
type: object
ClusterUpdate:
description: Resource describing an Update Cluster.
properties:
api_gateway_access:
$ref: '#/components/schemas/NetworkAccessMode'
aws_private_link:
$ref: '#/components/schemas/AWSPrivateLinkSpec'
azure_private_link:
$ref: '#/components/schemas/AzurePrivateLinkSpec'
cloud_provider_tags:
additionalProperties:
type: string
description: |-
Tags that are placed on Cloud resources.
If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag
is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag
is a normal tag.
For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named
"network-tag-foo" will be added to the Redpanda cluster GKE nodes.
Note: The value of a network tag will be ignored.
See the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.
type: object
cloud_storage:
$ref: '#/components/schemas/ClusterUpdate.CloudStorage'
cluster_configuration:
$ref: '#/components/schemas/ClusterUpdate.ClusterConfiguration'
customer_managed_resources:
$ref: '#/components/schemas/CustomerManagedResourcesUpdate'
gcp_enable_global_access_api_gateway:
description: |-
gcp_enable_global_access_api_gateway controls if global access is enabled on the internal load balancer
serving the Console/API Gateway endpoint. Applicable only for GCP. Default is false.
Maps to enable_global_access_console in the internal RedpandaSpec connectivity spec.
type: boolean
gcp_private_service_connect:
$ref: '#/components/schemas/GCPPrivateServiceConnectSpec'
http_proxy:
$ref: '#/components/schemas/HTTPProxySpec'
id:
description: ID of the cluster.
type: string
kafka_api:
$ref: '#/components/schemas/KafkaAPISpec'
kafka_connect:
$ref: '#/components/schemas/KafkaConnect'
maintenance_window_config:
$ref: '#/components/schemas/MaintenanceWindowConfig'
name:
description: Unique name of the cluster.
example: development-cluster
type: string
read_replica_cluster_ids:
description: IDs of clusters which may create read-only topics from this cluster.
items:
type: string
type: array
redpanda_node_count:
format: int32
type: integer
schema_registry:
$ref: '#/components/schemas/SchemaRegistrySpec'
throughput_tier:
type: string
required:
- id
title: ClusterUpdate
type: object
ClusterUpdate.CloudStorage:
properties:
aws:
$ref: '#/components/schemas/ClusterUpdate.CloudStorage.AWS'
azure:
$ref: '#/components/schemas/ClusterUpdate.CloudStorage.Azure'
gcp:
$ref: '#/components/schemas/ClusterUpdate.CloudStorage.GCP'
skip_destroy:
type: boolean
type: object
ClusterUpdate.CloudStorage.AWS:
type: object
ClusterUpdate.CloudStorage.Azure:
properties:
allowed_ips:
description: |-
List of public IP or IP ranges in CIDR Format.
- Only IPv4 addresses are allowed.
- Private IP address ranges as defined in RFC 1918 are not allowed.
- Private IP address ranges as defined in RFC 6598 are not allowed.
- Small address ranges using "/31" or "/32" prefix sizes are not
supported. These ranges should be configured using individual IP
address rules without prefix specified.
- allowed_ips have no effect on requests originating from the same
Azure region as the storage account. Use allowed_subnet_ids to allow
same-region requests. Services deployed in the same region as the
storage account use private Azure IP addresses for communication. Thus,
you cannot allow access to specific Azure services based on their
public outbound IP address range.
items:
type: string
type: array
allowed_subnet_ids:
description: |-
A list of virtual network subnet ids that are allowed to access the
storage account.
items:
type: string
type: array
type: object