ClusterProps
Properties for defining a Cluster.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-acs-cluster
Initializer
import ros_cdk_acs
ros_cdk_acs.ClusterProps(
name: typing.Union[str, IResolvable],
addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]] = None,
cluster_spec: typing.Union[str, IResolvable] = None,
deletion_protection: typing.Union[bool, IResolvable] = None,
endpoint_public_access: typing.Union[bool, IResolvable] = None,
ip_stack: typing.Union[str, IResolvable] = None,
kubernetes_version: typing.Union[str, IResolvable] = None,
load_balancer_spec: typing.Union[str, IResolvable] = None,
logging_type: typing.Union[str, IResolvable] = None,
maintenance_window: typing.Union[IResolvable, MaintenanceWindowProperty] = None,
pod_v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
service_cidr: typing.Union[str, IResolvable] = None,
service_discovery_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
sls_project_name: typing.Union[str, IResolvable] = None,
snat_entry: typing.Union[bool, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
time_zone: typing.Union[str, IResolvable] = None,
vpc_id: typing.Union[str, IResolvable] = None,
v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None
)
Properties
| Name | Type | Description |
|---|---|---|
name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property name: The name of the cluster. |
addons |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]] |
Property addons: The add-ons to be installed for the cluster. |
cluster_spec |
typing.Union[str, ros_cdk_core.IResolvable] |
Property clusterSpec: The managed cluster spec. |
deletion_protection |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property deletionProtection: Specifies whether to enable deletion protection for the cluster. |
endpoint_public_access |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open. |
ip_stack |
typing.Union[str, ros_cdk_core.IResolvable] |
Property ipStack: The IP stack of the cluster. |
kubernetes_version |
typing.Union[str, ros_cdk_core.IResolvable] |
Property kubernetesVersion: The version of the Kubernetes cluster. |
load_balancer_spec |
typing.Union[str, ros_cdk_core.IResolvable] |
Property loadBalancerSpec: The specification of the Server Load Balancer instance. |
logging_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property loggingType: The logging type of the cluster. |
maintenance_window |
typing.Union[ros_cdk_core.IResolvable, MaintenanceWindowProperty] |
Property maintenanceWindow: The maintenance window of the cluster. |
pod_v_switch_ids |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property podVSwitchIds: The list of pod vSwitches. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property resourceGroupId: The ID of resource group. |
service_cidr |
typing.Union[str, ros_cdk_core.IResolvable] |
Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment. |
service_discovery_types |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property serviceDiscoveryTypes: Intra-cluster service discovery type, used to specify the service discovery method in the ASK cluster. |
sls_project_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property slsProjectName: The SLS project name of the cluster. |
snat_entry |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property snatEntry: Whether to configure SNAT for the network. |
tags |
typing.List[TagsProperty] |
Property tags: Tag the cluster. |
time_zone |
typing.Union[str, ros_cdk_core.IResolvable] |
Property timeZone: The time zone of the cluster. |
vpc_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vpcId: VPC ID. |
v_switch_ids |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property vSwitchIds: The IDs of VSwitches. |
zone_ids |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] |
Property zoneIds: The zone IDs of the cluster. |
nameRequired
name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property name: The name of the cluster.
The cluster name can use uppercase and lowercase letters, Chinese characters, numbers, and dashes.
addonsOptional
addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]]
Property addons: The add-ons to be installed for the cluster.
cluster_specOptional
cluster_spec: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property clusterSpec: The managed cluster spec.
Value: ack.pro.small: Professional hosting cluster, namely: "ACK Pro version cluster". ack.standard: Standard hosting cluster. Default value: ack.pro.small.
deletion_protectionOptional
deletion_protection: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property deletionProtection: Specifies whether to enable deletion protection for the cluster.
After deletion protection is enabled, the cluster cannot be deleted in the ACK console or by calling API operations. Valid values:true: enables deletion protection for the cluster. false: disables deletion protection for the cluster. Default value: false.
endpoint_public_accessOptional
endpoint_public_access: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open.
false: If set to false, the API server on the public network will not be created, only the API server on the private network will be created.Default to false.
ip_stackOptional
ip_stack: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ipStack: The IP stack of the cluster.
kubernetes_versionOptional
kubernetes_version: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property kubernetesVersion: The version of the Kubernetes cluster.
load_balancer_specOptional
load_balancer_spec: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property loadBalancerSpec: The specification of the Server Load Balancer instance.
Allowed value: slb.s1.small|slb.s2.small|slb.s2.medium|slb.s3.small|slb.s3.medium|slb.s3.large
logging_typeOptional
logging_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property loggingType: The logging type of the cluster.
By default, no logging service is used.
maintenance_windowOptional
maintenance_window: typing.Union[IResolvable, MaintenanceWindowProperty]
- Type: typing.Union[ros_cdk_core.IResolvable, MaintenanceWindowProperty]
Property maintenanceWindow: The maintenance window of the cluster.
pod_v_switch_idsOptional
pod_v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property podVSwitchIds: The list of pod vSwitches.
For each vSwitch that is allocated to nodes, you must specify at least one pod vSwitch in the same zone. The pod vSwitches cannot be the same as the node vSwitches. We recommend that you set the mask length of the CIDR block to a value no greater than 19 for the pod vSwitches. The pod_vswitch_ids parameter is required when the Terway network plug-in is selected for the cluster.
resource_group_idOptional
resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of resource group.
service_cidrOptional
service_cidr: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment.
When the system is selected to automatically create a VPC, the network segment 172.19.0.0/20 is used by default.
service_discovery_typesOptional
service_discovery_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property serviceDiscoveryTypes: Intra-cluster service discovery type, used to specify the service discovery method in the ASK cluster.
CoreDNS: To use Kubernetes native standard service discovery component CoreDNS, a set of containers needs to be deployed in the cluster for DNS resolution. By default, two ECI instances with a size of 0.25 Core and 512 MiB are used. PrivateZone: To use Alibaba Cloud PrivateZone products to provide service discovery capabilities, the PrivateZone service needs to be enabled. Default value: off
sls_project_nameOptional
sls_project_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property slsProjectName: The SLS project name of the cluster.
If LoggingType is set to SLS and SlsProjectName is empty, a new Project is created.
snat_entryOptional
snat_entry: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property snatEntry: Whether to configure SNAT for the network.
When a VPC can access the public network environment, set it to false. When an existing VPC cannot access the public network environment: When set to True, SNAT is configured and the public network environment can be accessed at this time. If set to false, it means that SNAT is not configured and the public network environment cannot be accessed at this time. Default to true.
tagsOptional
tags: typing.List[TagsProperty]
- Type: typing.List[TagsProperty]
Property tags: Tag the cluster.
time_zoneOptional
time_zone: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property timeZone: The time zone of the cluster.
vpc_idOptional
vpc_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: VPC ID.
v_switch_idsOptional
v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property vSwitchIds: The IDs of VSwitches.
If you leave this property empty, the system automatically creates a VSwitch. Note You must specify both the VpcId and VSwitchIds or leave both of them empty.
zone_idsOptional
zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property zoneIds: The zone IDs of the cluster.