Prerequisites

• Docker
• Kind
• Access to Cloudentity Private Docker Repository. If you’re a customer, refer to your Support Portal for credentials. If you’re not yet a customer, contact us.

Download Source Files

Download the source files from the acp-on-k8s GitHub repository:

curl -L https://github.com/cloudentity/acp-on-k8s/archive/refs/tags/2.21.0.tar.gz | tar zx
cd acp-on-k8s-main

Alternatively, visit the acp-on-k8s GitHub repository and clone it.

Local Domain Configuration

Add the following local domains used by the Cloudentity deployment to your /etc/hosts file:

127.0.0.1 default.acp.local
127.0.0.1 system.acp.local

Deploy Cloudentity with/without Infrastructure

Use the provided Makefile to start the deployment. By default, the base deployment mode is used. Run the below command to start a Kind cluster and deploy all required components:

make all

If it’s your first time deploying Cloudentity, you will be asked to provide your Docker credentials for the Cloudentity Private Docker Repository.

If you’re a customer, refer to the Support Portal for credentials. If you’re not yet a customer, contact us.

Advanced users may also want to export their Docker credentials themselves:

export DOCKER_USERNAME=<YOUR_USERNAME>
export DOCKER_PASSWORD=<YOUR_PASSWORD>

If you wish to change the deployment mode, add the MODE flag to your command. Make sure that your machine meets the requirements if you want to run the full deployment mode.

To adjust the deployment/platform configuration, Cloudentity recommends forking the repository, making the necessary changes, and deploying Cloudentity. To feed Cloudentity with data, for example, workspaces or client apps, we recommend using the acp-cd Helm Chart that allows to declaratively import Cloudentity configuration. Learn more.

Deploying Cloudentity and all dependencies may take some time depending on your machine specifications. To monitor the deployment status, you can check the logs built into the make all command or execute the make wait MODE={your-deployment-mode} command.

After a successfull deployment, you should see the All components deployed successfully message in your terminal.

Access Cloudentity

Once the deployment is successful, sign into Cloudentity.

• For default access, navigate to https://default.acp.local:8443.

  Default credentials: admin:admin.

• For system administrator access, navigate to https://system.acp.local:8443.

  Default credentials: admin:peyYXiGEd3RMjCJyKzn6JmUpoey7ti5m (see system.secret setting in your Cloudentity platform configuration files).

Result

Congratulations! Your Cloudentity platform instance is now up and running!

Cleanup

When you’re done, use the provided Makefile to remove the deployed stack. This action will delete the Kind cluster and all its components.

make destroy