ClusterApplicationProps
Properties for defining a ClusterApplication.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cs-clusterapplication
Initializer
import ros_cdk_cs
ros_cdk_cs.ClusterApplicationProps(
cluster_id: typing.Union[str, IResolvable],
yaml_content: typing.Union[str, IResolvable],
creation_mode: typing.Union[str, IResolvable] = None,
default_namespace: typing.Union[str, IResolvable] = None,
default_namespace_deletion: typing.Union[bool, IResolvable] = None,
role_policy: typing.Union[str, IResolvable] = None,
stage: typing.Union[str, IResolvable] = None,
validation_mode: typing.Union[str, IResolvable] = None,
wait_until: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, WaitUntilProperty]]] = None
)
Properties
| Name | Type | Description |
|---|---|---|
cluster_id | typing.Union[str, ros_cdk_core.IResolvable] | Property clusterId: The ID of the kubernetes cluster. |
yaml_content | typing.Union[str, ros_cdk_core.IResolvable] | Property yamlContent: The yaml content of application. |
creation_mode | typing.Union[str, ros_cdk_core.IResolvable] | Property creationMode: Creation modes include: - Normal: create new resources, will report error if already exists. |
default_namespace | typing.Union[str, ros_cdk_core.IResolvable] | Property defaultNamespace: The default namespace for the application, default value is default. |
default_namespace_deletion | typing.Union[bool, ros_cdk_core.IResolvable] | Property defaultNamespaceDeletion: Whether to delete the namespace specified by DefaultNamespace. |
role_policy | typing.Union[str, ros_cdk_core.IResolvable] | Property rolePolicy: Before deploying the application, check the policies associated with the roles of the current user. |
stage | typing.Union[str, ros_cdk_core.IResolvable] | Property stage: At what stage to run. |
validation_mode | typing.Union[str, ros_cdk_core.IResolvable] | Property validationMode: Validation modes include: - Basic: basic validation, such as verifying the existence of a cluster. |
wait_until | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, WaitUntilProperty]]] | Property waitUntil: After starting a creation or update, wait until all conditions are met. |
cluster_idRequired
cluster_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property clusterId: The ID of the kubernetes cluster.
yaml_contentRequired
yaml_content: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property yamlContent: The yaml content of application.
creation_modeOptional
creation_mode: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property creationMode: Creation modes include: - Normal: create new resources, will report error if already exists.
- Apply: similar to kubectl apply, create if not exists, update if exists. During the deletion phase, ROS will delete newly created application, but updated existing application will not be deleted.
default_namespaceOptional
default_namespace: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property defaultNamespace: The default namespace for the application, default value is default.
If a namespace is defined in yaml metadata, its priority is higher than DefaultNamespace. If the DefaultNamespace does not exist, ROS will create it automatically and keep it by default during the delete phase.
default_namespace_deletionOptional
default_namespace_deletion: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property defaultNamespaceDeletion: Whether to delete the namespace specified by DefaultNamespace.
If DefaultNamespace is in ('default', 'kube-node-lease', 'kube-public', 'kube-system', 'arms-prom'), no matter whether DefaultNamespaceDeletion is true or not, it will not be deleted.
role_policyOptional
role_policy: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property rolePolicy: Before deploying the application, check the policies associated with the roles of the current user.
Valid values:
- EnsureAdminRoleAndBinding: Automatically create a role named "ros:application-admin:${user-id}" with administrator permissions and bind it to the current user.
- None: Do nothing. The default value is EnsureAdminRoleAndBinding.
stageOptional
stage: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property stage: At what stage to run.
Valid values:
- All: all stages, including create, update, and delete.
- Delete: the delete stage. This means that only in the deletion stage of this resource will apply yaml to the cluster. The default is All.
validation_modeOptional
validation_mode: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property validationMode: Validation modes include: - Basic: basic validation, such as verifying the existence of a cluster.
- Strict: in addition to basic validation, also validate the legality of YamlContent and WaitUntil.
wait_untilOptional
wait_until: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, WaitUntilProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, WaitUntilProperty]]]
Property waitUntil: After starting a creation or update, wait until all conditions are met.