Getting Started

Using the CloudTruth Solution.

At the heart of CloudTruth is a converged parameter store. Parameters can be created and stored directly within CloudTruth, or referenced from external sources, such as S3. Parameter values can be set for specific environments (ex. Dev/Test, Staging, Production).

Get started by creating a CloudTruth account, create your first parameters and Install the CloudTruth CLI to start accessing parameters across environments!

QuickStart Guide

Create a CloudTruth account

Create your CloudTruth account by navigating to the portal at https://app.cloudtruth.com​

You can choose to create a new login with CloudTruth or use an existing social login with a GitHub, Google or Microsoft account.

You will be taken to the CloudTruth application where you will create an Organization. This is your own private space for creating and managing configurations.

Create an Organization

After creating an account click Create Organization.

Enter a name for your organization. Don't worry, you can edit this later.

On the Invite team members page click Skip Invitations for now.

Create your first Parameters

After creating the organization you are brought to the parameters page. Click Add Item to create a new parameter.

Provide the key with a name and click Create Parameter.

Enter a Static value for the parameter and click Save

Repeat this process to add additional parameters.

Create an API token

A CloudTruth API token can be used with the CloudTruth CLI and for bearer authorization with the GraphQL API.

Open the CloudTruth API administration screen by selecting your user account and clicking CloudTruth API .

Click Generate New Token, provide a Token ID, Read Only permissions and then click Create Token.

Copy your access token now and secure it in a safe place. The token is only available at initial creation and will need to be regenerated if it is lost.

Access Parameters with CloudTruth Run

Install the CloudTruth CLI for your distribution and set the API key in your environment.

Debian/Ubuntu
MacOS
Windows
RedHat/CentOS
Debian/Ubuntu
CT_CLI_VERSION=$(curl --silent "https://api.github.com/repos/cloudtruth/cloudtruth-cli/releases/latest" | grep "tag_name" | sed -E 's/.*"([^"]+)".*/\1/')
curl -sLOJ https://github.com/cloudtruth/cloudtruth-cli/releases/download/${CT_CLI_VERSION}/cloudtruth_${CT_CLI_VERSION}_amd64.deb
sudo dpkg -i cloudtruth_${CT_CLI_VERSION}_amd64.deb

Set the CloudTruth API key in your environment.

export CLOUDTRUTH_API_KEY="YOUR_API_KEY"
MacOS
export CT_CLI_VERSION=$(curl --silent "https://api.github.com/repos/cloudtruth/cloudtruth-cli/releases/latest" | grep "tag_name" | sed -E 's/.*"([^"]+)".*/\1/')
curl -sLOJ https://github.com/cloudtruth/cloudtruth-cli/releases/download/$CT_CLI_VERSION/cloudtruth-$CT_CLI_VERSION-x86_64-apple-darwin.tar.gz
tar xzf cloudtruth-$CT_CLI_VERSION-x86_64-apple-darwin.tar.gz
sudo install -m 755 -o root "cloudtruth-$CT_CLI_VERSION-x86_64-apple-darwin/cloudtruth" /usr/local/bin

Set the CloudTruth API key in your environment.

export CLOUDTRUTH_API_KEY="YOUR_API_KEY"
Windows

These commands will download the Windows executable and extract the contents into your Windows Temp directory then copy the executable to C:\cloudtruth. Run them sequentially.

$CT_CLI_VERSION = ((Invoke-WebRequest https://api.github.com/repos/cloudtruth/cloudtruth-cli/releases/latest).Content | ConvertFrom-Json).tag_name
Invoke-WebRequest -outfile $ENV:TEMP\cloudtruth.zip https://github.com/cloudtruth/cloudtruth-cli/releases/download/$CT_CLI_VERSION/cloudtruth-$CT_CLI_VERSION-x86_64-pc-windows-msvc.zip
Expand-Archive $ENV:TEMP\cloudtruth.zip -DestinationPath $ENV:TEMP
copy-item -Path $ENV:Temp\cloudtruth-$CT_CLI_VERSION-x86_64-pc-windows-msvc\* C:\cloudtruth\
$env:Path += ";C:\cloudtruth"

Set the CloudTruth API key in your environment.

$env:CLOUDTRUTH_API_KEY="YOUR_API_KEY"

The script will add C:\cloudtruthto your Path for the current PowerShell session. You can either addC:\ cloudtruthto your windows path or execute the CLI directly from C:\cloudtruth.

RedHat/CentOS

Coming Soon

The CloudTruth run command will passthrough parameters into your environment. You can now see the parameters you created in your CloudTruth organization.

cloudtruth run --command printenv

Use CloudTruth run to get the value for a specific parameter that is sourced to your environment.

cloudtruth run --command 'echo $YOUR_PARAMETER_KEY'