Skip to content

ClusterApplicationProps

Properties for defining a ClusterApplication.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cs-clusterapplication

Initializer

import { ClusterApplicationProps } from '@alicloud/ros-cdk-cs'
const clusterApplicationProps: ClusterApplicationProps = { ... }

Properties

Name Type Description
clusterId string | @alicloud/ros-cdk-core.IResolvable Property clusterId: The ID of the kubernetes cluster.
yamlContent string | @alicloud/ros-cdk-core.IResolvable Property yamlContent: The yaml content of application.
creationMode string | @alicloud/ros-cdk-core.IResolvable Property creationMode: Creation modes include: - Normal: create new resources, will report error if already exists.
defaultNamespace string | @alicloud/ros-cdk-core.IResolvable Property defaultNamespace: The default namespace for the application, default value is default.
defaultNamespaceDeletion boolean | @alicloud/ros-cdk-core.IResolvable Property defaultNamespaceDeletion: Whether to delete the namespace specified by DefaultNamespace.
rolePolicy string | @alicloud/ros-cdk-core.IResolvable Property rolePolicy: Before deploying the application, check the policies associated with the roles of the current user.
stage string | @alicloud/ros-cdk-core.IResolvable Property stage: At what stage to run.
validationMode string | @alicloud/ros-cdk-core.IResolvable Property validationMode: Validation modes include: - Basic: basic validation, such as verifying the existence of a cluster.
waitUntil @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | WaitUntilProperty[] Property waitUntil: After starting a creation or update, wait until all conditions are met.

clusterIdRequired

public readonly clusterId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property clusterId: The ID of the kubernetes cluster.


yamlContentRequired

public readonly yamlContent: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property yamlContent: The yaml content of application.


creationModeOptional

public readonly creationMode: string | IResolvable;
  • Type: string | @alicloud/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.


defaultNamespaceOptional

public readonly defaultNamespace: string | IResolvable;
  • Type: string | @alicloud/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.


defaultNamespaceDeletionOptional

public readonly defaultNamespaceDeletion: boolean | IResolvable;
  • Type: boolean | @alicloud/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.


rolePolicyOptional

public readonly rolePolicy: string | IResolvable;
  • Type: string | @alicloud/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

public readonly stage: string | IResolvable;
  • Type: string | @alicloud/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.


validationModeOptional

public readonly validationMode: string | IResolvable;
  • Type: string | @alicloud/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.


waitUntilOptional

public readonly waitUntil: IResolvable | IResolvable | WaitUntilProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | WaitUntilProperty[]

Property waitUntil: After starting a creation or update, wait until all conditions are met.