Prepushing

You can configure the access to supported platforms before pushing the TIBCO Cloud™ API Management - Local Edition Docker images and starting API Management - Local Edition cluster deployment.



The access to the following platforms and container registries can be configured:

Jenkins Job Name Container Registry Platform
configure_aws AWS ECR (AWS Elastic Container Registry) AWS
configure_azure Azure Container Registry Azure
configure_docker_registry_v2 Docker Registry V2 Docker Swarm, etc.
configure_gcp GCP Container Registry GCP (Google Cloud Platform)

Configuring AWS

For deployment of Local Edition cluster in Kubernetes at AWS, it is recommended to use Access Key / Secret Access Key from service account. AWS IAM role is also supported.

Access Key / Secret Access Key / AWS IAM role are used to:
  • create AWS Container Registry;
  • push Local Edition Docker images to AWS Container Registry;
  • create Kubernetes cluster in AWS;
  • create Local Edition cluster in Kubernetes at AWS.

For deployment details, refer to AWS using Kubernetes.



Name Definition
aws_access_key_id AWS Access Key ID
aws_secret_access_key AWS Secret Access Key
aws_default_region AWS default region
aws_role_arn AWS role arn

Configuring Azure

For deployment of Local Edition cluster in Kubernetes in Azure, it is recommended to use Service Principal. Service Principal is used to:

  • Create Azure Container Registry;

  • Push Local Edition Docker images to Azure Container Registry;

  • Create Kubernetes cluster using Azure Kubernetes Service;

  • Create Local Edition cluster in Kubernetes at Azure.

For deployment details, refer to Azure using Kubernetes.



Name Definition Notes
DIRECTORY_ID Directory (tenant) ID
APPLICATION_ID Application (client) ID
CLIENT_SECRET Client Secret
RESOURCE_GROUP Resource Group The resource group will be created if it does not exist.
RESOURCE_GROUP_REGION Resource Group Region
CONTAINER_REGISTRY Container Registry The container registry will be created if it does not exist.

Configuring CGP

For deployment of Local Edition cluster in Kubernetes at GCP, it is recommended to use Service Account. Service Account is used to:

  • Create GCP Container Registry;
  • Push Local Edition Docker images to GCP Container Registry;
  • Create Kubernetes cluster using GCP Kubernetes Service;
  • Create Local Edition cluster in Kubernetes at GCP.

For deployment details, refer to Deployment on Google Cloud Platform using Kubernetes.



Name Definition Notes
GCP_REGISTRY_HOST GCP Registry Host These are currently available for different regions (https://cloud.google.com/container-registry/docs/pushing-and-pulling):
  • gcr.io
  • us.gcr.io
  • eu.gcr.io
  • asia.gcr.io
GCP_REGISTRY_HOST GCP Registry Host
service_account_json_key_file The JSON file contains keys for the service account

Configure Docker Registry v2

For deployment on Docker Swarm, Local Edition Docker images can be stored in Docker Registry v2.



Name Definition
DOCKER_REGISTRY_HOST Docker Registry Host
DOCKER_REGISTRY_PORT Docker Registry Port
DOCKER_REGISTRY_USERNAME Docker Registry Username
DOCKER_REGISTRY_PASSWORD Docker Registry Password
DOCKER_REGISTRY_REPO Docker Registry Repo