Cloud Native Experience: AWS Ready - Getting Started

CNE AWS Ready: Prerequisites

Before running the bootstrap scripts to deploy the Liferay Cloud Native Experience (CNE) in your AWS environment, prepare your local machine, cloud accounts, and Git repositories.

Local Command-Line Tools

The bootstrap and deployment scripts require the following DevOps tools. Ensure they are installed and available in your system’s PATH.

ToolRequired VersionPurpose
Git CLI>= 2.40.1Manage GitOps repositories and boilerplate templates.
AWS CLI>= 2.27.25Authenticate with AWS and manage cloud resources.
OpenTofu>= 1.11.4Provision infrastructure resources such as EKS, RDS, and S3.
Terraform>= 1.7.5Provision infrastructure resources such as EKS, RDS, and S3.
kubectl CLI>= 1.25.2Communicate with the Kubernetes cluster and access Argo CD.
Info

The CNE toolkit uses OpenTofu for infrastructure provisioning. Terraform may also work if it is compatible with the toolkit version.

Info

The CNE toolkit supports standard Git providers such as GitHub, GitLab, and Bitbucket. This guide uses GitHub for examples. If using another provider, ensure your repository structure matches the Liferay GitOps boilerplate.

Required Assets

The CNE toolkit provisions infrastructure using GitOps and infrastructure-as-code workflows. Prepare the following assets before running the bootstrap process.

GitOps Repository and PAT

  1. Create a repository using the LiferayCloud/cloud-native-gitops-boilerplate template.

  2. Generate a Personal Access Token (PAT) on your Git provider with read and write access to the GitOps repository contents, so the bootstrap process can access the repository.

AWS Configuration

Note

Cloud Native Experience environments can also run in AWS GovCloud regions. Contact your Liferay representative for guidance on deploying CNE in GovCloud.

  1. Ensure your IAM credentials include permissions to create infrastructure resources such as VPCs, EKS clusters, RDS instances, and S3 buckets.

  2. Create a secret named liferay/credentials/gitops in AWS Secrets Manager to store the Personal Access Token (PAT) used by the bootstrap process.

    KeyDescription
    git_machine_user_idGit username or machine account name
    git_access_tokenPersonal Access Token (PAT)

    Example:

    Secret nameliferay/credentials/gitops
    KeyValue
    git_machine_user_iduser
    git_access_tokenghp_abc…WxYZ
Tip

To use a different secret name, configure it in config.json. For details, see CNE: AWS Ready – Managing Secrets and Licenses.

Next Steps

After completing these prerequisites, continue to Bootstrapping Your Initial Environment.