Deploy Account Management CI Pipeline

The Account Management CI pipeline deploys a MySQL database and Account Management stack. It can build Account Management Docker images from a given Account Management release package or use existing Docker images.

The pipeline can optionally clean up the MySQL database and Account Management stack once an Account Management stack deploys successfully. You can use the pipeline to deploy an Account Management stack for QA purposes or to validate configuration is set up correctly.

For information about which Jenkins jobs are triggered, see the Jobs Built by the Pipeline section.

Jenkins Job Parameters

The following parameters are available in the Jenkins job deploy-account-management-pipeline:

plan_mode

If plan_mode is set, the Jenkins builds triggered by the pipeline plan the Terraform changes. The triggered builds pause until you confirm that you want to proceed with the changes.

kubernetes_nickname

This parameter determines the Kubernetes nickname and namespace the Account Management stack deploys to.

kubernetes_cluster_name

This parameter determines the Kubernetes cluster the Account Management stack deploys to.

docker_image_tag (Optional)

The Account Management Docker images to deploy. If both release_package_url and docker_image_tag are set, the pipeline builds Docker images using the release package given and tags the images using the value in docker_image_tag.

note

This parameter is required if release_package_url is not set.

release_package_url (Optional)

The URL of the Account Management release package to deploy. If both release_package_url and docker_image_tag are set, the pipeline builds Docker images using the release package given and tags the images using the value in docker_image_tag.

note

This parameter is required if docker_image_tag is not set.

allowed_cidrs

A comma-separated list of IP CIDRs allowed to access the Account Management services.

allowOpenAccess

Verification that you are deploying Elastic Path Account Management with the Jenkins job parameter allowed_cidrs set with the CIDR 0.0.0.0/0. Set this parameter to true to acknowledge that you allow the Elastic Path Account Management services to be accessible by the open internet.

TF_VAR_private_jwt_key

A private JWT key. For more information about generating the key, see the Account Management documentation.

am_api_access_token (Optional)

An API access token that can authenticate all API calls to Account Management. Will be generated if not provided.

oidc_discovery_url

The OpenID Connect discovery URL of an Identity Provider.

oidc_client_id

The OpenID Connect client ID of an Identity Provider.

oidc_client_secret

The OpenID Connect client secret of an Identity Provider.

oidc_token_scope

The OpenID Connect token scope of an Identity Provider.

oidc_group_key

The OpenID Connect group key of an Identity Provider.

oidc_group_value_for_associates

The OpenID Connect group value for Associate type Account Management users.

oidc_group_value_for_seller_users

The OpenID Connect group value for Seller type Account Management users.

delete_stack

If delete_stack is set, the pipeline deletes all infrastructure once a successful Account Management deployment completes.

If the pipeline fails, some infrastructure may be left behind. Review the pipeline logs for links to jobs that were run and rerun them with destroy_mode set to clean up infrastructure left behind.

cloudops_for_kubernetes_branch

The branch of CloudOps for Kubernetes to use for the Jenkinsfile and Terraform configuration.

Jobs Built by the Pipeline

The following jobs are built by the Jenkins job deploy-account-managment-pipeline:

1. The MySQL database is created by create-or-delete-account-management-mysql-container

2. (Optional) The Docker images are built by build-docker-images-account-management

3. The Account Management stack is deployed by create-or-delete-account-management-stack

4. (Optional) The Account Management stack is deleted by create-or-delete-account-management-stack

5. (Optional) The MySQL database is deleted by create-or-delete-account-management-mysql-container