CX Cloud Docs
v3.0-docs
v3.0-docs
  • Welcome To CX Cloud
  • Introduction
    • Why CX Cloud?
    • Architecture Overview
    • How To Participate?
    • Change Log
  • Getting Started
    • Requirements
      • Prepare Local Environment
      • Install CX Cloud CLI
    • Setting up a CX Cloud Project
      • Provision Infrastructure
      • Generating Core Services
      • Generating a Frontend Demo
      • Configuring Routing Manifest
      • Configuring CI/CD Pipeline
      • Configuring Data Engine
  • Guides
    • Infrastructure Operations
      • Getting Access To An Already Running Infrastructure
      • Deleting Deployments
      • Managing Secrets
    • Application Development
      • Git Repository Conventions
      • Process Engine
Powered by GitBook
On this page
  • Install Git client
  • Install and Configure the AWS CLI tools
  • Install Kubernetes and Kops
  • Install Helm
  • Install Terraform
  • Install Node.js and NPM
  • Install Docker
  • Install Ansible
  1. Getting Started
  2. Requirements

Prepare Local Environment

PreviousRequirementsNextInstall CX Cloud CLI

Last updated 5 years ago

Install Git client

Currently, our CLI only supports GitHub as a versioning system. Once you have installed Git client of your preference, make sure to configure global username and email properties with values from your GitHub account like this:

git config --global user.name "username"
git config --global user.email "example@email.com"

Install and Configure the AWS CLI tools

You naturally need an AWS account. For quick testing, You can create your own . Then install the AWS Cli tools using and configure a profile:

$ aws configure --profile myproject

Check for more information on configuring AWS CLI.

Export your AWS profile to an environment variable. This variable is used by CX Cloud tools to interact with your AWS account:

$ export AWS_PROFILE=myproject

CX Cloud CLI supports preset AWS API keys as environment variables. This is useful for example when running for storing the AWS secrets in your operating system's secure keystore. The AWS_PROFILE doesn't need to be exported in case AWS Vault is used.

Install Kubernetes and Kops

Before you start, you need to have Kubernetes and it's tools installed on your computer. Follow to Install those. On Mac, you can install Kubernetes tools using homebrew:

$ brew install kubernetes-cli

CXCloud CLI uses Kops to create and configure your Kubernetes cluster. You can install it on your Mac using homebrew:

$ brew update && brew install kops

Or on your Linux machine:

curl -LO https://github.com/kubernetes/kops/releases/download/$(curl -s https://api.github.com/repos/kubernetes/kops/releases/latest | grep tag_name | cut -d '"' -f 4)/kops-linux-amd64
chmod +x kops-linux-amd64
sudo mv kops-linux-amd64 /usr/local/bin/kops

Install Helm

$ brew install kubernetes-helm

Install Terraform

$ brew install terraform

Install Node.js and NPM

You need to install Node.js and NPM on your computer. It is recommended to install the latest Node.js LTS version. On macOS you can do this using homebrew:

$ brew install node

Once you have installed Node, you can confirm that NPM is working using npm --version

Install Docker

Install Ansible

To be able to access the private services in Kubernetes an VPN solution is needed. Ansible is used to install OpenVPN for the CX Cloud Demo.

$ brew install ansible

Check for more information.

on your machine. On Mac this can be done using homebrew:

on your machine. On Mac this can be done using homebrew:

For other systems, you can check .

To be able to compose a deployable image you have to install Docker. Head over to and get the Docker for your system. You'll need to create a Docker account as well.

on your machine. On Mac this can be done using homebrew:

AWS Free Tier account
this guide
this guide
AWS Vault
this guide
Kops' documentation
Install the Helm client
Install Terraform
Node.js official documentation
this page
Install Ansible