Overview of Deploying Elastic Path Commerce
After initializing CloudDeploy, the new jobs in the Jenkins server created by CloudCore enables using the functionalities of CloudDeploy. With these jobs, you can build Docker images. These images are required for deploying Elastic Path Commerce and deploy Elastic Path Commerce in the single instance development environment and an Author and Live environment. You can create a production-like environment with the Author and Live environment. You can view these jobs in the Jenkins job folder CloudOps.
Note: Before using any CloudOps component, ensure that you are familiar with Jenkins. For more information on knowledge requirements for using Elastic Path CloudOps for AWS (Amazon Web Services), see CloudOps Requirements.
For information on how to access the Jenkins server, see the Jenkins Server section in Validating CloudCore Initialization.
Jenkins Jobs
You can categorize the CloudDeploy Jenkins jobs into the following categories:
| Job Category | Purpose |
|---|---|
| Docker Image Builds | Builds Docker images required for deploying Elastic Path Commerce. These images include a base image with CentOS, a Java JRE (Java Runtime Environment) and Tomcat installed, images for each Elastic Path web application, a MySQL database image populated with our test data, and an ActiveMQ image for development purposes. |
| Elastic Path Commerce Deployments | Deploys single instance environments for development and test purposes, and pre-production Author and Live environments for a full-fledged production-like environment. |
| Environment Updates | Updates Docker images and databases on existing Author and Live deployments. For more information, see Updating an Author and Live Environment for more details. |
| Initialization | Builds initial Docker images and required for deployment. |
| Maintenance | Keeps the resources, such as AMIs and the Amazon S3 bucket for CloudOps, up-to-date. |
Docker Image Builds
The following jobs build the Docker images needed to deploy Elastic Path Commerce:
These jobs use the Elastic Path Docker repository to build the Docker images. After the images are successfully built, the Jenkins jobs push the images to their respective repositories in ECR (Elastic Container Registry).
For more information on how to see the parameter values that a job was run with, see the How to see the parameter values a Jenkins jobs is run with? section.
BuildActiveMQ
This job builds the ActiveMQ Docker image used in the single instance development environment.
| Parameter | Description |
|---|---|
EP_ACTIVEMQ_VERSION | The version of ActiveMQ that the job uses to build the Docker image. |
ACTIVEMQ_IMAGE_TAG | The name the job tags the image in ECR. |
DOCKER_BRANCH | The branch and release version of the Docker Elastic Path repository to use for building the image. |
DOCKER_GIT_REPO_URL | The URL to the Docker Elastic Path repository. |
CONSUL_URL | The URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store the default values for some parameters. |
BuildBaseImage
This job builds the base Docker image that the BuildEpImage job uses to build the Elastic Path application Docker images.
This job first builds a CentOS image with customizations including a Java JRE. The job then uses this image to build the final base image, which has Tomcat installed.
| Parameter | Description |
|---|---|
EP_TOMCAT_VERSION | The version of Tomcat to install on the final base Docker image. Must be a full version string like: x.x.x. Currently supported Tomcat versions depend on EP Commerce versions: Tomcat 7.0.81 for EP Commerce 7.1 to 7.3, Tomcat 9.0.10 for EP Commerce 7.4 |
EP_JAVA_DOWNLOAD_URL | A link to download Java JRE. |
EP_IMAGE_TAG | This parameter is deprecated and not used. |
DOCKER_BRANCH | The branch and release version of the Docker Elastic Path repository to use for building the image. |
DOCKER_GIT_REPO_URL | The URL to the Docker Elastic Path repository. |
CONSUL_URL | The URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store the default values for some parameters. |
BuildEPImage
This job builds and uploads to ECR the Elastic Path Commerce web app Docker images such as:
- Cortex server
- Integration server
- Commerce Manager server
- Search server
- Batch server
It also builds and uploads a containerized version of the Data Population tool that is used to populate a database with EP data during deployment of EP Commerce. All web-apps and data come from the same deployment package.
| Parameter | Description |
|---|---|
EP_TOMCAT_VERSION | Changes which Tomcat files and base image to use. Must be a full version string like: x.x.x and match the EP_TOMCAT_VERSION used when running the BuildBaseImage job. Currently supported Tomcat versions depend on EP Commerce versions: Tomcat 7.0.81 for EP Commerce 7.1 to 7.3 and Tomcat 9.0.10 for EP Commerce 7.4 |
DEPLOYMENT_PACKAGE_S3_URI | The S3 location of the Elastic Path deployment package zip file that the job uses when building the Docker images. The deployment package contains the compiled Java code from all of the Elastic Path applications, application data, and other important files. |
EP_IMAGE_BUILDER_CONFIG | The name of the config file the build script uses when building the Elastic Path images. The config file specifies which Elastic Path web apps to build and what Dockerfile template to use when building them. |
EP_IMAGE_TAG | The name the job tags built images in ECR. |
DOCKER_BRANCH | The branch and release version of the Docker Elastic Path repository to use for building the images. |
DOCKER_GIT_REPO_URL | The URL to the Docker Elastic Path repository. |
CONSUL_URL | The URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store default values for some parameters. |
BuildMySQL
This job builds the MySQL Docker image used in the single instance development environment. It is based on the MySQL 5.7 stock image and includes some additional features such as health-checks and EP required database config.
| Parameter | Description |
|---|---|
MYSQL_IMAGE_TAG | The name the job tags the image in ECR. |
DOCKER_BRANCH | The branch and release version of the Docker Elastic Path repository to use for building the image. |
DOCKER_GIT_REPO_URL | The URL to the Docker Elastic Path repository. |
CONSUL_URL | The URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store the default values for some parameters. |
Elastic Path Commerce Deployments
The following jobs support deploying and updating Elastic Path Commerce environments:
- CreateEcsAmi
- SyncS3GitRepo
- DeploySingleInstanceDevEnvironment
- DeployAuthorAndLive
- UpdateEnvironment_1_StageUpdates
- UpdateEnvironment_2_ApplyUpdates
For more information on how to see the parameters that a job is run with, see How to see the parameter values a Jenkins jobs is run with?.
CreateEcsAmi
This job creates an Elastic Path customized version of the AWS ECS (Elastic Container Service) optimized AMI (Amazon Machine Image).
| Parameter | Description |
|---|---|
STACK_NAME | The name of the stack to create in CloudFormation. |
CLOUDCORE_BRANCH | The CloudCore branch and release version folder in the Amazon S3 bucket from which the job gets CloudFormation templates. |
OPT_ECS_AMI_NAME | The name of the ECS-optimized AMI that AWS publishes. This AMI is used as a base for the new customized AMI. |
KEY_NAME | The name of the SSH key to use when launching any EC2 instances. |
INSTANCE_TYPE | The EC2 instance type to use when launching any EC2 instances. |
NETWORK_STACK | The name of the CloudOps network CloudFormation stack, which is used to source networking information, such as subnets and security groups. |
EC2_NAME | The name of the EC2 that the CloudFormation stack, STACK_NAME, creates. |
ECS_OPT_AMI_NAME | The name of the new ECS-optimized AMI to be created. |
CONSUL_URL | The URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store default values for some parameters. |
SyncS3GitRepo
The SyncS3GitRepo job syncs CloudDeploy files in the Amazon S3 bucket for CloudOps with the Git repository that is specified in the job parameter.
The files updated include CloudFormation templates, scripts, and other important files related to building and deploying with CloudDeploy.
| Parameter | Description |
|---|---|
CLOUDDEPLOY_GIT_REPO_URL | The Git repository from which the Amazon S3 resources are updated. |
CLOUDDEPLOY_BRANCH | The CloudDeploy branch and release version with which to update the Amazon S3 resources. |
CONSUL_URL | The URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store the default values for some parameters. |
DeploySingleInstanceDevEnvironment
This job deploys a single instance development environment. For more information on the single instance environment, see Deploying Single Instance Environment.
| Parameter | Description |
|---|---|
STACK_NAME | The name of the stack to create in CloudFormation. |
ECS_AMI_ID | The ID of the ECS-optimized AMI to use when this job launches any EC2 instances that run containers. |
CLOUDDEPLOY_BRANCH | The CloudDeploy branch and release version folder in Amazon S3 from which the job gets CloudFormation templates. |
CLOUDDEPLOY_GIT_REPO_URL | The Git repository from which the Amazon S3 resources are updated. |
EP_IMAGE_TAG | The Docker image to use for all Elastic Path Commerce related containers when deploying the single instance environment. |
MYSQL_IMAGE_TAG | The Docker image to use for the MySQL container in the single instance environment. |
ACTIVEMQ_IMAGE_TAG | The Docker image to use for the ActiveMQ container in the single instance environment. |
KEY_NAME | The name of the SSH key to use for any launched EC2 instances. |
NETWORK_STACK | The name of the CloudOps network CloudFormation stack, which is used to source networking information, such as subnets and security groups. |
ROUTE_53_STACK_NAME | The name of the CloudOps Route53 related CloudFormation stack. This stack is used to source DNS information like Hosted Zone IDs. |
EP_CERTIFICATE_ARN | The ARN (Amazon Resource Name) for the HTTPS certificate in AWS Certificate Manager used to initialize CloudCore. This setting is required in order to use a custom DNS name with the API gateway. |
DNS_NAME | The DNS name to point to the application load-balancer. |
SI_API_GW_NAME | The name to use when creating the API gateway. |
SI_API_GW_CORTEX_STAGE_NAME | The AWS API gateway stage name of the Cortex resource in the API gateway. |
SI_API_GW_STUDIO_STAGE_NAME | The AWS API gateway stage name of the Studio resource in the API gateway. |
SI_CORTEX_API_GW_DNS_NAME | The DNS name to point to the API gateway. |
SI_CORTEX_NLB_DNS_NAME | The DNS name to point to the internal network load-balancer. |
SI_MYSQL_ELB_DNS_NAME | The DNS name to point to the elastic load-balancer used by the MySQL service. |
SI_ACTIVEMQ_ELB_DNS_NAME | The DNS name to point to the elastic load-balancer used by the ActiveMQ service. |
EP_COMMERCE_ENVNAME | The application configuration file in the Elastic Path Commerce deployment package to use when deploying the environment. For more info, see Application Configuration Files. |
EP_CLOUDOPS_ENVNAME | The CloudOps environment configuration file to use when deploying the environment. For more info, see CloudOps Default Configuration Sets. |
DATABASE_TYPE | The type of database the environment uses. |
ENV | Adds this prefix to resources, this parameter is used as a prefix to create unique names for resources. |
LOAD_BALANCER_SCHEME | The scheme to use for the application load-balancer. Can be either internet-facing or internal. |
NAMESPACE | The namespace where Docker images are pulled from when deploying a single instance environment. The default value is empty. |
CONSUL_URL | Specifies the URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store the default values for some parameters. |
CONFIG_PREFIX | Additional prefixes to use when locating keys in the Consul config store. |
DeployAuthorAndLive
This job deploys an Author and Live environment. For more information on deploying Author and Live environments, see the Deploying Authoring and Live Environments page.
| Parameter | Description |
|---|---|
STACK_NAME | The name of the stack to create in CloudFormation. |
LIVE_ACTIVEMQ_SUBDOMAIN | Subdomain for the Live ActiveMQ cluster. |
AUTHOR_ACTIVEMQ_SUBDOMAIN | Subdomain for the Author ActiveMQ cluster. |
AUTHOR_SUBDOMAIN | Subdomain for the Author application load-balancer. |
LIVE_CM_SUBDOMAIN | Subdomain for the Live CM load-balancer. |
LIVE_CORTEX_SUBDOMAIN | Subdomain for the Live Cortex load-balancer. |
LIVE_INTEGRATION_SUBDOMAIN | Subdomain for the Live Integration load-balancer. |
LIVE_SEARCHMASTER_SUBDOMAIN | Subdomain for the Live Search master load-balancer. |
AUTHOR_CORTEX_NLB_DNS_NAME | The DNS name for the internal network load-balancer pointing to Cortex. |
LIVE_API_GW_NAME | The name to use when creating the Author API gateway. |
AUTHOR_API_GW_NAME | The name to use when creating the Live API gateway. |
LIVE_API_GW_CORTEX_STAGE_NAME | The AWS API gateway stage name of the Cortex resource in the Live API gateway. |
AUTHOR_API_GW_CORTEX_STAGE_NAME | The AWS API gateway stage name of the Cortex resource in the Author API gateway. |
LIVE_API_GW_STUDIO_STAGE_NAME | The AWS API gateway stage name of the Studio resource in the Live API gateway. |
AUTHOR_API_GW_STUDIO_STAGE_NAME | The AWS API gateway stage name of the Studio resource in the Author API gateway. |
LIVE_CORTEX_API_GW_DNS_NAME | The DNS name for the Live API gateway. |
AUTHOR_CORTEX_API_GW_DNS_NAME | The DNS name for the Author API gateway. |
BASE_DNSNAME | Base DNS name for each of the Author and Live services. |
AUTHOR_DB_INSTANCE_IDENTIFIER | The name for identifying the Author DB instance. |
LIVE_DB_INSTANCE_IDENTIFIER | The name for identifying the Live DB instance. |
AUTHOR_EP_DB_MASTER_USER | The username of the Author’s RDS (Relational Database Service) master user. |
AUTHOR_EP_DB_MASTER_PASSWORD | The password of the Author’s RDS master user. |
LIVE_EP_DB_MASTER_USER | The username of the Live’s RDS master user. |
LIVE_EP_DB_MASTER_PASSWORD | The password of the Live’s RDS master user. |
ACTIVEMQ | This parameter is obsolete, you need not set this value. |
AMAZON_LINUX_AMI_ID | The ID of the AMI that want to use when you launch any EC2 instance that does not run any container. |
ECS_AMI_ID | The ID of the ECS-optimized AMI that you want to use when this job launches any EC2 instance that runs containers. |
CLOUDDEPLOY_GIT_REPO_URL | The Git repository from which the Amazon S3 resources are updated. |
CLOUDDEPLOY_BRANCH | The CloudDeploy branch and release version folder in Amazon S3 from which the job gets CloudFormation templates. |
EPRDS | The size of the RDS instances to create for both Author and Live Elastic Path databases. |
EP_IMAGE_TAG | The Docker image to use for all Elastic Path Commerce related containers when you deploy the Author and Live environment. |
KEY_NAME | The name of the SSH key to use for any launched EC2 instances. |
OFFICE_IP_ADDRESS | The public IP address of the office to add to the public security group ingress rules. |
NETWORK_STACK | The name of the CloudOps network CloudFormation stack, which is used to source networking information, such as subnets and security groups. |
ROUTE_53_STACK_NAME | The name of the CloudOps Route53 related CloudFormation stack. This stack is used to source DNS information, such as Hosted Zone IDs. |
LAMBDA_STACK_NAME | The name of the CloudOps Lambda CloudFormation stack, which is the Lambda Function that puts the Author and Live RDS endpoints into the config store. |
EP_CERTIFICATE_ARN | The ARN for the HTTPS certificate in AWS Certificate Manager used to initialize CloudCore. This setting is optional, but note that the Author and Live environment does not use SSL if this field is left blank. |
CONFIG_PREFIX | The key to store the Author and Live RDS endpoint values in the config store. |
EP_ACTIVEMQ_VERSION | The version of ActiveMQ to be used. |
EP_RDS_VERSION | The RDS engine version for both Author and Live Elastic Path databases. |
EP_RDS_PARAMETER_GROUP | The AWS database parameter group for both Author and Live Elastic Path databases. |
AUTHORING_EP_COMMERCE_ENVNAME | Specifies the application configuration file in the Elastic Path Commerce deployment package to use when deploying the Authoring environment. For more info, see Application Configuration Files. |
LIVE_EP_COMMERCE_ENVNAME | Specifies the application configuration file in the Elastic Path Commerce deployment package to use when deploying the Live environment. For more info, see Application Configuration Files. |
AUTHORING_EP_CLOUDOPS_ENVNAME | Specifies the CloudOps Authoring environment configuration file to use in the Authoring environment. For more info, see CloudOps Default Configuration Sets. |
LIVE_EP_CLOUDOPS_ENVNAME | Specifies the CloudOps Live environment configuration file to use in the Live environment. For more info, see CloudOps Default Configuration Sets. |
NAMESPACE | The namespace where Docker images are pulled from when deploying an Author and Live environment. The default value is empty. |
CONSUL_URL | The URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store the default values for some parameters. |
ENV | This parameter is used to make each Author and Live CloudFormation stack name unique. |
UpdateEnvironment_1_StageUpdates
This job generates a script that you can use to update an Author and Live environment. For more information on updating an Author and Live environment, see Updating Environment.
Note: This Jenkins job is to update a deployment that is not under active load. Contact Elastic Path Support for more information about updating a deployment that is under active load.
| Parameter | Description |
|---|---|
APPLICATIONS_STACK_NAME | Specifies the name of the application stack that you want to update. |
NEW_IMAGE_TAG | Specifies the Docker image tag to which you want to update your stack. |
WITH_DB_UPDATES | Specifies that updating the environment’s database is enabled. If you enable this setting, you must also set the RDS_STACK_NAME and DATA_POP_COMMAND values. |
RDS_STACK_NAME | Specifies the CloudFormation stack that creates the RDS instance that you want to update. |
DATA_POP_COMMAND | Specifies the data population command to be run when updating the database. The options are update_db and reset_db. |
ROOT_USERNAME | Specifies the root database username (required when DATA_POP_COMMAND is set to reset-db). |
ROOT_PASSWORD | Specifies the root database password (required when DATA_POP_COMMAND is set to reset-db). |
STAGING_DIRECTORY_S3_URI | Specifies the folder in Amazon S3 where you can stage the update script that this job generates. |
ZERO_DOWN_TIME | Specifies that the update is run in "Zero Downtime" mode. For more information on zero downtime mode, see Updating Environment. |
CLOUDDEPLOY_BRANCH | Specifies the CloudDeploy branch and release version folder in Amazon S3 from which the job gets CloudFormation templates and update related scripts. |
CLOUDDEPLOY_GIT_REPO_URL | Specifies the URL to the CloudDeploy repository to use when sourcing the update related scripts. |
CONSUL_URL | Specifies the URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store the default values for some parameters. |
UpdateEnvironment_2_ApplyUpdates
This job runs the update script created by the UpdateEnvironment_1_StageUpdates job. For more information on updating an Author and Live environment, see Updating Environment.
Note: This Jenkins job is to update a deployment that is not under active load. Contact Elastic Path Support for more information about updating a deployment that is under active load.
| Parameter | Description |
|---|---|
STAGING_DIRECTORY_S3_URI | The same Amazon S3 folder used in the UpdateEnvironment_1_StageUpdates job to stage the update script. |
CONSUL_URL | The URL to the Consul server that CloudCore creates. Jenkins jobs use Consul to store the default values for some parameters. |
STAGING_FILE | The name of the update script located in the folder specified by STAGING_DIRECTORY_S3_URI. |