Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 3.49 KB

quick-start.md

File metadata and controls

73 lines (46 loc) · 3.49 KB
Raw

Quick Start

The quickest way to try CDF is to run one of the sample projects to stand up some infrastructure. The sample project show you how to use a CDF Package.

Each sample targets a specific Cloud Provider (via a CDF Package), IaC Runtime and programming language.

At the moment all the samples are TypeScript.

The following instructions are based on MacOS but should work on Linux/Windows with some adjustments.

Prerequisite

  • NodeJS, intall the latest
  • NPM, instsall the latest
  • IaC runtime, Install CDK TF CLI for the sample below
  • Clon the repo, git clone https://github.com/openfabr/cdf.git
  • DigitalOcean (DO) account

Run the Terraform CDK Sample Project

This sample is configured to create a Digital Ocean App and deploy a test app to it from a container image that's already published on DockerHub.

  • Create a DO personal access token wiht read+write scope via the DO dashboard (see instructions).

  • Open a terminal and run export DIGITALOCEAN_ACCESS_TOKEN=<your access token>

  • Deploy to spin up the infrastructure

cdktf deploy

If successful you should see a new app in your Digital Ocean dashboard. Browsing to this URL should loaf a page saying "Hello world!"

  • Tidy up after you finish everything:
cdktf destroy

That was bit boring but now that you have something working end-to-end you can experiment and learn by making small changes.

Deep Dive

This CDK TF sample project uses the CDF Orchestrator to combine a CDF Package with an infrastructure configuration file to produce a CDK TF Stack. The CDK TF CLI deploy command does the execution.

The CDF Package exposes building blocks that encapsulate complexities of the cloud provider services. The Package author decides which services to bundle in the package and how much to encapsulate. It's best to think of this as encapsulating common patterns and best practices.

You specify the infrastructure to deploy by adjusting the config file ./lib/config.json. The schema of the config file is determined by the package. It's essentially a serialised version of the Package API.

Try deploying your own app

If you want to try deploying your own app then publish as a container image to your DockerHub.

  • login to your docker accoount docker login
  • from the root of the app repo docker build -t <registry_name>/<repo_name>:latest .
  • publish docker push <registry_name>/<repo_name>:latest

Then adjust the ./lib/config.json to reflect your container registry name and container repo name.

{
  "dockerhubRegistryName": <registry_name>,
  "containerRegistryRepoName": <repo_name>,
}

Further Reading