To use the examples in this repo you will require Terraform to be installed. To install Terraform, you can use the instructions in the following guide.
https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli
You will also need the Terraform CDKTF and NodeJS, please follow the instructions in the guide below to install these dependencies.
https://developer.hashicorp.com/terraform/tutorials/cdktf/cdktf-install
Terraform requires authentication in order to interact with the DigitalOcean and CloudFlare APIs. The following section shows how to obtain and set the tokens for each provider.
Fetch your token from
If you complete the details and then press the Generate button you will be taken back to the other screen and the token will
be shown.
Copy this token and set it as an environment variable, Terraform will automatically read this variable and automatically pass it with any API request. Using an environment ensures that the API key is not hardcoded into the config and accidentally leaks into the public domain. Leaking your API key will allow third parties to create infrastructure in your DigitalOcean account (The token in the image above was revoked just after the screenshot was taken).
export DIGITALOCEAN_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"You can get a token from the following URL:
https://dash.cloudflare.com/profile/api-tokens
If you click on "Create Token" then "Create Custom Token" you will be able to specify the permissions that Terraform needs. Your token will need the following privileges.
| ------- | -------------- | ---- | | Account | Worker Scripts | Edit | | Zone | Worker Routes | Edit | | Zone | DNS | Edit |
| ------- | -------------- | | Include | Specific Account where your domain is hosted |
| ------- | -------------- | -------------- | | Include | Specific Zone | Your zone name |
It is good practice to keep the TTL as short as possible, just in case you acccidentally leak the token.
Then you can set this token along with your Cloudflare account ID to the following environment variables.
export CLOUDFLARE_ACCOUNT_ID="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
export CLOUDFLARE_API_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"Once everything is setup please see the following examples for instructions on how to run each individual demo.
Example using Cloudflare and DigitalOcean to deploy a DigitalOcean App and expose a Cloudflare domain for public access.
NOTE: Cloudflare is optional and can be disabled by setting the environment variable VAR_cloudflare_enabled=false
Example to create a DigitalOcean App using a CDKTF Typescript module
Example using Cloudflare and DigitalOcean to deploy a DigitalOcean App and expose a Cloudflare domain for public access.
Example using Cloudflare and DigitalOcean to deploy a DigitalOcean App and expose a Cloudflare domain for public access.
Example that defines a DigitalOcean App as a consumable module
Example to create a DigitalOcean App using a CDKTF Typescript module
Example using Cloudflare and DigitalOcean to deploy a DigitalOcean App and expose a Cloudflare domain for public access.
Example that defines a DigitalOcean App as a consumable module
Example to create a DigitalOcean App using a CDKTF Python module