Skip to content

K8sApplicationProps

Properties for defining a K8sApplication.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-edas-k8sapplication

Initializer 

import ros_cdk_edas
ros_cdk_edas.K8sApplicationProps(
  app_name: typing.Union[str, IResolvable],
  cluster_id: typing.Union[str, IResolvable],
  application_description: typing.Union[str, IResolvable] = None,
  command: typing.Union[str, IResolvable] = None,
  command_args: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CommandArgsProperty]]] = None,
  deploy_across_nodes: typing.Union[bool, IResolvable] = None,
  deploy_across_zones: typing.Union[bool, IResolvable] = None,
  edas_container_version: typing.Union[str, IResolvable] = None,
  enable_ahas: typing.Union[bool, IResolvable] = None,
  envs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvsProperty]]] = None,
  image_url: typing.Union[str, IResolvable] = None,
  internet_slb_id: typing.Union[str, IResolvable] = None,
  internet_slb_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  internet_slb_protocol: typing.Union[str, IResolvable] = None,
  internet_target_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  intranet_slb_id: typing.Union[str, IResolvable] = None,
  intranet_slb_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  intranet_slb_protocol: typing.Union[str, IResolvable] = None,
  intranet_target_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  is_multilingual_app: typing.Union[bool, IResolvable] = None,
  java_start_up_config: typing.Union[IResolvable, JavaStartUpConfigProperty] = None,
  jdk: typing.Union[str, IResolvable] = None,
  limit_cpu: typing.Union[typing.Union[int, float], IResolvable] = None,
  limit_mem: typing.Union[typing.Union[int, float], IResolvable] = None,
  liveness: typing.Union[IResolvable, LivenessProperty] = None,
  local_volume: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LocalVolumeProperty]]] = None,
  logical_region_id: typing.Union[str, IResolvable] = None,
  mount_descs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MountDescsProperty]]] = None,
  namespace: typing.Union[str, IResolvable] = None,
  nas_id: typing.Union[str, IResolvable] = None,
  package_type: typing.Union[str, IResolvable] = None,
  package_url: typing.Union[str, IResolvable] = None,
  package_version: typing.Union[str, IResolvable] = None,
  post_start: typing.Union[IResolvable, PostStartProperty] = None,
  pre_stop: typing.Union[IResolvable, PreStopProperty] = None,
  readiness: typing.Union[IResolvable, ReadinessProperty] = None,
  replicas: typing.Union[typing.Union[int, float], IResolvable] = None,
  repo_id: typing.Union[str, IResolvable] = None,
  requests_cpu: typing.Union[typing.Union[int, float], IResolvable] = None,
  requests_mem: typing.Union[typing.Union[int, float], IResolvable] = None,
  runtime_class_name: typing.Union[str, IResolvable] = None,
  sls_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SlsConfigsProperty]]] = None,
  storage_type: typing.Union[str, IResolvable] = None,
  timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  uri_encoding: typing.Union[str, IResolvable] = None,
  use_body_encoding: typing.Union[bool, IResolvable] = None,
  web_container: typing.Union[str, IResolvable] = None,
  web_container_config: typing.Union[IResolvable, WebContainerConfigProperty] = None
)

Properties

