Skip to content

Commit

Permalink
Update getting started docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mabojars committed Aug 2, 2024
1 parent 843fc31 commit c154348
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/src/topics/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ export LINODE_TOKEN=<your linode PAT>
export LINODE_CONTROL_PLANE_MACHINE_TYPE=g6-standard-2
export LINODE_MACHINE_TYPE=g6-standard-2
```

Optionally, provide an alternative Linode API client configuration for provisioning domain resources.
If not provided, the above-mentioned configuration will be used.
```bash
export LINODE_DNS_URL=custom.api.linode.com
export LINODE_DNS_CA=/path/to/cacert.pem
export LINODE_DNS_TOKEN=<your Linode PAT for the API instance at LINODE_DNS_URL>
```

```admonish info
This project uses [linodego](https://github.com/linode/linodego) for Linode API interaction.
Please refer to it for more details on environment variables used for client configuration.
```

```admonish warning
For Regions and Images that do not yet support Akamai's cloud-init datasource CAPL will automatically use a stackscript shim
to provision the node. If you are using a custom image ensure the [cloud_init](https://www.linode.com/docs/api/images/#image-create) flag is set correctly on it
Expand Down

0 comments on commit c154348

Please # to comment.