Getting Started

Getting started with Liferay Cloud (SaaS or PaaS) involves ensuring all accounts, environments, and services have been successfully provisioned and deployed in your instance. Begin with the following steps:

• Check Setup Emails
• Access the Liferay Cloud Console
• Access the Provisioned Project Source Code
• Log into Your CI and Liferay Services
• Verify Setup

Check Setup Emails

Check the email account associated with your Liferay Cloud subscription for setup emails. You should receive a Liferay Cloud onboarding email along with email invitations for each purchased Liferay Cloud environment.

The onboarding email provides necessary credentials for accessing Jenkins and Liferay DXP on non-production environments, as well as important steps for getting started with Liferay Cloud.

Each environment invitation grants access to a single purchased Liferay Cloud environment. Be sure to accept all environment invitations.

Access the Liferay Cloud Console

If you already have an account, log in to the Liferay Cloud Console.

Otherwise, create your account from an environment invitation. The Liferay Cloud Console has no sign-up page, so an invitation is the only way to create an account. Liferay invites the first Admin when your project is provisioned, and that Admin invites the rest of your team.

1. Open the invitation email and click Accept Invite.

2. On the account creation form, enter your name and a password. Your email address is filled in from the invitation, and your account uses that address.

Important

If you never received an invitation, check your junk and spam folders. If it isn’t there, or if the invitation link reports that it’s invalid or expired, ask an environment Admin to send a new one. Admins can invite members, so that’s usually whoever set up your project. If nobody on your team can reach the Liferay Cloud Console yet, contact the Liferay Support team.

After logging in, the Liferay Cloud Console home page appears.

From here, you can access and manage environments and deployments, as well as invite other team members.

Access the Provisioned Project Source Code

New Liferay Cloud projects are provisioned a temporary GitHub repository hosted in the dxpcloud organization. This repository contains the template for a Liferay Cloud development project.

To access to your new project repository, follow the instructions in the Liferay Cloud onboarding email and accept the subsequent GitHub invitation.

After accepting the invitation, locate your provisioned project repository:

1. Log into GitHub.

2. Search dxpcloud in the Your teams search box.

Once you have found your provisioned repository, you must:

1. Transfer the provisioned repository’s content to a private Git repository.

2. Integrate the private repository with the Jenkins (CI) service in Liferay Cloud using a Webhook.

See Configuring Your GitHub Repository for detailed instructions.

Note

Using an alternative hosting service? See how to configure your Bitbucket or GitLab repositories.

Log into Your CI and Liferay Services

Log into the Jenkins (CI) web interface, then log into your Liferay DXP instance’s non-production environments (e.g., dev and uat) so you can access them.

Login credentials are provided in the initial onboarding email, and listed as secrets in their respective environments.

See Logging into Your Liferay Cloud Services for detailed instructions.

Verifying Setup

Before beginning deployment in Liferay Cloud, verify that the correct environments and services have been successfully provisioned and deployed.

Verifying Environments

Verify all purchased environments are listed in the Liferay Cloud Console home page under Projects.

If any environments are missing after you’ve accepted all environment invitations, please contact the Liferay Support team.

Verifying Environment Locations

Verify that the location for each environment matches the location requested by your team.

All environment locations are listed on the Liferay Cloud Console home page.

You can also view an environment’s location by navigating to its Overview page or Settings page.

If the environment location does not match the location requested by your team, please contact the Liferay Support team.

Verifying Cloud Stack Services

Verify the Liferay Cloud stack services are properly deployed:

1. Access the dev environment from the Liferay Cloud Console.

2. Navigate to the Services page.

When properly deployed, the status of all 5 default Cloud Stack services should be ‘Ready’.

Related Topics

• Configuring Your GitHub Repository
• Understanding Liferay Cloud Environments
• Logging into Your Liferay Cloud Services