Skip to main content
Feedback

Configuring prerequisites for migration across deployment modes

Complete the following prerequisites configuration steps before migrating from 5.x.x to 6.3.0 across deployment modes (untethered → tethered).

Step 1: Set up Cloud API Management (SaaS) access

info

You must have an active Cloud API Management (SaaS) subscription before you can access it. If your organization does not already have one, contact the Boomi Support team via Boomi Community to subscribe and provision a Cloud API Management (SaaS) area for you.

Once the Boomi Support team provisions your area in Cloud API Management (SaaS), set up your account and sign in to Cloud API Management (SaaS).

Obtain the Area UUID and Area ID

After signing in to Cloud API Management (SaaS), obtain the following values:

  • Area UUID: Required for requesting OAuth2 tokens from the CAM Platform API.
  • Area ID: Required to run the Trust store and the Identity store.

Refer to Area Encryption Key to obtain Area UUID and Area ID.

Obtain your CAM Platform API credentials

Contact the Boomi Support team via Boomi Community or by sending an email to support@boomi.com to obtain your CAM Platform API credentials (CAM API username, CAM API password, CAM API key, and CAM API secret).

By default, Boomi assigns queries per second (QPS) and quota values for your API. The default QPS is 2, with a maximum of 15. The default quota is 5,000 requests per day. To adjust these values, contact the Boomi Support team via Boomi Community.

Provide CAM Platform API secrets

The CAM Platform API credentials are needed only for Tethered target mode. The migration pod uses these credentials to request OAuth2 tokens from and push configuration to the CAM Platform API.

After obtaining your CAM Platform API credentials, provide the secrets in Kubernetes or Docker Swarm depending on whether your APIM 5.x.x cluster runs on Kubernetes or Docker Swarm. Refer to the following sections to provide secrets:

Kubernetes (Without Encryption)

Provide the api-secret-cam-saas secret (refers to the same CAM Platform API credentials described above) in migrate_5x_to_6/templates/k8s/api-secret.yaml. The following values can be obtained from Boomi Support — refer to Step 1: Obtain your CAM Platform API credentials. This secret must contain the following four attributes:

  • .cam_saas_api_username: CAM API username.
  • .cam_saas_api_password: CAM API password.
  • .cam_saas_api_key: CAM API key.
  • .cam_saas_api_secret: CAM API secret.
Procedure

  1. Base64 encode each credential:

    echo -n '<username>' | base64
    echo -n '<password>' | base64
    echo -n '<api-key>' | base64
    echo -n '<api-secret>' | base64

  2. Fill in the YAML file (migrate_5x_to_6/templates/k8s/api-secret.yaml) with the base64-encoded values. Do not change the secret name or attribute names. The migration pod looks them up by exact name.

    apiVersion: v1
    kind: Secret
    metadata:
      name: api-secret-cam-saas
      namespace: default
    type: Opaque
    data:
      # CAM API username, base64 encoded: echo -n <username> | base64
      .cam_saas_api_username: <output of step 1>
      # CAM API password, base64 encoded: echo -n <password> | base64
      .cam_saas_api_password: <output of step 1>
      # CAM API key, base64 encoded: echo -n <api-key> | base64
      .cam_saas_api_key: <output of step 1>
      # CAM API secret, base64 encoded: echo -n <api-secret> | base64
      .cam_saas_api_secret: <output of step 1>

  3. Apply the template before deploying the migration pod:

    kubectl apply -f migrate_5x_to_6/templates/k8s/api-secret.yaml
    note
    • Base64 is encoding, not encryption. Restrict RBAC on this secret, and do not commit filled-in template files to source control.
    • Change namespace: default if the migration job runs in another namespace. The secret must live in the same namespace as the migration pod.

Docker Swarm

Provide each credential value, listed in the table below, in its corresponding template file located in migrate_5x_to_6/templates/swarm/:

Template fileCredential
migration-saas-username.txtCAM SaaS API username
migration-saas-password.txtCAM SaaS API password
migration-saas-key.txtCAM SaaS API key
migration-saas-secret.txtCAM SaaS API secret

After providing the credentials in the template files listed above, run the following commands to create the secrets in the cluster:

cd migrate_5x_to_6/templates/swarm

docker secret create migration-saas-username migration-saas-username.txt
docker secret create migration-saas-password migration-saas-password.txt
docker secret create migration-saas-key       migration-saas-key.txt
docker secret create migration-saas-secret    migration-saas-secret.txt
No action needed for papi-property

APIM 5.x.x CAM Platform API credentials (papi-property) already exist from the APIM 5.x.x deployment. papi-property is present in both Kubernetes and Docker Swarm, the migration container mounts the existing secret in either mode.

Step 2: Provide MySQL secrets

Refer to Providing MySQL secrets to provide the mysql-secret-apim5 and mysql-secret-cam6 credentials.

Step 3: Provide TLS setup (Conditional step)

If your MySQL connection requires TLS, refer to Providing TLS setup to configure migration-specific TLS settings.

Step 4: Customize migration configuration

Refer to Customizing migration configuration to configure migration-override.env.

Next steps: Build and deploy the migration pod

With your prerequisites configuration in place, continue to build, deploy, and connect the migration pod. Refer to Building and deploying the migration pod for more information.

On this Page