Service Updates for Liferay Cloud

The service updates for 2021.12.1 includes the CI service.

liferay/dxp docker image tags

The liferay/dxp docker images provide information about the liferay version, patching level, and docker script associated with the image. The tags on Dockerhub for liferay/dxp are formatted as follows

liferay/dxp:{Liferay.DXP.Version}-{Patching-Level}-d{Docker.Script.Version}-{Timestamp}
liferay/dxp:7.2.10-dxp-11-d1.5.4-20210310143709

When selecting which liferay/dxp base image to utilize for your project, please consider the entire docker tag, and be sure to check out the release notes for your patching level before applying to your environment: DXP Release Notes

Due to the way that docker images are cached within the platform, please always utilize the tags with the full timestamp at the end. These are snapshots and will always yield the exact image that is published. Docker tags without the timestamp are considered rolling tags and should not be used.

Deprecated Environment variables in CI service

The following environment variables should no longer be used. They are considered unsupported and may no longer function. A replacement is specified if it exists.

DEPLOY_BRANCH -> replaced by LCP_CI_DEPLOY_BRANCH
DEPLOY_TARGET -> replaced by LCP_CI_DEPLOY_TARGET
GITHUB_BRANCH_FILTER_EXCLUDE -> replaced by LCP_CI_SCM_BRANCH_FILTER_EXCLUDE
GITHUB_BRANCH_FILTER_INCLUDE -> replaced by LCP_CI_SCM_BRANCH_FILTER_INCLUDE
GITHUB_REPOSITORY -> split into two LCP_CI_SCM_REPOSITORY_OWNER and LCP_CI_SCM_REPOSITORY_NAME
GITHUB_TOKEN -> replaced by LCP_CI_SCM_TOKEN
JENKINS_CUSTOMER_PASSWORD -> replaced by project secret
JENKINS_CUSTOMER_USER_NAME -> replaced by project secret
JENKINS_EMAIL_NOTIFICATIONS_FROM -> LCP_CI_EMAIL_NOTIFICATIONS_FROM
JENKINS_LCP_CLI_PASSWORD -> replaced by project secret
JENKINS_LCP_CLI_USER_NAME -> replaced by project secret

Note: Some older projects may require DXP Cloud support to rotate the credentials used for JENKINS_LCP_CLI_PASSWORD and JENKINS_LCP_CLI_USER_NAME

CI and SCM Tokens

As a convenience the CI service has been configured to manage the git web hooks for every git provider. Unfortunately this has lead to a conflict of interest between security and ease of use. The permissions that managing the git web hook requires is typically higher level permissions than recommended for a project. 

In order to address the security issue, the CI service now allows turning off the configuration for managing web hooks automatically. This allows much lower permissions to be assigned to the LCP_CI_SCM_TOKEN.

In order to be backward compatible, the previous configuration has been left in place but it is easily turned off through setting an environment variable on the CI service

LCP_CI_SCM_MANAGE_HOOKS=false

Liferay Cloud CLI Options

As the Liferay Cloud CLI expands its feature set, there may be times when some options are advantageous to set during the project build in the CI service. Some options are already available. However, older releases of the CI service cannot take advantage of newer options within the CLI, since they are currently being matched to a specific environment variable. To bridge the gap, there is a new, more flexible environment variable that can specify multiple options. The options are sanitized and checked against a reserved list of options that the CI must use.

LCP_CI_CLI_OPTS="quiet suppress-prompts"

LCP_CI_CLI_LOG_LEVEL
LCP_CI_CLI_USE_EXTERNAL_GIT

LCP_CI_CLI_OPTS="quiet suppress-prompts verbose"

DXP Stack 2021.10.1 

Update Instructions

The Liferay Cloud image is set in the liferay/LCP.json file, but the liferay/dxp image is set in the gradle.properties. This change was made in order to facilitate easier deployment using the Liferay Cloud CLI.

liferay/LCP.json file would set the liferaycloud/liferay-dxp image:

"image":"liferaycloud/liferay-dxp:7.3-4.2.1"

liferay/gradle.properties file would set the liferay/dxp image:

liferay.workspace.docker.image.liferay=liferay/dxp:7.3.10-ga1-d1.5.2-20210301040217

Once the LCP.json files are updated, commit the changes to your Git repository.

git add . && git commit -m "update dxp cloud stack to 2021.12.1"

After pushing these changes to the remote repository, a build will be created in Liferay Cloud, and it is ready to deploy.

Change Log