mirror of
https://github.com/koenrh/dnscontrol-action.git
synced 2025-01-08 16:18:59 +08:00
222 lines
4.8 KiB
Markdown
222 lines
4.8 KiB
Markdown
# DNSControl Action
|
|
|
|
|
|
|
|
Deploy your DNS configuration using [GitHub Actions](https://github.com/actions)
|
|
using [DNSControl](https://github.com/StackExchange/dnscontrol/).
|
|
|
|
## Usage
|
|
|
|
These are the three relevant sub commands to use with this action.
|
|
|
|
### check
|
|
|
|
Run the action with the 'check' argument in order to check and validate the `dnsconfig.js`
|
|
file. This action does not communicate with the DNS providers, hence does not require
|
|
any secrets to be set.
|
|
|
|
```yaml
|
|
name: Check
|
|
|
|
on: pull_request
|
|
|
|
jobs:
|
|
check:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
|
|
- name: DNSControl check
|
|
uses: koenrh/dnscontrol-action@v2.11
|
|
with:
|
|
args: check
|
|
```
|
|
|
|
### preview
|
|
|
|
Run the action with the 'preview' argument to check what changes need to be made.
|
|
It prints out what DNS records are expected to be created, modified or deleted.
|
|
This action requires the secrets for the specified DNS providers.
|
|
|
|
```yaml
|
|
name: Preview
|
|
|
|
on: pull_request
|
|
|
|
jobs:
|
|
preview:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
|
|
- name: DNSControl preview
|
|
uses: koenrh/dnscontrol-action@v2.11
|
|
env:
|
|
CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }}
|
|
CLOUDFLARE_API_USER: ${{ secrets.CLOUDFLARE_API_USER }}
|
|
with:
|
|
args: preview
|
|
```
|
|
|
|
This is the action you probably want to run for each branch so that proposed changes
|
|
could be verified before an authorized person merges these changes into `master`.
|
|
|
|
### push
|
|
|
|
Run the action with the 'push' arugment to publish the changes to the specified
|
|
DNS providers.
|
|
|
|
Running the action with the 'push' argument will publish the changes with the
|
|
specified DNS providers. The example workflow depicted below contains a filtering
|
|
pattern so that it only runs on the `master` branch.
|
|
|
|
```yaml
|
|
name: Push
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
|
|
jobs:
|
|
push:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
|
|
- name: DNSControl push
|
|
uses: koenrh/dnscontrol-action@v2.11
|
|
env:
|
|
CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }}
|
|
CLOUDFLARE_API_USER: ${{ secrets.CLOUDFLARE_API_USER }}
|
|
with:
|
|
args: push
|
|
```
|
|
|
|
## Secrets
|
|
|
|
Depending on the DNS providers that are used, this action requires secrets to be
|
|
set.
|
|
|
|
### Azure DNS
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/azuredns)
|
|
|
|
- `AZURE_SUBSCRIPTION_ID`
|
|
- `AZURE_RESOURCE_GROUP`
|
|
- `AZURE_TENANT_ID`
|
|
- `AZURE_CLIENT_ID`
|
|
- `AZURE_CLIENT_SECRET`
|
|
|
|
### Cloudflare
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/cloudflare)
|
|
|
|
- `CLOUDFLARE_API_USER`
|
|
- `CLOUDFLARE_API_KEY`
|
|
- `CLOUDFLARE_ACCOUNT_ID` (optional)
|
|
- `CLOUDFLARE_ACCOUNT_NAME` (optional)
|
|
|
|
### ClouDNS
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/cloudns)
|
|
|
|
- `CLOUDNS_AUTH_ID`
|
|
- `CLOUDNS_AUTH_PASSWORD`
|
|
|
|
### DigitalOcean
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/digitalocean)
|
|
|
|
- `DIGITALOCEAN_OAUTH_TOKEN`
|
|
|
|
### DNSimple
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/dnsimple)
|
|
|
|
- `DNSIMPLE_ACCOUNT_ACCESS_TOKEN`
|
|
|
|
### Gandi
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/gandi)
|
|
|
|
- `GANDI_API_KEY`
|
|
|
|
### Gandi V5
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/gandi_v5)
|
|
|
|
- `GANDI_V5_API_KEY`
|
|
- `GANDI_V5_SHARING_ID`
|
|
|
|
### Google CLOUD DNS
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/gcloud)
|
|
|
|
- `GOOGLE_CLOUD_PROJECT_ID`
|
|
- `GOOGLE_CLOUD_PRIVATE_KEY_ID`
|
|
- `GOOGLE_CLOUD_PRIVATE_KEY`
|
|
- `GOOGLE_CLOUD_CLIENT_EMAIL`
|
|
- `GOOGLE_CLOUD_CLIENT_ID`
|
|
- `GOOGLE_CLOUD_CLIENT_X509_CERT_URL`
|
|
|
|
### Internet.bs
|
|
|
|
|
|
|
|
### Linode
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/linode)
|
|
|
|
- `LINODE_ACCESS_TOKEN`
|
|
|
|
### Name.com
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/name.com)
|
|
|
|
- `NAME_COM_API_USER`
|
|
- `NAME_COM_API_KEY`
|
|
- `NAME_COM_API_URL` (optional)
|
|
|
|
### Namecheap
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/namecheap)
|
|
|
|
- `NAMECHEAP_API_USER`
|
|
- `NAMECHEAP_API_KEY`
|
|
- `NAMECHEAP_BASE_URL` (optional)
|
|
|
|
### NS1
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/ns1)
|
|
|
|
- `NSONE_API_KEY`
|
|
|
|
### OVH
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/ovh)
|
|
|
|
- `OVH_APP_KEY`
|
|
- `OVH_APP_SECRET_KEY`
|
|
- `OVH_CONSUMER_KEY`
|
|
|
|
### Amazon Route 53
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/route53)
|
|
|
|
- `AWS_ACCESS_KEY_ID`
|
|
- `AWS_SECRET_ACCESS_KEY`
|
|
- `AWS_SESSION_TOKEN` (optional)
|
|
|
|
### SoftLayer
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/softlayer)
|
|
|
|
- `SOFTLAYER_USERNAME`
|
|
- `SOFTLAYER_API_KEY`
|
|
|
|
### Vultr
|
|
|
|
[Documentation](https://stackexchange.github.io/dnscontrol/providers/vultr)
|
|
|
|
- `VULTR_TOKEN`
|