> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

EDAS Plugin

View this plugin on the Plugins site

edasClient: Deploy to EDAS

  • extensions
      Array / List of Nested Choice of Objects
    • deployEDASApplication
      • namespace
        The EDAS namespace, please check with ListUserDefineRegion
        • Type: String
      • credentialId
        • Type: String
      • group
        The deploy group ID of EDAS application. Set this parameter to "all" if you want to deploy the application to all groups
        • Type: String
      • appId
        The ID of the EDAS Application that you want to deploy
        • Type: String
      • targetObject
        The path of file to deploy
        • Type: String
      • batch (optional)
        The batch of this deployment
        • Type: String
      • batchWaitTime (optional)
        The wait time between batches
        • Type: String
      • endpoint (optional)
        • Type: String
      • releaseType (optional)
        The release type of batch deployment
        • Type: String
      • versionDescriptionFormat (optional)
        Sets the description of the version to be published. Jenkins environment variables are supported such as ${GIT_BRANCH} - ${BUILD_TAG}
        • Type: String
      • versionLabelFormat (optional)
        How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41
        • Type: String
    • InsertEDASApplication
      • namespace
        The EDAS namespace, please check with ListUserDefineRegion
        • Type: String
      • credentialId
        • Type: String
      • applicationName
        The EDAS Application Name to Create
        • Type: String
      • targetObject
        The path of file to deploy
        • Type: String
      • clusterId
        The ID of cluster to deploy EDAS application
        • Type: String
      • packageType
        The package type of application (e.g. : "war")
        • Type: String
      • ecuInfo
        The ID of the Elastic Compute Unit (ECU) to deploy the application. Use ListScaleOutEcu to get ecu id
        • Type: String
      • buildPackId (optional)
        The package ID of Enterprise Distributed Application Service (EDAS) Container, which can be retrieved by calling container version list interface ListBuildPack or the "Pack ID" column in container version list. When creating High-speed Service Framework (HSF) application, this parameter is required.
        • Type: String
      • endpoint (optional)
        • Type: String
      • healthCheckUrl (optional)
        The URL for health checking of the application
        • Type: String
      • versionDescriptionFormat (optional)
        Sets the description of the version to be published. Jenkins environment variables are supported such as ${GIT_BRANCH} - ${BUILD_TAG}
        • Type: String
      • versionLabelFormat (optional)
        How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41
        • Type: String
    • deployEDASK8sApplication
      • namespace
        The EDAS namespace, please check with ListUserDefineRegion
        • Type: String
      • credentialId
        • Type: String
      • appId
        The ID of the EDAS Application that you want to deploy
        • Type: String
      • targetObject
        The path of file to deploy. Local file, remote url and image url permitted
        • Type: String
      • image
        • Type: boolean
      • args (optional)
        JsonArray of command arguments.(e.g.: [{"argument":"-c"},{"argument":"test"}])
        • Type: String
      • cpuLimit (optional)
        CPU limit, unit: millicores
        • Type: String
      • cpuRequest (optional)
        CPU request, unit: millicores
        • Type: String
      • edasContainerVersion (optional)
        The version of EDAS container. Required when deploy war package
        • Type: String
      • endpoint (optional)
        • Type: String
      • envs (optional)
        The jsonArray of envs.(e.g.: [{"name":"testkey","value":"testValue"}]) Set [] to clear settings
        • Type: String
      • jdk (optional)
        The version of JDK
        • Type: String
      • liveness (optional)
        e.g.: {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": [{"name": "test","value": "testvalue"}]}}. Set empty of {} to clear, "unchanging" means no changing
        • Type: String
      • memoryLimit (optional)
        • Type: String
      • memoryRequest (optional)
        • Type: String
      • postStart (optional)
        e.g.: {"exec":{"command":"cat","/etc/group"}}. Set empty of {} to clear, "unchanging" means no changing
        • Type: String
      • preStop (optional)
        e.g.: {"exec":{"command":"cat","/etc/group"}}. Set empty of {} to clear, "unchanging" means no changing
        • Type: String
      • readiness (optional)
        e.g.: {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": [{"name": "test","value": "testvalue"}]}}. Set empty of {} to clear, "unchanging" means no changing
        • Type: String
      • replicas (optional)
        The number of pods
        • Type: String
      • startupCommand (optional)
        The startup command
        • Type: String
      • updateStrategy (optional)
        e.g.: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}. Please check usage from pop api DeployK8sApplication
        • Type: String
      • versionLabelFormat (optional)
        How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41
        • Type: String
      • webContainer (optional)
        The version of tomcat(e.g. "Apache Tomcat 7.0.91"). Required when deploy war package
        • Type: String
    • insertEDASK8sApplication
      • credentialId
        • Type: String
      • namespace
        The EDAS namespace, please check with ListUserDefineRegion
        • Type: String
      • clusterId
        The ID of cluster to deploy EDAS application
        • Type: String
      • k8sNamespace
        The K8s namespace where application to deploy. (e.g. : "default")
        • Type: String
      • applicationName
        The EDAS Application Name to Create
        • Type: String
      • targetObject
        The path of file to deploy. Local file, remote url and image url permitted
        • Type: String
      • packageType
        • Type: String
      • jdk
        The version of JDK
        • Type: String
      • args (optional)
        JsonArray of command arguments.(e.g.: [{"argument":"-c"},{"argument":"test"}])
        • Type: String
      • cpuLimit (optional)
        CPU limit, unit: millicores
        • Type: String
      • cpuRequest (optional)
        CPU request, unit: millicores
        • Type: String
      • descFormat (optional)
        • Type: String
      • edasContainerVersion (optional)
        The version of EDAS container. Required when deploy war package
        • Type: String
      • endpoint (optional)
        • Type: String
      • envs (optional)
        The jsonArray of envs.(e.g.: [{"name":"testkey","value":"testValue"}]) Set [] to clear settings
        • Type: String
      • liveness (optional)
        e.g.: {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": [{"name": "test","value": "testvalue"}]}}. Set empty of {} to clear, "unchanging" means no changing
        • Type: String
      • memoryLimit (optional)
        • Type: String
      • memoryRequest (optional)
        • Type: String
      • postStart (optional)
        e.g.: {"exec":{"command":"cat","/etc/group"}}. Set empty of {} to clear, "unchanging" means no changing
        • Type: String
      • preStop (optional)
        e.g.: {"exec":{"command":"cat","/etc/group"}}. Set empty of {} to clear, "unchanging" means no changing
        • Type: String
      • readiness (optional)
        e.g.: {"failureThreshold": 3,"initialDelaySeconds": 5,"successThreshold": 1,"timeoutSeconds": 1,"httpGet": {"path": "/consumer","port": 8080,"scheme": "HTTP","httpHeaders": [{"name": "test","value": "testvalue"}]}}. Set empty of {} to clear, "unchanging" means no changing
        • Type: String
      • replicas (optional)
        The number of pods
        • Type: String
      • startupCommand (optional)
        The startup command
        • Type: String
      • versionLabelFormat (optional)
        How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41
        • Type: String
      • webContainer (optional)
        The version of tomcat(e.g. "Apache Tomcat 7.0.91"). Required when deploy war package
        • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.