--- schema_version: "1" id: c3a5b34f2b09ebac0bb3feea0d383d7853a222ccd207c828470003eecb6370cd title: Automating Omni Gateway with a Jenkins Pipeline using the API Manager API collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/gateway/1.13/conn-jenkins-api.md canonical_url: https://docs.mulesoft.com/gateway/1.13/conn-jenkins-api source_site: docs.mulesoft.com content_type: documentation content_hash: 6463cf09a520cad2fe2f40ef5ee64a64914d0fc7d488df2f66dc9b60381da729 description: MuleSoft Documentation Site release: "1.13" latest: false --- --- product: Omni Gateway version: 1.13 --- # Automating Omni Gateway with a Jenkins Pipeline using the API Manager API > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You can use a Jenkins Pipeline to automate the workflow for Omni Gateway in Connected Mode. With a Jenkins Pipeline, you can register and run an Omni Gateway and use features of the API Manager API, such as creating and deploying API instances. Automating your Omni Gateway in Connected Mode work flow shares many similarities with the [Manage Omni Gateway Using the API Manager API](https://docs.mulesoft.com/gateway/1.13/conn-manage-public-api) tutorial. You can use the Jenkins Pipeline to automate the calls made to the API Manager API. To add additional features from the [API Manager API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/api-manager-api/), use the [Create an API Instance](#create-an-api-instance) and [Apply an API Policy](#apply-an-api-policy) Pipeline stages as examples. This tutorial has different steps with different code blocks. As you work through the steps, add the code blocks to the same Jenkinsfile. If you are unfamiliar with the syntax used in a Jenkins Pipeline, see the [Jenkins Pipeline documentation](https://www.jenkins.io/doc/book/pipeline/). > [!NOTE] To instead automate your Omni Gateway with the Anypoint CLI, see > [Automating Omni Gateway with a Jenkins Pipeline using Anypoint CLI](https://docs.mulesoft.com/gateway/1.13/conn-jenkins-cli). ## Before You Begin Before you can deploy a Jenkins Pipeline, complete the following tasks: 1. [Download Omni Gateway](https://docs.mulesoft.com/gateway/1.13/install). 2. [Configure a Connected App](https://docs.mulesoft.com/access-management/connected-apps-developers#create-a-connected-app): 1. Use the **App acts on its behalf (client credentials)** type and include the following scopes: - API Manager: **Manage APIs Configuration**, **Manage Policies**, **View Policies**, and **Deploy API Proxies** - Runtime Manager: **Read Servers** and **Manage Servers** - Exchange: **Exchange Viewer** - General: **View Organization** 2. Save the **Id** and **Secret** of the Connected app you configure. 3. Collect the group ID, asset ID, and asset version (GAV) of the Exchange asset (API) you want to create or apply. To collect your GAV from Exchange: 1. Go to Exchange. 2. Find the asset to add or apply. 3. Collect the group ID and asset ID from the URL. For example, the IDs collected from the API Manager API Exchange URL, `https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/api-manager-api/minor/1.0/pages/home/`, are: - Group ID: `f1e97bc6-315a-4490-82a7-23abe036327` - Asset ID: `api-manager-api` 4. Collect the asset version from **Latest Stable**. For example, the version collected from the API Gateway HTTP basic authentication policy template is `1.3.1`. 4. Collect the following information from your Anypoint Platform instance: - **Organization ID** for the organization where you want to run Omni Gateway For more information, see [Find Your Organization ID](https://docs.mulesoft.com/access-management/managing-business-groups#find-your-organization-id). - **Environment ID** for the environment where you want to run Omni Gateway For more information, see [What API Manager Looks Like](https://docs.mulesoft.com/api-manager/latest/latest-overview-concept#what-api-manager-looks-like). ## Initial Configuration Before you can create and deploy an API instance to your Omni Gateway, you must complete the following steps: 1. [Define Useful Functions](#define-useful-functions). 2. [Define Useful Parameters](#define-useful-parameters). 3. [Register and Run](#register-and-run). 4. [Obtain an Authorization Token from Access Management](#obtain-an-authorization-token-from-access-management). After you implement these Pipeline stages, you can customize your Pipeline by making API Manager API requests to manage APIs. ### Define Useful Functions To begin, define these useful functions in your Jenkinsfile. Define the functions before the `pipeline` block: ```Jenkinsfile def parseYamlFile(String file) { object = readYaml file: file return object } def parseJsonFile(file) { object = readJSON file: file return object } ``` ### Define Useful Parameters Since the commands in the Jenkins Pipeline reuses some parameters, it is helpful to define them at the beginning of your Jenkinsfile. Using the included parameter definitions as a template, you can also define any parameters that additional APIs or policies need. To define the parameters: 1. Collect the following information: - ``: **Organization ID** for the organization where you want to run Omni Gateway - ``: **Environment ID** for the organization where you want to run Omni Gateway - ``: Version of Omni Gateway you are using, for example `1.4.0` - ``: **Id** of your connected app - ``:\*Secret\* of your connected app - API GAV: - ``: Group ID, obtained from Exchange - ``: Asset ID, obtained from Exchange, of the API you want to create - ``: Asset version, obtained from Exchange, of the API you want to create - ``: Name of your Omni Gateway 2. After replacing the sample content, add the parameter definitions to your Jenkinsfile to validate whether all parameters are present. Define the parameters in the `pipeline` block before the `stages` block: ```Jenkinsfile parameters { string(name: 'ENV_ID', defaultValue: '', description: 'Your environment id') string(name: 'ORG_ID', defaultValue: '', description: 'Your organization id') string(name: 'FLEX_VERSION', defaultValue: '', description: 'Flex version to run') string(name: 'CONNECTED_APP_CLIENT_ID', defaultValue: '', description: 'Your connected app client id') string(name: 'CONNECTED_APP_CLIENT_SECRET', defaultValue: '', description: 'The id of the http api exchange asset') string(name: 'EXCHANGE_ASSET_VERSION', defaultValue: '', description: 'The version of the http api exchange asset') string(name: 'GATEWAY_NAME', defaultValue: '', description: 'Unique gateway name') } ``` 3. Add the check parameters `stage` to the `stages` block in your Jenkinsfile: ```Jenkinsfile stage('Check parameters') { steps { script { if (!params.ENV_ID || !params.ORG_ID || !params.FLEX_VERSION || !params.CONNECTED_APP_CLIENT_ID || !params.CONNECTED_APP_CLIENT_SECRET || !params.EXCHANGE_ASSET_ID || !params.EXCHANGE_ASSET_VERSION || !params.GATEWAY_NAME) { error("Not all parameters where specified") } } } } ``` If this stage fails, specify the missing parameters and rerun the Pipeline. ### Register and Run Add the register and run stages to the `stages` block in your Jenkinsfile: ```Jenkinsfile stage('Register flex gateway') { steps { script { sh """ docker run --entrypoint flexctl \ -v "\$(pwd)":/registration -u 0 mulesoft/flex-gateway:${params.FLEX_VERSION} \ register \ --client-id=${params.CONNECTED_APP_CLIENT_ID} \ --client-secret=${params.CONNECTED_APP_CLIENT_SECRET} \ --environment=${params.ENV_ID} \ --connected=true \ --organization=${params.ORG_ID} \ --output-directory=/registration \ ${params.GATEWAY_NAME} """ if (!fileExists('registration.yaml')) { error("Registration failed") } } } } stage('Run flex gateway') { steps { script { sh """ docker run -d \ -v "\$(pwd)":/usr/local/share/mulesoft/flex-gateway/conf.d \ -p 8082:8082 \ mulesoft/flex-gateway:${params.FLEX_VERSION} > containerId """ } } } ``` ### Obtain an Authorization Token from Access Management After registering and running your Omni Gateway, you must obtain a valid authorization token from Access Management in order to authenticate subsequent requests. To login in to Anypoint, add the Anypoint login `stage` the `stages` block in your Jenkinsfile: ```Jenkinsfile stage("Anypoint login") { steps { script { def cmd = """curl -s -w "%{http_code}" --location --request POST 'https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token' -o 'login-response' \ --header 'Content-Type: application/json' \ --data-raw '{"grant_type": "client_credentials", "client_id": "${params.CONNECTED_APP_CLIENT_ID}", "client_secret": "${params.CONNECTED_APP_CLIENT_SECRET}"}' """ def status_code = sh(returnStdout: true, script: cmd).trim().toInteger() if (status_code > 399) { error("Anypoint login failed") } } } } ``` The authorization token returned in this step is saved for subsequent requests. ## Create an API Instance Having an authorization token from Access Management enables you to create an API instance and deploy it to your Omni Gateway. You can repeat this step to add multiple API instances. For example, this stage creates an API instance that listens on port `8082` and `/httpbin` path and proxies to `https://httpbin.org/`. To create an API instance: 1. Collect the following information: - ``: URI upstream of your API - ``: Proxy URI for you API instance - `"isCloudHub"`: Cloud Hub status, for example `null` or `true` 2. Optionally, collect your `"endpointUri"` or remove the `"endpointUri"` field: - ``: Consumer endpoint of your API, for example, `http://consumer-endpoint.com` 3. After replacing the HTTP addresses, add the create API instance `stage` to the `stages` block in your Jenkinsfile: ```Jenkinsfile stage("Create API instance") { steps { script { def login_response = parseJsonFile('login-response') def cmd = """ curl -s -w "%{http_code}" --location --request POST 'https://anypoint.mulesoft.com/apimanager/api/v1/organizations/${params.ORG_ID}/environments/${params.ENV_ID}/apis' -o 'api-response' \ --header 'Authorization: Bearer ${login_response.access_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ "spec": { "groupId": "${params.ORG_ID}", "assetId": "${params.EXCHANGE_ASSET_ID}", "version": "${params.EXCHANGE_ASSET_VERSION}" }, "endpoint": { "deploymentType": "HY", "uri": "https://httpbin.org:443", "proxyUri": "http://0.0.0.0:8082/httpbin", "isCloudHub": null }, "technology": "flexGateway" "endpointUri": "" // OPTIONAL }' """ def status_code = sh(returnStdout: true, script: cmd).trim().toInteger() if (status_code > 399) { error("Error occurred while trying to create API instance") } } } } ``` ## Apply an API Policy After you create an API instance, you can apply Connected Mode policies to the instance: 1. Collect the following information: - Policy GAV - ``: Policy group ID from Exchange - ``: Policy asset ID from Exchange, for example `http-basic-authentication` - ``: Policy asset version from Exchange, for example `1.3.1` - `"configurationData"`: Policy configuration data The configuration data fields are dependent on the policy. The `"username"` and `"password"` parameters are only an example. To find the configuration data for your policy, see [Included Policies Directory](https://docs.mulesoft.com/gateway/1.13/policies-included-directory). 2. After replacing the sample content, add the apply policy `stage` to the `stages` block in your Jenkinsfile: ```Jenkinsfile stage("Apply policy") { steps { script { def login_response = parseJsonFile('login-response') def api_response = parseJsonFile('api-response') def cmd = """ curl -s -w "%{http_code}" -o /dev/null --location --request POST 'https://anypoint.mulesoft.com/apimanager/api/v1/organizations/${params.ORG_ID}/environments/${params.ENV_ID}/apis/${api_response.id}/policies' \ --header 'Authorization: Bearer ${login_response.access_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ "configurationData":{ "username": "user", "password": "test" }, "pointcutData": null, "assetId": "", "assetVersion": "", "groupId": "" }' """ def status_code = sh(returnStdout: true, script: cmd).trim().toInteger() if (status_code > 399) { error("Error occurred while trying to apply Basic Auth Policy to the API instance") } } } } ``` ## Deploy an API Instance After you create an API instance, you can deploy the instance. To deploy the new instance, add the deploy API `stage` to the `stages` block in your Jenkinsfile: ```Jenkinsfile stage("Deploy API") { steps { script { def login_response = parseJsonFile('login-response') def api_response = parseJsonFile('api-response') def registration_file = parseYamlFile('registration.yaml') def cmd = """ curl -s -w "%{http_code}" -o /dev/null --location --request POST 'https://anypoint.mulesoft.com/proxies/xapi/v1/organizations/${params.ORG_ID}/environments/${params.ENV_ID}/apis/${api_response.id}/deployments' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ${login_response.access_token}' \ --data-raw '{ "type": "HY", "gatewayVersion": "${params.FLEX_VERSION}", "targetId": "${registration_file.spec.platformConnection.agentId[0]}", "environmentId": "${params.ENV_ID}" }' """ def status_code = sh(returnStdout: true, script: cmd).trim().toInteger() if (status_code > 399) { error("Error occurred while trying to deploy the API instance") } } } } ``` ## Validate the API Instance is Deployed After you deploy your API instance, validate whether the instance is deployed by adding the validate deployment `stage` to the `stages` block in your Jenkinsfile ```Jenkinsfile stage("Validate deployment") { steps { script { sleep(time:10, unit:"SECONDS") def unauthorized_status_code = sh(script: "curl -s -w \"%{http_code}\" -o /dev/null http://localhost:8082/httpbin/headers -v", returnStdout: true).trim().toInteger() if (unauthorized_status_code != 401) { error("401 status code expected but the status code obtained is ${unauthorized_status_code}") } def authorized_status_code = sh(script: "curl -s -w \"%{http_code}\" -o /dev/null http://localhost:8082/httpbin/headers -v -u user:test", returnStdout: true).trim().toInteger() if (authorized_status_code != 200) { error("200 status code expected but the status code obtained is ${unauthorized_status_code}") } } } } ``` ## Stop the Omni Gateway and archive the registration file Use the following code blocks to stop your Omni Gateway and archive the registration file. Add the `post` block in the `pipeline` block after the `stages` block: ```Jenkinsfile post { success { script { // Archive the build output artifacts. archiveArtifacts artifacts: 'registration.yaml' } } always { script { if (fileExists('containerId')) { sh(script: "docker rm -f ${readFile(file: 'containerId')}") } } } } ``` ## See Also - [Registering and Running in Connected Mode with a Connected App](https://docs.mulesoft.com/gateway/1.13/conn-reg-run-app). - [Anypoint Developer API Manager API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/api-manager-api/) - [Manage Omni Gateway Using the API Manager API](https://docs.mulesoft.com/gateway/1.13/conn-manage-public-api)