Name Type Description
app_name typing.Union[str, ros_cdk_core.IResolvable] Property appName: The name of the application.
cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property clusterId: The cluster ID.
application_description typing.Union[str, ros_cdk_core.IResolvable] Property applicationDescription: The description of the application.
command typing.Union[str, ros_cdk_core.IResolvable] Property command: The command that is specified.
command_args typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CommandArgsProperty]]] Property commandArgs: The collection of commands.
deploy_across_nodes typing.Union[bool, ros_cdk_core.IResolvable] Property deployAcrossNodes: Specifies whether to distribute application instances to multiple nodes.
deploy_across_zones typing.Union[bool, ros_cdk_core.IResolvable] Property deployAcrossZones: Specifies whether to distribute application instances to multiple zones.
edas_container_version typing.Union[str, ros_cdk_core.IResolvable] Property edasContainerVersion: The version of EDAS Container on which the deployment package of the application depends.
enable_ahas typing.Union[bool, ros_cdk_core.IResolvable] Property enableAhas: Specifies whether to enable access to Application High Availability Service (AHAS).
envs typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EnvsProperty]]] Property envs: The collection of deployment environment variables.
image_url typing.Union[str, ros_cdk_core.IResolvable] Property imageUrl: The image URL.
internet_slb_id typing.Union[str, ros_cdk_core.IResolvable] Property internetSlbId: The ID of the Internet-facing SLB instance.
internet_slb_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property internetSlbPort: The frontend port of the Internet-facing SLB instance.
internet_slb_protocol typing.Union[str, ros_cdk_core.IResolvable] Property internetSlbProtocol: The protocol of the Internet-facing SLB instance.
internet_target_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property internetTargetPort: The backend port of the internal-facing SLB instance, which is also the service port of the application.
intranet_slb_id typing.Union[str, ros_cdk_core.IResolvable] Property intranetSlbId: The ID of the internal-facing SLB instance.
intranet_slb_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property intranetSlbPort: The frontend port of the internal-facing SLB instance.
intranet_slb_protocol typing.Union[str, ros_cdk_core.IResolvable] Property intranetSlbProtocol: The protocol of the internal-facing SLB instance.
intranet_target_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property intranetTargetPort: The backend port of the internal-facing Server Load Balancer (SLB) instance, which is also the service port of the application.
is_multilingual_app typing.Union[bool, ros_cdk_core.IResolvable] Property isMultilingualApp: Specifies whether the application is a multi-language application.
java_start_up_config typing.Union[ros_cdk_core.IResolvable, JavaStartUpConfigProperty] Property javaStartUpConfig: The configuration of Java startup parameters for a Java application.
jdk typing.Union[str, ros_cdk_core.IResolvable] Property jdk: The version of Java Development Kit (JDK) on which the deployment package of the application depends.
limit_cpu typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property limitCpu: The maximum number of CPUs allowed for each application instance when the application is running.
limit_mem typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property limitMem: The maximum amount of memory allowed for each application instance when the application is running.
liveness typing.Union[ros_cdk_core.IResolvable, LivenessProperty] Property liveness: The liveness check on the container.
local_volume typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LocalVolumeProperty]]] Property localVolume: The configuration for mounting host files to the container where the application is running.
logical_region_id typing.Union[str, ros_cdk_core.IResolvable] Property logicalRegionId: The ID of the EDAS namespace.
mount_descs typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MountDescsProperty]]] Property mountDescs: The description of the NAS mounting configuration.
namespace typing.Union[str, ros_cdk_core.IResolvable] Property namespace: The namespace of the Kubernetes cluster.
nas_id typing.Union[str, ros_cdk_core.IResolvable] Property nasId: The ID of the Network Attached Storage (NAS) file system mounted to the container where the application is running.
package_type typing.Union[str, ros_cdk_core.IResolvable] Property packageType: The type of the deployment package.
package_url typing.Union[str, ros_cdk_core.IResolvable] Property packageUrl: The URL of the deployment package.
package_version typing.Union[str, ros_cdk_core.IResolvable] Property packageVersion: The version of the deployment package.
post_start typing.Union[ros_cdk_core.IResolvable, PostStartProperty] Property postStart: The post-start script.
pre_stop typing.Union[ros_cdk_core.IResolvable, PreStopProperty] Property preStop: The pre-stop script.
readiness typing.Union[ros_cdk_core.IResolvable, ReadinessProperty] Property readiness: The readiness check on the container.
replicas typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property replicas: The number of instances for the application that you want to create.
repo_id typing.Union[str, ros_cdk_core.IResolvable] Property repoId: The ID of the image repository.
requests_cpu typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property requestsCpu: The maximum number of CPUs allowed for each application instance when the application is created.
requests_mem typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property requestsMem: The maximum amount of memory allowed for each application instance when the application is created.
runtime_class_name typing.Union[str, ros_cdk_core.IResolvable] Property runtimeClassName: The type of the container runtime.
sls_configs typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SlsConfigsProperty]]] Property slsConfigs: The Logstore configurations.
storage_type typing.Union[str, ros_cdk_core.IResolvable] Property storageType: Only SSD is supported.
timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property timeout: The timeout interval of the change process.
uri_encoding typing.Union[str, ros_cdk_core.IResolvable] Property uriEncoding: The uniform resource identifier (URI) encoding scheme.
use_body_encoding typing.Union[bool, ros_cdk_core.IResolvable] Property useBodyEncoding: Specifies whether useBodyEncodingForURI is enabled.
web_container typing.Union[str, ros_cdk_core.IResolvable] Property webContainer: The version of the Tomcat container on which the deployment package of the application depends.
web_container_config typing.Union[ros_cdk_core.IResolvable, WebContainerConfigProperty] Property webContainerConfig: The Tomcat container configuration.

