Enterprise Distributed Application Service:InsertK8sApplication

The backend port of the internal-facing SLB instance. This is also the service port of the application. The value must be in the range of 1 to 65535.

The frontend port of the internal-facing SLB instance. The value must be in the range of 1 to 65535.

The address of the image. This parameter is required when you set PackageType to Image.

The description of the application.

The ID of the image repository.

The number of application instances.

The maximum number of CPU cores that can be used by an application instance. If you specify LimitmCpu, this parameter is ignored.

The maximum amount of memory that can be used by an application instance. Unit: MB. The value of LimitMem must be greater than or equal to the value of RequestsMem.

The number of CPU cores requested for an application instance upon creation. Unit: cores. A value of 0 means no limit. If you specify RequestsmCpu, this parameter is ignored.

The amount of memory requested for an application instance upon creation. Unit: MB. A value of 0 means no limit. The value of RequestsMem cannot be greater than the value of LimitMem.

The startup command of the application. If you set this parameter, the original startup command of the image is overridden.

The arguments for the startup command. The arguments are a JSON array of strings. Example: [{"argument":"-c"},{"argument":"test"}]. In this example, -c and test are two arguments.

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

The protocol used by the internal-facing SLB instance. Valid values: TCP, HTTP, and HTTPS.

The ID of the internal-facing SLB instance. If you do not specify this parameter, EDAS automatically purchases a new SLB instance for you.

The ID of the cluster. You can call the ListCluster operation to query the cluster ID. For more information, see ListCluster.

The ID of the internet-facing SLB instance. If you do not specify this parameter, EDAS automatically purchases a new SLB instance for you.

The protocol used by the internet-facing SLB instance. Valid values: TCP, HTTP, and HTTPS.

The frontend port of the internet-facing SLB instance. The value must be in the range of 1 to 65535.

The backend port of the internal SLB instance, which also serves as the service port for the application. The port number must be an integer from 1 to 65535.

The environment variables for the deployment. The value must be a JSON array of objects. Three types of environment variables are supported: regular environment variables, Kubernetes ConfigMap environment variables, and Kubernetes Secret environment variables. The format of a regular environment variable is as follows:

{"name":"x", "value": "y"}

You can use a ConfigMap to inject the value of a specific key into a container's environment variable. The format is as follows:

{ "name": "x2", "valueFrom": { "configMapKeyRef": { "name": "my-config", "key": "y2" } } }

You can use a Secret to inject the value of a specific key into a container's environment variable. The format is as follows:

{ "name": "x3", "valueFrom": { "secretKeyRef": { "name": "my-secret", "key": "y3" } } }

The script that is run before the container is stopped. Example: {"tcpSocket":{"host":"", "port":8080}}.

To clear this configuration, set the value to "" or {}. If you do not set this parameter, it is ignored.

The script that is run after the container is started. Example: {"exec":{"command":["cat","/etc/group"]}}.

To clear this configuration, set the value to "" or {}. If you do not set this parameter, it is ignored.

The liveness probe of the container. Example: {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"tcpSocket":{"host":"", "port":8080}}.

To clear this configuration, set the value to "" or {}. If you do not set this parameter, it is ignored.

