Skip to content

K8sApplicationProps

Properties for defining a K8sApplication.

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

Initializer 

import { K8sApplicationProps } from '@alicloud/ros-cdk-edas'
const k8sApplicationProps: K8sApplicationProps = { ... }

Properties

Name Type Description
appName string | @alicloud/ros-cdk-core.IResolvable Property appName: The name of the application.
clusterId string | @alicloud/ros-cdk-core.IResolvable Property clusterId: The cluster ID.
applicationDescription string | @alicloud/ros-cdk-core.IResolvable Property applicationDescription: The description of the application.
command string | @alicloud/ros-cdk-core.IResolvable Property command: The command that is specified.
commandArgs @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | CommandArgsProperty[] Property commandArgs: The collection of commands.
deployAcrossNodes boolean | @alicloud/ros-cdk-core.IResolvable Property deployAcrossNodes: Specifies whether to distribute application instances to multiple nodes.
deployAcrossZones boolean | @alicloud/ros-cdk-core.IResolvable Property deployAcrossZones: Specifies whether to distribute application instances to multiple zones.
edasContainerVersion string | @alicloud/ros-cdk-core.IResolvable Property edasContainerVersion: The version of EDAS Container on which the deployment package of the application depends.
enableAhas boolean | @alicloud/ros-cdk-core.IResolvable Property enableAhas: Specifies whether to enable access to Application High Availability Service (AHAS).
envs @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | EnvsProperty[] Property envs: The collection of deployment environment variables.
imageUrl string | @alicloud/ros-cdk-core.IResolvable Property imageUrl: The image URL.
internetSlbId string | @alicloud/ros-cdk-core.IResolvable Property internetSlbId: The ID of the Internet-facing SLB instance.
internetSlbPort number | @alicloud/ros-cdk-core.IResolvable Property internetSlbPort: The frontend port of the Internet-facing SLB instance.
internetSlbProtocol string | @alicloud/ros-cdk-core.IResolvable Property internetSlbProtocol: The protocol of the Internet-facing SLB instance.
internetTargetPort number | @alicloud/ros-cdk-core.IResolvable Property internetTargetPort: The backend port of the internal-facing SLB instance, which is also the service port of the application.
intranetSlbId string | @alicloud/ros-cdk-core.IResolvable Property intranetSlbId: The ID of the internal-facing SLB instance.
intranetSlbPort number | @alicloud/ros-cdk-core.IResolvable Property intranetSlbPort: The frontend port of the internal-facing SLB instance.
intranetSlbProtocol string | @alicloud/ros-cdk-core.IResolvable Property intranetSlbProtocol: The protocol of the internal-facing SLB instance.
intranetTargetPort number | @alicloud/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.
isMultilingualApp boolean | @alicloud/ros-cdk-core.IResolvable Property isMultilingualApp: Specifies whether the application is a multi-language application.
javaStartUpConfig @alicloud/ros-cdk-core.IResolvable | JavaStartUpConfigProperty Property javaStartUpConfig: The configuration of Java startup parameters for a Java application.
jdk string | @alicloud/ros-cdk-core.IResolvable Property jdk: The version of Java Development Kit (JDK) on which the deployment package of the application depends.
limitCpu number | @alicloud/ros-cdk-core.IResolvable Property limitCpu: The maximum number of CPUs allowed for each application instance when the application is running.
limitMem number | @alicloud/ros-cdk-core.IResolvable Property limitMem: The maximum amount of memory allowed for each application instance when the application is running.
liveness @alicloud/ros-cdk-core.IResolvable | LivenessProperty Property liveness: The liveness check on the container.
localVolume @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | LocalVolumeProperty[] Property localVolume: The configuration for mounting host files to the container where the application is running.
logicalRegionId string | @alicloud/ros-cdk-core.IResolvable Property logicalRegionId: The ID of the EDAS namespace.
mountDescs @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MountDescsProperty[] Property mountDescs: The description of the NAS mounting configuration.
namespace string | @alicloud/ros-cdk-core.IResolvable Property namespace: The namespace of the Kubernetes cluster.
nasId string | @alicloud/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.
packageType string | @alicloud/ros-cdk-core.IResolvable Property packageType: The type of the deployment package.
packageUrl string | @alicloud/ros-cdk-core.IResolvable Property packageUrl: The URL of the deployment package.
packageVersion string | @alicloud/ros-cdk-core.IResolvable Property packageVersion: The version of the deployment package.
postStart @alicloud/ros-cdk-core.IResolvable | PostStartProperty Property postStart: The post-start script.
preStop @alicloud/ros-cdk-core.IResolvable | PreStopProperty Property preStop: The pre-stop script.
readiness @alicloud/ros-cdk-core.IResolvable | ReadinessProperty Property readiness: The readiness check on the container.
replicas number | @alicloud/ros-cdk-core.IResolvable Property replicas: The number of instances for the application that you want to create.
repoId string | @alicloud/ros-cdk-core.IResolvable Property repoId: The ID of the image repository.
requestsCpu number | @alicloud/ros-cdk-core.IResolvable Property requestsCpu: The maximum number of CPUs allowed for each application instance when the application is created.
requestsMem number | @alicloud/ros-cdk-core.IResolvable Property requestsMem: The maximum amount of memory allowed for each application instance when the application is created.
runtimeClassName string | @alicloud/ros-cdk-core.IResolvable Property runtimeClassName: The type of the container runtime.
slsConfigs @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SlsConfigsProperty[] Property slsConfigs: The Logstore configurations.
storageType string | @alicloud/ros-cdk-core.IResolvable Property storageType: Only SSD is supported.
timeout number | @alicloud/ros-cdk-core.IResolvable Property timeout: The timeout interval of the change process.
uriEncoding string | @alicloud/ros-cdk-core.IResolvable Property uriEncoding: The uniform resource identifier (URI) encoding scheme.
useBodyEncoding boolean | @alicloud/ros-cdk-core.IResolvable Property useBodyEncoding: Specifies whether useBodyEncodingForURI is enabled.
webContainer string | @alicloud/ros-cdk-core.IResolvable Property webContainer: The version of the Tomcat container on which the deployment package of the application depends.
webContainerConfig @alicloud/ros-cdk-core.IResolvable | WebContainerConfigProperty Property webContainerConfig: The Tomcat container configuration.

