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.

CloudHub Deployer

cloudhubDeployer: CloudHub Deployment

  • environmentId : String
  • orgId : String
  • appName : String
    The application name identifies your application not only in Runtime Manager but also in the public domain. For example, an application named myapplication is accessible at To avoid domain conflicts, the application name must be globally unique across CloudHub.The application name can contain between 3 and 42 alphanumeric characters (a-z, A-Z, 0-9) and dashes (-). They cannot contain spaces or other characters.
  • muleVersion : String
    The runtime version must be the same Mule version used to develop your application.
  • filePath : String
    Workspace-relative path of the artifact file to upload (it should resolve to a single file). Can use wildcards like module/dist/**/*.jar, See the @includes of Ant fileset for the exact format. Examples: File, like target/my-mule-app.jar or target/**/*.jar : The jar file will be uploaded to cloudhub.
  • credentialsId : String (optional)
    Jenkins credentials containing The Anypoint Platform account username and password with sufficient access to perform deployment related activities on CloudHub.
  • requestMode (optional)
    Type of Operation to perform on CloudHub. CREATE - Deploy/Create new application UPDATE - Update application with new package and settings provided. UPDATE_FILE - Update just the zip/jar file of application, rest all settings ignored. CREATE_OR_UPDATE - Deploy/Create new application(if not already present) or update the existing application. RESTART - Restart the application already present. DELETE - Delete the application.
  • region : String (optional)
    If you have global deployment enabled on your account, you can change the deployment region.
  • autoScalePolicy (optional)
      Array / List of Nested Object
    • autoScalePolicyName : String (optional)
      The auto scaling policy name.
    • enableAutoScalePolicy : boolean (optional)
    • id : String (optional)
    • maxScale : int (optional)
      The maximum number of workers or size of workers for auto scaling. Allowed Values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
    • minScale : int (optional)
      The minimum number of workers or size of workers for auto scaling. Allowed values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
    • scaleBasedOn : String (optional)
      The metric based on which auto scaling policy scales. Allowed values: CPU, MEMORY
    • scaleDown (optional)
      • Type: class
    • scaleDownNextScaleWaitMins : int (optional)
      Number of minutes to wait before applying new scale down policy.
    • scaleDownPeriodCount : int (optional)
      The time in minutes to monitor the CPU/memory for low usage before scaling down.
    • scaleDownValue : int (optional)
      The CPU or memory usage below which scale down policy will take effect.
    • scaleType : String (optional)
      The scale type of the auto scaling policy. Allowed values: WORKER_COUNT, WORKER_SIZE
    • scaleUp (optional)
      • Type: class
    • scaleUpNextScaleWaitMins : int (optional)
      Number of minutes to wait before applying new scale up policy.
    • scaleUpPeriodCount : int (optional)
      The time in minutes to monitor the CPU/memory for high usage before scaling up.
    • scaleUpValue : int (optional)
      The CPU or memory usage above which scale up policy will take effect.
  • autoStart : boolean (optional)
    Check this flag to autostart the application after it is deployed
  • debugMode (optional)
    Use this to log additional details/info from the http requests.
  • enableAutoScalePolicy : boolean (optional)
  • envVars (optional)
    you can specify properties (key-value pairs) that the application uses during deployment and while running.
      Array / List of Nested Object
    • key : String (optional)
    • value : String (optional)
  • ignoreGlobalSettings : boolean (optional)
    If checked settings from global configuration will be used that are under manage jenkins.
  • logLevels (optional)
    You can configure the logging level (DEBUG, WARN, ERROR, or INFO) for the application
      Array / List of Nested Object
    • levelCategory (optional)
      • Values: DEBUG, WARN, ERROR, INFO
    • packageName : String (optional)
  • loggingNgEnabled : boolean (optional)
    Check this if you want to use your own logging solution using Log4j configuration.
  • monitoringAutoRestart : boolean (optional)
    CloudHub automatically restarts your application when the monitoring system discovers an issue.
  • monitoringEnabled : boolean (optional)
    Use Anypoint Monitoring and Visualizer for Mule applications running on supported versions of Mule.
  • objectStoreV1 : boolean (optional)
    Object Store v2 is enabled by default in Mule 4. In Mule 3, select this option to use Object Store v1.
  • persistentQueues : boolean (optional)
    You can use persistent queues on your application to store data in an input queue to disk. Persistent queues protect against message loss and enable you to distribute workloads across a set of workers.
  • persistentQueuesEncrypted : boolean (optional)
    If you enable persistent queues, you can optionally encrypt the data stored in the input queue on disk.
  • timeoutConnection : int (optional)
    Max time to try before failing the request.
  • timeoutResponse : int (optional)
    Max time to wait for response before failing the request.
  • verifyDeployments : boolean (optional)
    Verify if API is stated after deployment.
  • verifyIntervalInSeconds : int (optional)
  • workerAmount : int (optional)
    No of workers to run for API.
  • workerCpu : String (optional)
    Compute Capacity for each worker(vCores). Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 2 or 16
  • workerMemory : String (optional)
    Heap memory (Or Ram) for each worker. Check MuleSoft Documentation for available sizes (worker-size-and-vcores. Example Values :- "500 MB", "1.5 GB" or "32 GB"
  • workerType : String (optional)
    Type of worker to use "Micro", "Small", "Medium" or "Large". Check MuleSoft Documentation for additional details.
  • workerWeight : String (optional)
    Weight for worker type. Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 0.2 or 1

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.