To use LCS, you must register a server in an LCS environment. An LCS environment represents a physical cluster of servers or a virtual or logical aggregation of servers. Each environment is part of an LCS project. An LCS project represents a group of users belonging to a company or organization. For example, a project can consist of all the users from a project team or business unit, or it can include the entire company.
LCS projects don’t initially contain any environments. You must therefore create one before you can register any servers in LCS. The first time you log in to lcs.liferay.com, LCS presents you with a wizard that walks you through the environment creation process. Click Get Started to begin.
Each of these steps corresponds to a step in the wizard:
Select the LCS project for your new environment. You can select any of your available LCS projects. Note that each project lists its available subscriptions and whether it supports elastic subscriptions.
Name and describe the environment. The name is mandatory, but the description is optional. Although you can enter anything you wish in these fields, it’s best to choose a name and description that accurately identify the environment (e.g., Development, Production, Test, etc.). Note that you can change these values after creating the environment.
Select the environment’s subscription type from the project’s available subscriptions. Even if you won’t use LCS to activate the servers defined for this environment, you must still select a subscription type. Also note that you can’t change this selection after creating the environment.
Select whether servers that connect to this environment are part of a cluster. LCS provides additional tools in clustered environments that help you manage the cluster. For example, clustered environments show cluster-specific metrics, and fix packs apply to all cluster nodes. There are a few things to keep in mind if you set the environment as clustered:
- You can’t change this setting after creating the environment.
- Each clustered environment can only support nodes that belong to a single cluster. To connect a different cluster’s nodes, you must create a separate clustered environment exclusively for those nodes.
- You must set the portal property
truein any servers that connect to a clustered environment.
Select whether the environment allows elastic subscriptions. Elastic subscriptions let you register an unlimited amount of servers. This is critical for auto-scaling situations in which servers are created and destroyed automatically in response to demand. Elastic environments are also useful for bringing additional servers online on a temporary basis for any other purpose, such as business continuity planning. For more information, see the documentation on elastic subscriptions. Also note that you can’t change this selection after creating the environment.
Enable the LCS services you want to use with servers that connect to this environment. The following services are available:
Liferay Instance Activation: Enabling this lets LCS activate any Liferay DXP instances that connect to the environment. If you disable this service, you must activate via an XML file from Liferay support, and such instances must run version 5.0.0 or newer of the LCS client app.
Note that you must use LCS for activation of Elastic subscriptions. Otherwise, you don’t have to use LCS for activation.
Portal Analytics: Enabling this lets LCS collect and display performance metrics for any servers that connect to the environment. This includes page and portlet load times, JVM garbage collector and memory metrics, and more.
Fix Pack Management: Enabling this lets you use LCS to check for and install Liferay DXP fix packs. Note that this also lets LCS determine installed fix packs.
Portal Properties Analysis: Enabling this lets LCS compare the current portal property settings with their default values for any servers that connect to the environment. Note that LCS doesn’t access security sensitive properties. Click Blacklisted Properties to view and change any additional properties
that are blacklisted from analysis.
A completed form presents your selections. Review them and make any changes that you want. When you’re finished, click Create Environment.
After creating your environment, the wizard shows a screen that lets you download the LCS client app, download the environment’s token file, and go to your project’s dashboard in LCS. Before registering a server in your new environment, however, you must complete the preconfiguration steps for that server.