Skip to content

Commit 2e24a4f

Browse files
vbotbuildovichgithub-actions[bot]
authored andcommitted
auto-docs: Update Cloud API spec
1 parent 230375e commit 2e24a4f

File tree

2 files changed

+53
-38
lines changed

2 files changed

+53
-38
lines changed

modules/ROOT/attachments/cloud-controlplane-api.yaml

+51-36
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ components:
1010
- arn
1111
title: Role
1212
type: object
13-
AWS.SecurityGroup:
14-
description: Security Group identifies AWS security group.
13+
AWSInstanceProfile:
14+
description: AWS instance profile.
1515
properties:
1616
arn:
17-
description: AWS security group ARN.
17+
description: AWS instance profile ARN.
1818
type: string
1919
required:
2020
- arn
21-
title: Security Group
21+
title: Instance Profile
2222
type: object
2323
AWSPrivateLink:
2424
properties:
@@ -117,6 +117,16 @@ components:
117117
schema_registry_auth_mode:
118118
$ref: '#/components/schemas/PrivateLinkAuthMode'
119119
type: object
120+
AWSSecurityGroup:
121+
description: Security Group identifies AWS security group.
122+
properties:
123+
arn:
124+
description: AWS security group ARN.
125+
type: string
126+
required:
127+
- arn
128+
title: Security Group
129+
type: object
120130
Anytime:
121131
type: object
122132
AzurePrivateLink:
@@ -284,7 +294,7 @@ components:
284294
type: array
285295
allowed_subnet_ids:
286296
description: |-
287-
A list of virtual network subnet IDs that are allowed to access the
297+
A list of virtual network subnet ids that are allowed to access the
288298
storage account.
289299
items:
290300
type: string
@@ -868,10 +878,21 @@ components:
868878
type: object
869879
CustomerManagedResourcesUpdate:
870880
properties:
881+
aws:
882+
$ref: '#/components/schemas/CustomerManagedResourcesUpdate.AWS'
871883
gcp:
872884
$ref: '#/components/schemas/CustomerManagedResourcesUpdate.GCP'
873885
title: The cloud resources created by user that can be updated
874886
type: object
887+
CustomerManagedResourcesUpdate.AWS:
888+
description: AWS resources managed by user.
889+
properties:
890+
redpanda_connect_node_group_instance_profile:
891+
$ref: '#/components/schemas/AWSInstanceProfile'
892+
redpanda_connect_security_group:
893+
$ref: '#/components/schemas/AWSSecurityGroup'
894+
title: AWS Customer-Managed Resoures
895+
type: object
875896
CustomerManagedResourcesUpdate.GCP:
876897
description: GCP resources managed by user.
877898
properties:
@@ -1317,16 +1338,6 @@ components:
13171338
type: array
13181339
title: Help
13191340
type: object
1320-
InstanceProfile:
1321-
description: AWS instance profile.
1322-
properties:
1323-
arn:
1324-
description: AWS instance profile ARN.
1325-
type: string
1326-
required:
1327-
- arn
1328-
title: Instance Profile
1329-
type: object
13301341
KafkaAPISpec:
13311342
description: Cluster's Kafka API properties.
13321343
properties:
@@ -2180,16 +2191,7 @@ components:
21802191
name:
21812192
type: string
21822193
type: object
2183-
SecurityGroups:
2184-
description: Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.
2185-
properties:
2186-
redpanda_security_group:
2187-
$ref: '#/components/schemas/SecurityGroups.SecurityGroup'
2188-
required:
2189-
- redpanda_security_group
2190-
title: Azure Security Groups
2191-
type: object
2192-
SecurityGroups.SecurityGroup:
2194+
SecurityGroup:
21932195
description: Azure security group.
21942196
properties:
21952197
name:
@@ -2200,6 +2202,15 @@ components:
22002202
required:
22012203
- name
22022204
type: object
2205+
SecurityGroups:
2206+
description: Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.
2207+
properties:
2208+
redpanda_security_group:
2209+
$ref: '#/components/schemas/SecurityGroup'
2210+
required:
2211+
- redpanda_security_group
2212+
title: Azure Security Groups
2213+
type: object
22032214
SeedBrokers:
22042215
description: Seed brokers of a Redpanda API Endpoint.
22052216
properties:
@@ -2760,31 +2771,35 @@ components:
27602771
description: AWS resources created and managed by user, and required to deploy the Redpanda cluster.
27612772
properties:
27622773
agent_instance_profile:
2763-
$ref: '#/components/schemas/InstanceProfile'
2774+
$ref: '#/components/schemas/AWSInstanceProfile'
27642775
cloud_storage_bucket:
27652776
$ref: '#/components/schemas/CustomerManagedAWSCloudStorageBucket'
27662777
cluster_security_group:
2767-
$ref: '#/components/schemas/AWS.SecurityGroup'
2778+
$ref: '#/components/schemas/AWSSecurityGroup'
27682779
connectors_node_group_instance_profile:
2769-
$ref: '#/components/schemas/InstanceProfile'
2780+
$ref: '#/components/schemas/AWSInstanceProfile'
27702781
connectors_security_group:
2771-
$ref: '#/components/schemas/AWS.SecurityGroup'
2782+
$ref: '#/components/schemas/AWSSecurityGroup'
27722783
k8s_cluster_role:
27732784
$ref: '#/components/schemas/AWS.Role'
27742785
node_security_group:
2775-
$ref: '#/components/schemas/AWS.SecurityGroup'
2786+
$ref: '#/components/schemas/AWSSecurityGroup'
27762787
permissions_boundary_policy:
27772788
$ref: '#/components/schemas/Policy'
27782789
redpanda_agent_security_group:
2779-
$ref: '#/components/schemas/AWS.SecurityGroup'
2790+
$ref: '#/components/schemas/AWSSecurityGroup'
2791+
redpanda_connect_node_group_instance_profile:
2792+
$ref: '#/components/schemas/AWSInstanceProfile'
2793+
redpanda_connect_security_group:
2794+
$ref: '#/components/schemas/AWSSecurityGroup'
27802795
redpanda_node_group_instance_profile:
2781-
$ref: '#/components/schemas/InstanceProfile'
2796+
$ref: '#/components/schemas/AWSInstanceProfile'
27822797
redpanda_node_group_security_group:
2783-
$ref: '#/components/schemas/AWS.SecurityGroup'
2798+
$ref: '#/components/schemas/AWSSecurityGroup'
27842799
utility_node_group_instance_profile:
2785-
$ref: '#/components/schemas/InstanceProfile'
2800+
$ref: '#/components/schemas/AWSInstanceProfile'
27862801
utility_security_group:
2787-
$ref: '#/components/schemas/AWS.SecurityGroup'
2802+
$ref: '#/components/schemas/AWSSecurityGroup'
27882803
required:
27892804
- agent_instance_profile
27902805
- connectors_node_group_instance_profile
@@ -3182,7 +3197,7 @@ paths:
31823197
For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named
31833198
"network-tag-foo" will be added to the Redpanda cluster GKE nodes.
31843199
Note: The value of a network tag will be ignored.
3185-
See the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.
3200+
See the details on network tags at https://cloud.google.com/vpc/docs/add-remove-network-tags.
31863201
type: object
31873202
cluster_configuration:
31883203
$ref: '#/components/schemas/ClusterUpdate.ClusterConfiguration'

modules/ROOT/attachments/cloud-dataplane-api.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1178,7 +1178,7 @@ components:
11781178
type: object
11791179
url:
11801180
description: |-
1181-
URL to connect to the pipeline, for example, using http_server.
1181+
URL to connect to the pipeline, e.g. via http_server.
11821182
May be empty if no http_server is used.
11831183
type: string
11841184
required:
@@ -1227,7 +1227,7 @@ components:
12271227
tags:
12281228
additionalProperties:
12291229
type: string
1230-
description: Optional list of tags to attach to a pipeline.
1230+
description: Optional lList of tags to attach to a pipeline.
12311231
type: object
12321232
required:
12331233
- display_name

0 commit comments

Comments
 (0)