Skip to content

ClusterHelmApplicationProps

Properties for defining a ClusterHelmApplication.

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

Initializer

import ros_cdk_cs
ros_cdk_cs.ClusterHelmApplicationProps(
  chart_url: typing.Union[str, IResolvable],
  cluster_id: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  chart_values: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  credential: typing.Union[IResolvable, CredentialProperty] = None,
  ignore_existing: typing.Union[str, IResolvable] = None,
  namespace: typing.Union[str, IResolvable] = None,
  namespace_deletion: typing.Union[bool, IResolvable] = None,
  role_policy: 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
chart_url typing.Union[str, ros_cdk_core.IResolvable] Property chartUrl: The URL of chart.
cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property clusterId: The ID of the kubernetes cluster.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name for helm release.
chart_values typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property chartValues: Chart custom values.
credential typing.Union[ros_cdk_core.IResolvable, CredentialProperty] Property credential: The credential of ACR repo.
ignore_existing typing.Union[str, ros_cdk_core.IResolvable] Property ignoreExisting: How to ignore existing helm application: Disabled(default): If a helm application with the same name exists, an error will be reported when creating it.
namespace typing.Union[str, ros_cdk_core.IResolvable] Property namespace: Namespace to use with helm.
namespace_deletion typing.Union[bool, ros_cdk_core.IResolvable] Property namespaceDeletion: Whether to delete the namespace specified.
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.
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.

chart_urlRequired

chart_url: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property chartUrl: The URL of chart.

Supports HTTP or HTTPS.


cluster_idRequired

cluster_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterId: The ID of the kubernetes cluster.


nameRequired

name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name for helm release.


chart_valuesOptional

chart_values: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property chartValues: Chart custom values.


credentialOptional

credential: typing.Union[IResolvable, CredentialProperty]

Property credential: The credential of ACR repo.

Only take effects when ChartUrl is the address of ACR repo.


ignore_existingOptional

ignore_existing: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ignoreExisting: How to ignore existing helm application: Disabled(default): If a helm application with the same name exists, an error will be reported when creating it.

SkipInstallIfExisting: If there is a helm application with the same name, the helm application creation process will be ignored. SkipAllOperationsIfExisting: If there is a helm application with the same name, the helm application creation process will be ignored. If the helm application is not created by this resource, it will be ignored during update and delete stage.


namespaceOptional

namespace: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property namespace: Namespace to use with helm.

Default is default. If the Namespace does not exist, ROS will automatically create it and delete it during the deletion phase.


namespace_deletionOptional

namespace_deletion: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property namespaceDeletion: Whether to delete the namespace specified.

If Namespace is in ('default', 'kube-node-lease', 'kube-public', 'kube-system', 'arms-prom'), no matter whether NamespaceDeletion 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.

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 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.