appNameRequired 

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

clusterIdRequired 

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

applicationDescriptionOptional 

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

Property applicationDescription: The description of the application.

commandOptional 

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

commandArgsOptional 

public readonly commandArgs: IResolvable | IResolvable | CommandArgsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/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.

deployAcrossNodesOptional 

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

deployAcrossZonesOptional 

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

edasContainerVersionOptional 

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

enableAhasOptional 

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

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

envsOptional 

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

Property envs: The collection of deployment environment variables.

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

imageUrlOptional 

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

Property imageUrl: The image URL.

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

internetSlbIdOptional 

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

internetSlbPortOptional 

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

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

Valid values: 1 to 65535.

internetSlbProtocolOptional 

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

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

Valid values: TCP, HTTP, and HTTPS.

internetTargetPortOptional 

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

intranetSlbIdOptional 

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

intranetSlbPortOptional 

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

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

Valid values: 1 to 65535.

intranetSlbProtocolOptional 

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

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

Valid values: TCP, HTTP, and HTTPS.

intranetTargetPortOptional 

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

isMultilingualAppOptional 

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

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

javaStartUpConfigOptional 

public readonly javaStartUpConfig: 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 

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

limitCpuOptional 

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

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

Unit: cores.

limitMemOptional 

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

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

Unit: MB.

livenessOptional 

public readonly liveness: IResolvable | LivenessProperty;

Property liveness: The liveness check on the container.

localVolumeOptional 

public readonly localVolume: IResolvable | IResolvable | LocalVolumeProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/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"}].

logicalRegionIdOptional 

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

Property logicalRegionId: The ID of the EDAS namespace.

This parameter is required for a non-default namespace.

mountDescsOptional 

public readonly mountDescs: IResolvable | IResolvable | MountDescsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/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 

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

nasIdOptional 

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

packageTypeOptional 

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

Property packageType: The type of the deployment package.

Valid values: FatJar, WAR, and Image.

packageUrlOptional 

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

packageVersionOptional 

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

postStartOptional 

public readonly postStart: IResolvable | PostStartProperty;

Property postStart: The post-start script.

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

preStopOptional 

public readonly preStop: IResolvable | PreStopProperty;

Property preStop: The pre-stop script.

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

readinessOptional 

public readonly readiness: IResolvable | ReadinessProperty;

Property readiness: The readiness check on the container.

replicasOptional 

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

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

Default: 1

repoIdOptional 

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

Property repoId: The ID of the image repository.

requestsCpuOptional 

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

requestsMemOptional 

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

runtimeClassNameOptional 

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

Property runtimeClassName: The type of the container runtime.

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

slsConfigsOptional 

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

Property slsConfigs: The Logstore configurations.

storageTypeOptional 

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

Property storageType: Only SSD is supported.

timeoutOptional 

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

Property timeout: The timeout interval of the change process.

Unit: seconds.

uriEncodingOptional 

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

useBodyEncodingOptional 

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

webContainerOptional 

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

webContainerConfigOptional 

public readonly webContainerConfig: IResolvable | WebContainerConfigProperty;

Property webContainerConfig: The Tomcat container configuration.