app_nameRequired 

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

Property appName: The name of the application.

The name must start with a letter and can contain digits, letters, and hyphens (-). It can be up to 36 characters in length.

cluster_idRequired 

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

Property clusterId: The cluster ID.

You can query the cluster ID by calling the ListCluster operation. For more information, see ListCluster.

application_descriptionOptional 

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

Property applicationDescription: The description of the application.

commandOptional 

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

Property command: The command that is specified.

If it is specified, it replaces the startup command in the image when the image is started.

command_argsOptional 

command_args: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CommandArgsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CommandArgsProperty]]]

Property commandArgs: The collection of commands.

For example, [{"argument":"-c"},{"argument":"test"}], where -c and test are two parameters that can be set.

deploy_across_nodesOptional 

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

Property deployAcrossNodes: Specifies whether to distribute application instances to multiple nodes.

The value true indicates yes, whereas other values indicate no.

deploy_across_zonesOptional 

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

Property deployAcrossZones: Specifies whether to distribute application instances to multiple zones.

The value true indicates yes, whereas other values indicate no.

edas_container_versionOptional 

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

Property edasContainerVersion: The version of EDAS Container on which the deployment package of the application depends.

Note This parameter is not supported when you deploy an application by using images.

enable_ahasOptional 

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

Property enableAhas: Specifies whether to enable access to Application High Availability Service (AHAS).

envsOptional 

envs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EnvsProperty]]]

Property envs: The collection of deployment environment variables.

For example, [{"Name":"x","Value":"y"},{"Name":"x2","Value":"y2"}].

image_urlOptional 

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

Property imageUrl: The image URL.

When PackageType is set to Image, this parameter is required.

internet_slb_idOptional 

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

Property internetSlbId: The ID of the Internet-facing SLB instance.

If this parameter is not specified, EDAS automatically purchases a new SLB instance for you.

internet_slb_portOptional 

internet_slb_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property internetSlbPort: The frontend port of the Internet-facing SLB instance.

Valid values: 1 to 65535.

internet_slb_protocolOptional 

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

Property internetSlbProtocol: The protocol of the Internet-facing SLB instance.

Valid values: TCP, HTTP, and HTTPS.

internet_target_portOptional 

internet_target_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property internetTargetPort: The backend port of the internal-facing SLB instance, which is also the service port of the application.

Valid values: 1 to 65535.

intranet_slb_idOptional 

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

Property intranetSlbId: The ID of the internal-facing SLB instance.

If this parameter is not specified, Enterprise Distributed Application Service (EDAS) automatically purchases a new SLB instance for you.

intranet_slb_portOptional 

intranet_slb_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property intranetSlbPort: The frontend port of the internal-facing SLB instance.

Valid values: 1 to 65535.

intranet_slb_protocolOptional 

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

Property intranetSlbProtocol: The protocol of the internal-facing SLB instance.

Valid values: TCP, HTTP, and HTTPS.

intranet_target_portOptional 

intranet_target_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property intranetTargetPort: The backend port of the internal-facing Server Load Balancer (SLB) instance, which is also the service port of the application.

Valid values: 1 to 65535.

is_multilingual_appOptional 

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

Property isMultilingualApp: Specifies whether the application is a multi-language application.

java_start_up_configOptional 

java_start_up_config: typing.Union[IResolvable, JavaStartUpConfigProperty]

Property javaStartUpConfig: The configuration of Java startup parameters for a Java application.

These startup parameters involve the memory, application, garbage collection (GC) policy, tools, service registration and discovery, and custom configurations. Proper parameter settings help reduce the GC overhead, shorten the server response time, and improve the throughput. The system automatically concatenates all startup values as the configuration of Java startup parameters for the application.

jdkOptional 

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

Property jdk: The version of Java Development Kit (JDK) on which the deployment package of the application depends.

Valid values: Open JDK 7 and Open JDK 8. This parameter is not supported when you deploy an application by using images.

limit_cpuOptional 

limit_cpu: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property limitCpu: The maximum number of CPUs allowed for each application instance when the application is running.

Unit: cores.

limit_memOptional 

limit_mem: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property limitMem: The maximum amount of memory allowed for each application instance when the application is running.

Unit: MB.

livenessOptional 

