From 73e2694dc62c9f809ca086277dabcaa6ca3efb2a Mon Sep 17 00:00:00 2001 From: Sean Malloy Date: Thu, 6 May 2021 22:05:32 -0500 Subject: [PATCH] docs: update bluecat tutorial * Updated with v0.8.0 details * Document getting credentials via environment variables --- README.md | 1 + docs/tutorials/bluecat.md | 20 +++++++++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0d27eb7f0..11d285aeb 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,7 @@ The following tutorials are provided: * [Azure DNS](docs/tutorials/azure.md) * [Azure Private DNS](docs/tutorials/azure-private-dns.md) * [Cloudflare](docs/tutorials/cloudflare.md) +* [BlueCat](docs/tutorials/bluecat.md) * [CoreDNS](docs/tutorials/coredns.md) * [DigitalOcean](docs/tutorials/digitalocean.md) * [Hetzner](docs/tutorials/hetzner.md) diff --git a/docs/tutorials/bluecat.md b/docs/tutorials/bluecat.md index 6a3b5ff20..4046bdc04 100644 --- a/docs/tutorials/bluecat.md +++ b/docs/tutorials/bluecat.md @@ -1,17 +1,20 @@ # Setting up external-dns for BlueCat +The first external-dns release with with BlueCat provider support is v0.8.0. + ## Prerequisites Install the BlueCat Gateway product and deploy the [community gateway workflows](https://github.com/bluecatlabs/gateway-workflows). ## Configuration Options -The options for configuring the Bluecat Provider are available through the json file provided to External-DNS via the flag `--bluecat-config-file`. +The options for configuring the Bluecat Provider are available through the json file provided to External-DNS via the flag `--bluecat-config-file`. The +BlueCat Gateway username and password can be supplied using the configuration file or environment variables `BLUECAT_USERNAME` and `BLUECAT_PASSWORD`. | Key | Required | | ----------------- | ------------------ | | gatewayHost | Yes | -| gatewayUsername | Yes | -| gatewayPassword | Yes | +| gatewayUsername | No | +| gatewayPassword | No | | dnsConfiguration | Yes | | dnsView | Yes | | rootZone | Yes | @@ -34,19 +37,20 @@ EOF kubectl create secret generic bluecatconfig --from-file ~/bluecat.json -n bluecat-example ``` -Setup up deployment/service account: +Setup up namespace, deployment, and service account: ``` +kubectl create namespace bluecat-example +cat << EOF > ~/bluecat.yml +--- apiVersion: v1 kind: ServiceAccount metadata: name: external-dns - namespace: bluecat-example --- apiVersion: apps/v1 kind: Deployment metadata: name: external-dns - namespace: bluecat-example spec: selector: matchLabels: @@ -65,7 +69,7 @@ spec: secretName: bluecatconfig containers: - name: external-dns - image: k8s.gcr.io/external-dns/external-dns:$TAG # no released versions include the bluecat provider yet + image: k8s.gcr.io/external-dns/external-dns:v0.8.0 volumeMounts: - name: bluecatconfig mountPath: "/etc/external-dns/" @@ -76,4 +80,6 @@ spec: - --provider=bluecat - --txt-owner-id=bluecat-example - --bluecat-config-file=/etc/external-dns/bluecat.json +EOF +kubectl apply -f ~/bluecat.yml -n bluecat-example ```