integration-cicd

This sample repository demonstrates how one could build a CI/CD pipeline for Application Integration with Cloud Build.

Instructions

• The integration version JSON is downloaded here.
• Once the changes are checked in and merged, the developer can deploy manually or trigger the deployment through Cloud Build
• This repo uses a custom cloud builder called integrationcli-builder, based on integrationcli and gcloud

Configuring Cloud Build

In the setting page of Cloud Build enable the following service account permissions:

• Secret Manager (Secret Manager Accessor)
• Service Accounts (Service Account User)
• Cloud Build (Cloud Build WorkerPool User)

Grant the Application Integration Admin role to the Cloud Build Service Agent

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member="serviceAccount:[email protected]" \
        --role="roles/integrations.integrationAdmin"

Steps

1. Download the integration from the UI or using the CLI. Here is an example to download via CLI:

token=$(gcloud auth print-access-token)
integrationcli integrations versions get -n <integration-name> -v <version> -p <project-id> -r <region-name> -t $token > ./src/<integration-name>.json

You can also download via a snapshot number like this:

token=$(gcloud auth print-access-token)
integrationcli integrations versions get -n <integration-name> -s <snapshot> -p <dev-project-id> -r <region-name> -t $token > ./src/<integration-name>.json

2. Author overrides (specific for the environment) and store them in the overrides folder. Here is an example overrides for the URL in the REST task

{
    "task_overrides": [{
        "taskId": "1",
        "task:": "GenericRestV2Task",
        "parameters":  {
            "url": {
                "key": "url",
                "value": {
                    "stringValue": "https://httpbin.org/ip"
                }
            }
        }
    }]
}

3. Trigger the build manually

gcloud builds submit --config=cloudbuild.yaml --region=<region-name> --project=<qa-project-name>

The integration is labeled with the SHORT_SHA, the first seven characters of the commit id

Overrides

The overrides file contains configuration that is specific to an environment. The structure of the file is as follows:

{
    "trigger_overrides": [{
        "triggerNumber": "1",
        "triggerType": "CLOUD_PUBSUB_EXTERNAL",
        "projectId": "my-project",
        "topicName": "topic"
    }],
    "task_overrides": [{
        "taskId": "1",
        "task": "GenericRestV2Task",
        "parameters":  {
            //add parameters to override here
        }
    }]
    "connection_overrides": [{
        "taskId": "1",
        "task": "GenericConnectorTask",
        "parameters": {
             "connectionName": "add-connection-name-here",
             "connectionLocation": "us-west1"
        }
    }]
}

For each override, taskId and task mandatory. task is the task type. Note the configuration settings for the connector task is separated from the rest of the tasks.

Creating Auth Configs

The creation of Auth Config can also be automated via Cloud Build. Since AuthConfig contains sensitive information (like passwords, tokens etc.), it is recommended the file be encrypted before storing in a source code repo. Here is an example that encrypts the file:

Step 1: Author a Auth Config JSON file like so:

{
  "displayName": "authconfig-sample",
  "description": "this is a sample auth config",
  "visibility": "CLIENT_VISIBLE",
  "decryptedCredential": {
    "credentialType": "USERNAME_AND_PASSWORD",
    "usernameAndPassword": {
      "username": "test",
      "password": "test"
    }
  }
}

Step 2: Encrypt the file using cloud KMS and base64 encode the contents

gcloud kms encrypt  --project $project --location $location --keyring app-integration --key=integration --plaintext-file=ac_username.json --ciphertext-file=cipher.txt
openssl base64 -in cipher.txt -out b64encoded_ac.txt

This file can be checked into the source code repo. A example file can be found here

Step 3: Use Cloud Build to trigger or submit changes

A sample cloud build file is provided here

gcloud builds submit --config=cloudbuild.yaml --region=us-west1 --project=my-project --substitutions _FILE=./b64encoded_ac.txt,_KEY=keyRings/app-integration/cryptoKeys/integration

NOTE: If you are don't want to encrypt the file, then skip step 2. Modify the cloudbuild file and follow instructions there to not use encryption.

Auth Config Overrides in Integration

Auth Configs must be created in each GCP project. The auth config name (which contains the version) different in each project. To override the auth config so it works in the new project, specify the auth config name in the overrides. Here is an example:

{
    "task_overrides": [{
        "taskId": "1",
        "task": "CloudFunctionTask",
        "parameters":  {
            "TriggerUrl": {
                "key": "TriggerUrl",
                "value": {
                    "stringValue": "https://region-project.cloudfunctions.net/helloWorld"
                }
            },
            "authConfig": {
                "key": "authConfig",
                "value": {
                    "stringValue": "auth-config-name"
                }
            }
        }
    }]
}

Examples

1. The Cloud Functions uses cloud functions task and the overrides file demonstrates how to override it.
2. The PubSub uses a PubSub trigger and the overrides file demonstrate how to override it.
3. The Username Authconfig file shows a clear text auth config file.
4. The OIDC Token file shows a clear text auth config file.
5. The Base64 encoded Auth Config file shows a Cloud KMS encrypted, base64 enncoded file.

---

Support

This is not an officially supported Google product