Install RapidCloud

Installation prerequisites
  • AWS CLI: https://aws.amazon.com/cli/
    • AWS Profile with administration level permissions for each target deployment AWS Account Run aws configure to set up your profiles
  • Terraform v1.3.4: https://learn.hashicorp.com/terraform/getting-started/install.html
  • macOS:
    • For M1 Mac's you may need to set the following env var TFENV_ARCH=amd64
    • Openssl:
      • macOS: brew install openssl if not installed already, and then
      • export LDFLAGS="-L/usr/local/opt/openssl@3/lib"
      • export CPPFLAGS="-I/usr/local/opt/openssl@3/include"
  • Windows:
Local Workstation:
Download RapidCloud for your operating system, unzip and follow setup instructions below.

macOS



EC2 Instance:
RapidCloud is available as an Amazon AMI for Amazon Linux EC2 Instance.
AMI ID: rapidcloud-v1.7.0-amazon-linux-2023

Setup

Add RapidCloud home directory to your PATH:

cd kc-rapid-cloud

Verify Installation

kc --version
Activate

kc activate and follow prompts

You will receive RapidCloud activation email. Open it and click Confirm your RapidCloud Activation (check for spam folder just in case)

If you cannot find activation email, please Contact us online or by phone (305) 428-8255
Create your first environment

Once your Activation is confirmed, you're ready to create your first RapidCloud Environment.An environment is a specific AWS workload or application, with its own business logic, security, data catalog, data lake, databases, compute services and other AWS resources.

You can create as many environments as you need.

Each environment is managed separately from other environments and can be created in any AWS Account and VPC within your org.

Environment name is comprised of {org}{workload}{environment}. for example: kinect_bitools_dev or abccorp_orders_test

kc init create-env
and follow prompts
Switch between environments

When you have more than one environment, you can switch environment context via CLI (command below) or Console (drop-down at the top).

kc init set-env --env {name_of_your_environment}
RapidCloud CLI

RapidCloud can be managed via CLI or Console. Both provide complete RapidCloud functionality.

RapidCloud CLI can also be used to automate command execution. In other words, if you need to run a number of commands for a specific environment, you can create a script.
Help

kc help -
list all available commands

kc help [module]
(e.g. kc help ingest) - shows help for specific module
Some useful commands:

kc status
displays your environment resources and their status

kc account
shows your organization subscription information and all users

kc metadata
show
displays all metadata collected for current environment
Terraform Commands:

Terraform commands may take a while to run, depending on your environment complexity. We recommend running tf commands from CLI vs the Console.

kc tf init
generate terraform modules for current environment

kc tf plan
show terraform plan

kc tf apply
deploy environment infrastructure

kc tf destroy
destroy environment infrastructure
RapidCloud Console:

RapidCloud console is a feature rich web interface to manage all RapidCloud resources (create, list, change, delete).

Start console
kc [--port port] [--no-browser]
examples:
kc
kc --no-browser
kc --port 5001 --no-browser

If you installed RapidCloud on an Amazon Linux EC2 instance, then use following command to start the console. This will ensure console backend runs in the backround and won;t be terminated when you exit your SSH session.

nohup kc --no-browser &>./logs/rapidcloud.log &

Access at http://127.0.0.1:5000 on localhost or http://{your ip address}:5000 if running on EC2 instance, in which case you can control access permissions via EC2 Security Group Inbound Rules