Merge pull request #2053 from KohlsTechnology/bluecat-docs

Bluecat documentation
kubernetes-sigs · Apr 22, 2021 · 5806e34 · 5806e34
2 parents e063fc0 + 099ce03
commit 5806e34
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -11,6 +11,9 @@ provider/aws: provider/aws*
 # Add 'provider/azure' in file which starts with azure
 provider/azure: provider/azure*
 
+# Add 'provider/bluecat' in file which starts with bluecat
+provider/bluecat: provider/bluecat*
+
 # Add 'provider/cloudflare' in file which starts with cloudflare
 provider/cloudflare: provider/cloudflare*
 

diff --git a/docs/tutorials/bluecat.md b/docs/tutorials/bluecat.md
@@ -3,17 +3,32 @@
 ## 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`.
+
+| Key               | Required           |
+| ----------------- | ------------------ |
+| gatewayHost       | Yes                |
+| gatewayUsername   | Yes                |
+| gatewayPassword   | Yes                |
+| dnsConfiguration  | Yes                |
+| dnsView           | Yes                |
+| rootZone          | Yes                |
+| skipTLSVerify     | No (default false) |
+
 ## Deploy
 Setup configuration file as k8s `Secret`.
 ```
 cat << EOF > ~/bluecat.json
 {
   "gatewayHost": "https://bluecatgw.example.com",
   "gatewayUsername": "user",
-  "GatewayPassword": "pass",
+  "gatewayPassword": "pass",
   "dnsConfiguration": "Example",
   "dnsView": "Internal",
-  "rootZone": "example.com"
+  "rootZone": "example.com",
+  "skipTLSVerify": false
 }
 EOF
 kubectl create secret generic bluecatconfig --from-file ~/bluecat.json -n bluecat-example