liveness: typing.Union[IResolvable, LivenessProperty]

Property liveness: The liveness check on the container.

local_volumeOptional 

local_volume: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LocalVolumeProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, LocalVolumeProperty]]]

Property localVolume: The configuration for mounting host files to the container where the application is running.

For example, the value can be [{"type":"", "nodePath":"/localfiles", "mountPath":"/app/files"}, {"type":"Directory", "nodePath":"/mnt", "mountPath":"/app/storage"}].

logical_region_idOptional 

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

Property logicalRegionId: The ID of the EDAS namespace.

This parameter is required for a non-default namespace.

mount_descsOptional 

mount_descs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MountDescsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MountDescsProperty]]]

Property mountDescs: The description of the NAS mounting configuration.

For example, the value can be [{"NasPath": "/k8s","MountPath": "/mnt"}, {"NasPath": "/files", "MountPath": "/app/files"}].

namespaceOptional 

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

Property namespace: The namespace of the Kubernetes cluster.

This parameter determines the Kubernetes namespace where your application is deployed. By default, this parameter is set to default.

nas_idOptional 

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

Property nasId: The ID of the Network Attached Storage (NAS) file system mounted to the container where the application is running.

The NAS file system must be in the same region as the cluster. The NAS file system must have an available mount target, or have a mount target on the vSwitch in the virtual private cloud (VPC) where the application is located. If this parameter is not specified and the mountDescs field exists, a NAS file system is automatically purchased and mounted to the vSwitch in the VPC by default.

package_typeOptional 

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

Property packageType: The type of the deployment package.

Valid values: FatJar, WAR, and Image.

package_urlOptional 

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

Property packageUrl: The URL of the deployment package.

This parameter must be set for the applications that are deployed by using FatJar or WAR packages. Note The version of SDK for Java or Python must be 2.44.0 or later.

package_versionOptional 

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

Property packageVersion: The version of the deployment package.

This parameter is required when the PackageType parameter is set to WAR or FatJar. You must specify a version. Note The version of SDK for Java or Python must be 2.44.0 or later.

post_startOptional 

post_start: typing.Union[IResolvable, PostStartProperty]

Property postStart: The post-start script.

For example, {"Exec": {"Command": ["ls", "/"]}}.

pre_stopOptional 

pre_stop: typing.Union[IResolvable, PreStopProperty]

Property preStop: The pre-stop script.

For example, {"Exec": {"Command": ["ls", "/"]}}.

readinessOptional 

readiness: typing.Union[IResolvable, ReadinessProperty]

Property readiness: The readiness check on the container.

replicasOptional 

replicas: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property replicas: The number of instances for the application that you want to create.

Default: 1

repo_idOptional 

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

Property repoId: The ID of the image repository.

requests_cpuOptional 

requests_cpu: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property requestsCpu: The maximum number of CPUs allowed for each application instance when the application is created.

Unit: cores. The value 0 indicates no limit.

requests_memOptional 

requests_mem: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property requestsMem: The maximum amount of memory allowed for each application instance when the application is created.

Unit: MB. The value 0 indicates no limit.

runtime_class_nameOptional 

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

Property runtimeClassName: The type of the container runtime.

This parameter is applicable only to clusters that use sandboxed containers.

sls_configsOptional 

sls_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SlsConfigsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SlsConfigsProperty]]]

Property slsConfigs: The Logstore configurations.

storage_typeOptional 

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

Property storageType: Only SSD is supported.

timeoutOptional 

timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property timeout: The timeout interval of the change process.

Unit: seconds.

uri_encodingOptional 

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

Property uriEncoding: The uniform resource identifier (URI) encoding scheme.

Valid values: ISO-8859-1, GBK, GB2312, and UTF-8. Note If this parameter is not specified in application configuration, the default URI encoding scheme in the Tomcat container is applied.

use_body_encodingOptional 

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

Property useBodyEncoding: Specifies whether useBodyEncodingForURI is enabled.

Note If this parameter is not specified in application configuration, the default value false is applied.

web_containerOptional 

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

Property webContainer: The version of the Tomcat container on which the deployment package of the application depends.

This parameter is applicable to Spring Cloud and Apache Dubbo applications that are deployed by using WAR packages. This parameter is not supported when you deploy an application by using images.

web_container_configOptional 

web_container_config: typing.Union[IResolvable, WebContainerConfigProperty]

Property webContainerConfig: The Tomcat container configuration.