boomi/connector-approval

docker

Hub

By boomi

•Updated 3 months ago

Image

129

Overview Tags

Overview

The connector-approval image is used to deploy and automatically approve a new version of a Connector on Boomi AtomSphere.

Image includes:

A minimal Alpine base image.
Code to scan, upload, and approve your custom connector version in your Boomi AtomSphere⁠ developer account.

Note: You must be a Boomi Technology Partner⁠ or an internal Boomi Developer in order to use this image.

Versioning

This docker repository contains only 2 tags development and release.
The current supported version is tagged with release.

Prerequisites

Authentication

This image takes valid Boomi AtomSphere user credentials in order to execute successfully. The recommended way to supply your credentials is by generating an AtomSphere API Token⁠. When you are using a token, be sure to supply the username in the proper format.

For example: BOOMI_TOKEN.developer@partner.com

Note: We must prepend BOOMI_TOKEN. to the username when using tokens.

Privileges

This image uses Connector Deployment AtomSphere APIs⁠, so in order to execute this image successfully, your user must first have appropriate AtomSphere account privileges.

Privilege	Description
API Access	Use the Boomi API to access account data.
Developer	Create and publish new components using the Boomi SDKs
Connector Submission	Submit custom connector/version for public approval

The executing user must have the above privileges assigned in order for this to work.

Connector Project Requirements

In order to use the automated scans, there are certain criteria that must be in place:

The Connector project must be compiled with Gradle or Maven
1. Gradle projects must include the Gradle wrapper (gradlew script is present)
2. Maven projects must include the Maven wrapper (mvnw script is present)
  1. You can add a wrapper to your existing Maven project:
    1. To use your current Maven version: mvn wrapper:wrapper
    2. To use a specific Maven version: mvn wrapper:wrapper -Dmaven=3.3.9
The Connector must be source controlled in Bitbucket under the OfficialBoomi workspace
Bitbucket pipelines must be enabled for the repository by your administrator
You must have a bitbucket-pipelines.yml file in the root directory of your repository

How to use this image

This image is intended to be used by internal Boomi Connector developers and Boomi Technology Partners developing Connectors. It should be used in Boomi's Bitbucket workspace⁠, within automated CICD pipelines.

Bitbucket Pipeline Usage

This image is intended to be used within your Bitbucket repository, with Bitbucket Pipelines CI tools.

Here is an example step in your Bitbucket repository's bitbucket-pipelines.yml file:

    - step:
        name: Connector Approval
        script:
          - pipe: docker://boomi/connector-approval:release
            variables:
              BOOMI_TOKEN: $BOOMI_TOKEN
              PLATFORM_USERNAME: $PLATFORM_USERNAME
              PLATFORM_PASSWORD: $PLATFORM_PASSWORD
              PLATFORM_ACCOUNT_ID: $PLATFORM_ACCOUNT_ID
              CONNECTOR_GROUP_TYPE: $CONNECTOR_GROUP_TYPE
              CAR_PATH: "build/**/*.zip"
              DEBUG: "true"
        services:
          - docker

Note: The values that start with a $ are replacement variables in Bitbucket. They are used to obfuscate secrets and sensitive information.

Environment Variables

You can adjust the configurations by passing one or more environment variables on the docker run command line or the variables section of your Bitbucket Pipeline step.

Variable	Requirement	Description
BOOMI_TOKEN	Required	Token provided by the Boomi Technology Partner⁠ program. Accessible in Bitbucket pipelines with `$BOOMI_TOKEN`.
PLATFORM_USERNAME	Required	Platform username. If the username is `developer@partner.com` and you generate an AtomSphere token, then this username may be `BOOMI_TOKEN.developer@partner.com`
PLATFORM_PASSWORD	Required	Platform password. This may be the username login password, or the token that is generated in AtomSphere.
PLATFORM_HOST	Optional	Platform host URL (defaults to https://platform.boomi.com⁠)
PLATFORM_ACCOUNT_ID	Required	The account ID associated with the username
CONNECTOR_GROUP_TYPE	Required	A valid connector group type from your Account Developer section. If my account is `boomi_dev-L7QK2E` and connector group is `Test Connector`, then my `CONNECTOR_GROUP_TYPE` might be `boomi_dev-L7QK2E-testco`. This can be retrieved from the `Developer` section.
CAR_PATH	Required	Either the path to directory containing the CAR zip, path to the CAR zip file, or wild card designation for the CAR zip file
SOURCES	Optional	Directory of the connector source code. Defaults to `src/main` directory (following typical conventions)
TEST_SOURCES	Optional	Directory of the connector test code. Defaults to `src/test` directory (following typical convention)
CHANGE_LOG	Optional	If provided, it will be used in the change log description for the CAR upload (default: Bitbucket pipeline execution information, if available)
DEBUG	Optional	Set to `true` to print out additional `DEBUG` information during execution

Scan Artifacts

The artifacts generated from this image will be the same as the ones generated by the connector-scan image.

Docker Pull Command

docker pull boomi/connector-approval