The readiness probe of the container. If the check fails, traffic is not routed to the container through the Kubernetes Service. Example: {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": [{"name": "test","value": "testvalue"}]}}.

To clear this configuration, set the value to "" or {}. If you do not set this parameter, it is ignored.

The ID of the NAS file system that you want to mount. If you do not specify this parameter but mountDescs is specified, a new NAS file system is automatically purchased and mounted to a vSwitch in the VPC.

The description of the mount configuration. The value is a serialized JSON string. Example: [{"nasPath": "/k8s","mountPath": "/mnt"},{"nasPath": "/files","mountPath": "/app/files"}]. nasPath specifies the file storage path. mountPath specifies the path to which the file system is mounted in the container.

The storage type of the NAS file system. Valid values:

• General-purpose NAS file systems: Capacity and Performance

• Extreme NAS file systems: Standard and Advance

Currently, only the Performance type is supported.

The configuration for mounting a host file to a container. Example: [{"type":"","nodePath":"/localfiles","mountPath":"/app/files"},{"type":"Directory","nodePath":"/mnt","mountPath":"/app/storage"}]. The following parameters are included:

• nodePath: the path on the host.

• mountPath: the path in the container.

• type: the mount type.

The namespace of the Kubernetes cluster. This parameter determines the Kubernetes namespace in which your application is deployed. The default value is default.

The ID of the EDAS namespace. This parameter is required if you want to use a non-default namespace.

The type of the application package. Valid values: FatJar, WAR, and Image.

The URL of the deployment package. This parameter is required for applications that are deployed using a FatJar or WAR package.

The version number of the deployment package. This parameter is required for WAR and FatJar packages. You can define the meaning of the version number.

The version of the Java Development Kit (JDK) on which the deployment package depends. Valid values: Open JDK 7, Open JDK 8, and Custom OpenJDK. This parameter is not supported for image-based deployments. If you select Custom OpenJDK, you must also specify the UserBaseImageUrl parameter.

The version of the Tomcat container on which the deployment package depends. This parameter is applicable to Spring Cloud and Dubbo applications that are deployed using a WAR package. This parameter is not supported for image-based deployments.

The version of the EDAS-Container on which the deployment package depends.

The URI encoding scheme. Valid values: ISO-8859-1, GBK, GB2312, and UTF-8.

Specifies whether to enable useBodyEncodingForURI.

The number of CPU cores requested for an application instance upon creation. Unit: millicores.

The maximum number of CPU cores that can be used by an application instance. Unit: millicores. A value of 0 means no limit.

The type of the container runtime. This parameter is applicable only to clusters that use sandboxed containers.

Specifies whether to distribute application instances to multiple zones. A value of true means yes. Other values mean no.

The timeout period for the change process. Unit: seconds. The value must be in the range of 1 to 1800. If you do not specify this parameter, the default value 1800 is used.

Specifies whether to enable Application High Availability Service (AHAS):

• true: Enable AHAS.

• false: Do not enable AHAS.

The configuration of the Tomcat container. To clear the configuration, set the value to "" or "{}":

• useDefaultConfig: Specifies whether to use the default configuration. If you set this parameter to true, the custom configuration is not used. If you set this parameter to false, the custom configuration is used. If you do not use the custom configuration, the following parameter settings do not take effect.

• contextInputType: The access path of the application.

  • war: You do not need to specify a custom path. The access path is the name of the WAR package.

  • root: You do not need to specify a custom path. The access path is /.

  • custom: You must specify a custom path in the contextPath parameter.

• contextPath: The custom path. This parameter is required only when you set contextInputType to custom.

• httpPort: The port number. The value must be in the range of 1024 to 65535. Ports smaller than 1024 require root permissions. Because the container is configured with administrator permissions, specify a port number greater than 1024. If you do not specify this parameter, the default port 8080 is used.

• maxThreads: The maximum number of connections in the connection pool. Default value: 400.

  Note

  This parameter greatly affects application performance. Configure this parameter with the help of a professional.

• uriEncoding: The encoding format for Tomcat. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312. If you do not specify this parameter, the default value ISO-8859-1 is used.

• useBodyEncoding: Specifies whether to use BodyEncoding for URLs.

• useAdvancedServerXml: Specifies whether to use advanced settings to customize the server.xml file. If the preceding parameter types and specific parameters cannot meet your requirements, you can use advanced settings to directly edit the server.xml file of Tomcat.

• serverXml: The content of the server.xml file that is customized in the advanced settings. This parameter takes effect only when useAdvancedServerXml is set to true.

The Java startup parameters. You can configure startup parameters for a Java application. You can configure memory, application, garbage collection (GC) policy, tools, service registration and discovery, and custom parameters. Proper parameter configuration helps reduce GC overhead, shorten server response time, and improve throughput. The value is a JSON string. original specifies the configuration value, and startup specifies the startup parameter. The system automatically concatenates all startup values as the Java startup parameters for the application. To clear the configuration, set the value to "" or "{}". The keys in the JSON string are described as follows:

• InitialHeapSize: the initial heap size.

• MaxHeapSize: the maximum heap size.

• CustomParams: custom content, such as JVM -D parameters.

• Other keys: You can view the JSON structure submitted by the frontend.

The Logstore configuration. To clear the configuration, set the value to "" or "{}":

• Configs:

  • type: The collection type. file indicates the file type. stdout indicates the standard output type.

  • Logstore: The name of the Logstore. Make sure that the Logstore name is unique in the same cluster and meets the following naming conventions:

    • The name can contain only lowercase letters, digits, hyphens (-), and underscores (_).

    • The name must start and end with a lowercase letter or a digit.

    • The name must be 3 to 63 characters in length. If you leave this parameter empty, the system automatically generates a name.

  • LogDir: If the collection type is standard output, the collection path is stdout.log. If the collection type is file, the collection path is the path of the file to be collected. Wildcards are supported. The collection path must match the following regular expression: ^/(.+)/(.*)^/$.

Specifies whether the application is a multilingual application.

Specifies whether to distribute application instances to multiple nodes. A value of true means yes. Other values mean no.

The configuration for mounting a Kubernetes PersistentVolumeClaim (PVC). You can mount a Kubernetes PVC volume to a specified directory in a container. The following parameters are included in PvcMountDescs:

• pvcName: The name of the PVC volume. The PVC volume must exist and be in the Bound state.

• mountPaths: The list of mount directories. You can configure multiple mount directories. Each mount directory supports two parameters.

  • mountPath: The mount path. The path must be an absolute path that starts with a forward slash (/).

  • readOnly: The mount mode. true specifies the read-only mode. false specifies the read and write mode. Default value: false.

The configuration for mounting Kubernetes ConfigMaps and Secrets. You can mount ConfigMaps and Secrets to specified directories in a container. The following parameters are included in ConfigMountDescs:

• name: The name of the ConfigMap or Secret.

• type: The configuration type. Valid values: ConfigMap and Secret.

• mountPath: The mount path. The path must be an absolute path that starts with a forward slash (/).

You must specify CsClusterId only when you create an application in a cluster that has never been imported.

You must set this parameter to true only when you create an application in a cluster that has never been imported and enable Service Mesh (ASM).

The configuration for environment variables of the Kubernetes EnvFrom type. You can mount a specified ConfigMap or Secret to a specified directory. Each key corresponds to a file in the directory. The content of the file is the value of the key.

The following parameters are included in EnvFroms:

• configMapRef: The reference to the ConfigMap. This field includes the following parameter:

  • name: The name of the ConfigMap.

• secretRef: The reference to the Secret. This field includes the following parameter:

  • name: The name of the Secret.

The configuration for mounting a Kubernetes emptyDir volume. You can mount an emptyDir volume to a specified directory in a container. The following parameters are included in EmptyDirs:

• mountPath: The mount path in the container. This parameter is required.

• readOnly: Specifies whether the volume is read-only. This parameter is optional. true specifies read-only. false specifies read and write. Default value: false.

• subPathExpr: The subdirectory expression. This parameter is optional.

The version of EDAS Container. This parameter conflicts with EdasContainerVersion. Use the EdasContainerVersion parameter instead.

The custom affinity.

The custom tolerations.

The ID of the resource group.

The annotations of the application pod.

The labels of the application pod.

Specifies whether to enable protection against empty pushes:

• true: Enable protection against empty pushes.

• false: Do not enable protection against empty pushes.

Specifies whether to enable the graceful start rule:

• true: Enable the graceful start rule.

• false: Do not enable the graceful start rule.

The warm-up duration of the service. Unit: seconds. The value must be in the range of 0 to 86400.

The delay of service registration. Unit: seconds. The value must be in the range of 0 to 86400.

The warm-up curve of the service. The value must be in the range of 0 to 20. Default value: 2. This value is suitable for normal warm-up scenarios and indicates that the traffic that the service provider receives follows a quadratic curve during the warm-up period.

Specifies whether to enable the graceful rolling deployment mode in which service registration is complete before the readiness probe is passed:

• true: A health check URL is provided for the application on port 55199. The path is /health. The URL returns 200 after the service is registered. Otherwise, the URL returns 500.

  Note

  If you also set LosslessRuleRelated to true, this URL is used to check whether the service warm-up is complete.

• false: A URL is not provided for the application to check whether the service is registered.

Specifies whether to enable the graceful rolling deployment mode in which service warm-up is complete before the readiness probe is passed:

• true: A health check URL is provided for the application on port 55199. The path is /health. The URL returns 200 after the service warm-up is complete. Otherwise, the URL returns 500.

• false: A URL is not provided for the application to check whether the service warm-up is complete.

The configuration of the Kubernetes Service.

The name of the application template that is used to create the application. If you specify an application template when you create the application, the application template and the AppConfig parameter are preferentially used to determine the application configuration. Other configurations are ignored.

The application configuration when an application template is used. The value is a JSON string.

The maximum ephemeral storage. Unit: GB. A value of 0 means no limit.

The minimum ephemeral storage. Unit: GB. A value of 0 means no limit.

The name of the image pull secret. You must create the secret.

The ID of the repository that is used to build the image repository. If you leave this parameter empty, the default repository provided by EDAS is used. Currently, only the default repository provided by EDAS is supported.

The type of the workload. Currently, only deployments are supported.

The sidecar containers for the application pod. You can set the container configuration in the YAML format. The value is the Base64-encoded YAML configuration of the sidecar container.

The init containers for the application pod. You can set the container configuration in the YAML format. The value is the Base64-encoded YAML configuration of the init container.

If you use a custom JDK runtime, you must configure the address of the base image. The address must be accessible over the Internet. The EDAS server pulls the image to build an application image.

The timeout period for a graceful stop. Unit: seconds.

The architecture of the image platform. This parameter is valid when you use a WAR or JAR package for deployment. Examples:

• To specify the x86-64 architecture, enter linux/amd64.

• To specify the ARM64 architecture, enter linux/arm64.

• To build a dual-architecture image, enter linux/amd64,linux/arm64.

• If you do not enter a value, the default architecture is used.

The startup probe. You can use a startup probe to check the liveness of a slow-start container and prevent the container from being killed before it is started. Example: {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": [{"name": "test","value": "testvalue"}]}}.

To clear this configuration, set the value to "" or {}. If you do not set this parameter, it is ignored.

The configuration of the custom monitoring and administration solution.

The version of the agent.

The SecurityContext attribute for the application pod container. The value is the Base64-encoded YAML configuration of the SecurityContext.