Skip to content

Commit

Permalink
issue-412, documentation refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
@OleksiienkoMykyta @ribaraka
OleksiienkoMykyta authored and ribaraka committed Nov 28, 2023
1 parent 3ad9d93 commit 5c87d8c
Show file tree
Hide file tree
Showing 17 changed files with 484 additions and 227 deletions.
2 changes: 1 addition & 1 deletion config/samples/clusters_v1beta1_cadence.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ spec:
- region: "US_EAST_2"
network: "10.12.0.0/16"
# if you use multi-region mode please provide
# non-overlapping CIDR block for the secondary mode cluster
# In a multi-region mode setup, ensure the CIDR block for the secondary cluster does not overlap with the primary one
# network: "10.16.0.0/16"
cloudProvider: "AWS_VPC"
name: "testdc"
Expand Down
2 changes: 1 addition & 1 deletion controllers/clusters/datatest/cadence_v1beta1.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ spec:
- region: "US_WEST_2"
network: "10.12.0.0/16"
# if you use multi-region mode please provide
# non-overlapping CIDR block for the secondary mode cluster
# In a multi-region mode setup, ensure the CIDR block for the secondary cluster does not overlap with the primary one
# network: "10.16.0.0/16"
cloudProvider: "AWS_VPC"
name: "testdc"
Expand Down
2 changes: 1 addition & 1 deletion controllers/clusters/datatest/cadence_v1beta1_packaged.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ spec:
- region: "US_WEST_2"
network: "10.12.0.0/16"
# if you use multi-region mode please provide
# non-overlapping CIDR block for the secondary mode cluster
# In a multi-region mode setup, ensure the CIDR block for the secondary cluster does not overlap with the primary one
# network: "10.16.0.0/16"
cloudProvider: "AWS_VPC"
name: "testdc"
Expand Down
10 changes: 5 additions & 5 deletions doc/clusterresources/aws-security-group-firewall-rule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Available spec fields

| Field | Type | Description |
|----------------------------------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| clusterId | string <br /> **required** | ID of the cluster for the cluster network firewall rule. |
| type | string <br /> **required** <br /> | The type of firewall rule. <br/> <br/>Enum: `APACHE_ZOOKEEPER`, `CADENCE`, `CADENCE_GRPC`, `CADENCE_WEB`, `CASSANDRA`, `CASSANDRA_CQL`, `ELASTICSEARCH`, `KAFKA`, `KAFKA_CONNECT`, `KAFKA_ENCRYPTION`, `KAFKA_MTLS`, `KAFKA_NO_ENCRYPTION`, `KAFKA_REST_PROXY`, `KAFKA_SCHEMA_REGISTRY`, `KARAPACE_REST_PROXY`, `KARAPACE_SCHEMA_REGISTRY`, `OPENSEARCH`, `OPENSEARCH_DASHBOARDS`, `PGBOUNCER`, `POSTGRESQL`, `REDIS`, `SEARCH_DASHBOARDS`, `SECURE_APACHE_ZOOKEEPER`, `SPARK`, `SPARK_JOBSERVER`, `SHOTOVER_PROXY`. |
| securityGroupId | string <br /> **required** | The security group ID of the AWS security group firewall rule. | |
| Field | Type | Description |
|----------------------------------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| clusterId | string <br /> **required** | ID of the cluster for the cluster network firewall rule. |
| type | string <br /> **required** <br /> | The type of firewall rule.Enum: `APACHE_ZOOKEEPER`, `CADENCE`, `CADENCE_GRPC`, `CADENCE_HTTP_API`, `CADENCE_WEB`, `CASSANDRA`, `CASSANDRA_CQL`, `ELASTICSEARCH`, `KAFKA`, `KAFKA_CONNECT`, `KAFKA_ENCRYPTION`, `KAFKA_MTLS`, `KAFKA_NO_ENCRYPTION`, `KAFKA_PRIVATE_SASL_PLAINTEXT_LISTENER`, `KAFKA_PUBLIC_SASL_PLAINTEXT_LISTENER`, `KAFKA_PRIVATE_PLAINTEXT_LISTENER`, `KAFKA_PUBLIC_PLAINTEXT_LISTENER`, `KAFKA_PRIVATE_SSL_LISTENER`, `KAFKA_PUBLIC_SSL_LISTENER`, `KAFKA_REST_PROXY`, `KAFKA_SCHEMA_REGISTRY`, `KARAPACE_REST_PROXY`, `KARAPACE_SCHEMA_REGISTRY`, `MONGODB`, `OPENSEARCH`, `OPENSEARCH_DASHBOARDS`, `PGBOUNCER`, `POSTGRESQL`, `REDIS`, `SEARCH_DASHBOARDS`, `SECURE_APACHE_ZOOKEEPER`, `SPARK`, `SPARK_JOBSERVER`, `SHOTOVER_PROXY`, `DEBEZIUM_CONNECTOR_CASSANDRA_KAFKA`, `DEBEZIUM_CONNECTOR_CASSANDRA_SCHEMA`. |
| securityGroupId | string <br /> **required** | The security group ID of the AWS security group firewall rule. | |

## Resource create flow
To create an AWS Security Group Firewall Rule resource you need to prepare the yaml manifest. Here is an example:
Expand Down
16 changes: 8 additions & 8 deletions doc/clusterresources/azure-vnet-peering.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

## Available spec fields

| Field | Type | Description |
|-------------------------------------------------------|------------------------------------------------|------------------------------------------------------------------------------------------------------------|
| peerVirtualNetworkName | string <br /> **required** | The name of the VPC Network you wish to peer to. |
| peerSubnets | Array of strings <br /> **required** <br /> | The subnets for the peering VPC. |
| peerAdObjectId | string <br /> **required** | ID of the Active Directory Object to give peering permissions to, required for cross subscription peering. | |
| peerResourceGroup | string <br /> **required** | Resource Group Name of the Virtual Network. |
| peerSubscriptionId | string <br /> **required** <br /> | Subscription ID of the Virtual Network. |
| cdcId | string <br /> **required** | ID of the Cluster Data Centre. | |
| Field | Type | Description |
|-------------------------------------------------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------|
| peerVirtualNetworkName | string <br /> **required** | The name of the VPC Network you wish to peer to. |
| peerSubnets | Array of strings <br /> **required** <br /> | The subnets for the peering VPC. |
| peerAdObjectId | string | ID of the Active Directory Object to give peering permissions to, required for cross subscription peering. | |
| peerResourceGroup | string <br /> **required** | Resource Group Name of the Virtual Network. |
| peerSubscriptionId | string <br /> **required** <br /> | Subscription ID of the Virtual Network. |
| cdcId | string <br /> **required** | ID of the Cluster Data Centre. | |

## Resource create flow
To create a Azure Vnet Peering resource you need to prepare the yaml manifest. Here is an example:
Expand Down
Loading

0 comments on commit 5c87d8c

Please sign in to comment.