Documentation

Stage 1: Matching DXP Versions

The first stage of migration is to configure the Liferay service running on DXP Cloud to run the same version of the installation you want to migrate.

This requires cloning the DXP Cloud repository, configuring version changes to it, and then applying such updates back to DXP Cloud by deploying a build.

Find Liferay Version Information

First, find the version number and installed patches for the Liferay DXP installation you want to migrate. You need these values to properly configure the Liferay service in DXP Cloud.

To find these values, use the patching tool:

  1. Follow the instructions here to install the patching tool to the installation you want to migrate.

  2. Navigate with any command line tool to the patching tool folder:

    cd $LIFERAY_HOME/patching-tool
    
  3. Use the patching tool to get your installation’s version information:

    ./patching-tool.sh info
    

The patching tool displays patch and version information including the build version, and any installed fix packs and hotfixes.

The patching tool displays the relevant information you need to configure the Liferay service.

Take note of this information for future steps.

Clone the DXP Cloud Repository

DXP Cloud provides a repository on GitHub together with your project. You must have a clone of the repository locally to make configurations to some files in your project, such as each service’s LCP.json file.

If you have not already cloned the repository, then use any terminal with Git installed to clone it locally:

git clone https://github.com/dxpcloud/acme

Update the Liferay DXP Image in the Repository

Next, update the Liferay DXP image in the repository you cloned previously. This requires you to find the Docker image that is compatible with your Liferay installation’s version information.

  1. Go to the Liferay DXP images page on Docker Hub.

  2. Using the Filter Tags field, filter the list of images using the major version and fix pack number you found previously (for example, with the form 7.2.10-dxp-5). Copy this Docker image name.

    Use the Filter Tags field to narrow down the list of Liferay DXP images to the major version you are looking for.

    Tip

    If you find multiple Docker images, then copy the latest match. With the list sorted by latest, the latest Liferay DXP image is listed at the top even if its name has a timestamp appended.

  3. In your repository, open the liferay/gradle.properties file.

  4. Set the value of liferay.workspace.docker.image.liferay to the Docker image name you copied previously.

    For example, if the Liferay DXP image name is 7.2.10-dxp-5, then set this in gradle.properties:

    liferay.workspace.docker.image.liferay=liferay/dxp:7.2.10-dxp-5
    

This ensures that your DXP Cloud environment runs the correct version of Liferay DXP, so you can successfuly upload your data to it.

Update the Liferay Service Image in the Repository

Next, update the Liferay service image in the Liferay service’s LCP.json file in your repository. This requires you to find an up-to-date Docker image compatible with your Liferay installation’s version.

  1. Go to DXP Cloud’s Services Changelog page.

  2. Click on the most recent services update at the top of the list.

    Click on the most recent services update link to ensure your environment is up-to-date.

  3. Look for the Liferay service images listed on the page. Copy the image name that matches the major version of your on-premises Liferay installation.

    From the Liferay service images listed, pick the one that matches your Liferay installation's major version.

  4. In your repository, open the liferay/LCP.json file.

  5. Set the value of the image field to the Docker image name you copied previously.

    For example, if the Liferay service image name is liferaycloud/liferay-dxp:7.2-4.0.4, then set this in LCP.json:

    "image": "liferaycloud/liferay-dxp:7.2-4.0.4"
    

This ensures that your Liferay service uses a version that is up-to-date and compatible with your version of Liferay DXP.

Add Hotfix Information

You must also add hotfix information for the patches installed in your on-premises installation to the CI service’s LCP.json file.

  1. To check the list of installed patches, run the ./patching-tool.sh info command again from the $LIFERAY_HOME/patching-tool folder.

    You must update your LCP.json with the latest hotfix from your currently installed patches.

    Copy the name of the currently installed hotfix (or “patch”) in your installation. If multiple hotfix names appear, then copy the name of the latest available hotfix.

  2. In your repository, open the ci/LCP.json file.

  3. Add the hotfix name you copied previously as a new environment variable named LCP_CI_LIFERAY_DXP_HOTFIXES_COMMON:

    "env": {
        "LCP_CI_LIFERAY_DXP_HOTFIXES_COMMON": "dxp-5-7210"
    }
    

Important

The hotfix defined in LCP_CI_LIFERAY_DXP_HOTFIXES_COMMON and its dependencies are downloaded and integrated as part of the Jenkins build process.

Create and Deploy a Build

Now that you have updated the version information in your repository, you must deploy it to your environment in a build.

Create a Jenkins Build with Your Changes

Run Git commands to submit your changes using any terminal with Git installed.

  1. Add the changed files to Git:

    git add .
    
  2. Make a commit with your changes and a message:

    git commit -m "DXP Cloud Migration Stage 1"
    
  3. Push the changes to GitHub:

    git push origin master
    

Since your project is linked to the GitHub repository, pushing the changes automatically creates a build. Wait for the build to complete before proceeding.

Deploy the Build to Your Chosen Environment

Finally, use the DXP Cloud Console to deploy the completed build to your chosen environment.

  1. In the DXP Cloud Console, go to the Builds page (using the link at the top of the page).

  2. Find the build you created previously in the list, and from the Actions menu, click Deploy build to.

    Use the build's Actions menu to deploy it.

  3. Select the environment to deploy the build to (e.g., acme-dev).

  4. Read the information below and select the confirmation boxes to confirm the results of the deployment.

    Check the checkboxes and deploy the build when ready.

  5. Click Deploy Build.

The build is deployed to your chosen environment, and the correct versions are applied when the services start up.

Note

The deployment takes some time to complete and for your services to be ready. The process may take longer than usual if it is the first deployment to that environment.

Next Steps

Now you have a deployment to your chosen environment with all of the correct Liferay DXP version information. Next, you will create backup files for your instance’s data to prepare it for DXP Cloud.