Skip to content

ClusterApplicationProps

Properties for defining a ClusterApplication.

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

Initializer

import com.aliyun.ros.cdk.cs.ClusterApplicationProps;
ClusterApplicationProps.builder()
    .clusterId(java.lang.String)
    .clusterId(IResolvable)
    .yamlContent(java.lang.String)
    .yamlContent(IResolvable)
//  .creationMode(java.lang.String)
//  .creationMode(IResolvable)
//  .defaultNamespace(java.lang.String)
//  .defaultNamespace(IResolvable)
//  .defaultNamespaceDeletion(java.lang.Boolean)
//  .defaultNamespaceDeletion(IResolvable)
//  .rolePolicy(java.lang.String)
//  .rolePolicy(IResolvable)
//  .stage(java.lang.String)
//  .stage(IResolvable)
//  .validationMode(java.lang.String)
//  .validationMode(IResolvable)
//  .waitUntil(IResolvable)
//  .waitUntil(java.util.List<IResolvable)
//  .waitUntil(WaitUntilProperty>)
    .build();

Properties

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

clusterIdRequired

public java.lang.Object getClusterId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property clusterId: The ID of the kubernetes cluster.


yamlContentRequired

public java.lang.Object getYamlContent();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property yamlContent: The yaml content of application.


creationModeOptional

public java.lang.Object getCreationMode();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDefaultNamespace();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDefaultNamespaceDeletion();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getRolePolicy();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getStage();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getValidationMode();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getWaitUntil();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListWaitUntilProperty>

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