From 63c15c3cbbcb27e40939025d1858a7d34ec9f637 Mon Sep 17 00:00:00 2001
From: Jake Spain <jake.spain+15749776@perforce.com>
Date: Mon, 27 Feb 2023 12:02:29 -0500
Subject: [PATCH] Update docs

---
 README.md                            | 21 ++++++++++++++++++++-
 sig/vmpooler/dns/google/clouddns.rbs | 10 ----------
 util/vmpooler-dns-gcp-role.yaml      | 14 ++++++++++++++
 3 files changed, 34 insertions(+), 11 deletions(-)
 delete mode 100644 sig/vmpooler/dns/google/clouddns.rbs
 create mode 100644 util/vmpooler-dns-gcp-role.yaml

diff --git a/README.md b/README.md
index 0e29595..8afa87f 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,33 @@
 # vmpooler-dns-gcp
 
 - [vmpooler-dns-gcp](#vmpooler-dns-gcp)
+  - [Requirements](#requirements)
   - [Usage](#usage)
   - [Update the Gemfile Lock](#update-the-gemfile-lock)
   - [Releasing](#releasing)
   - [License](#license)
 
+## Requirements
+
+1. A Google Cloud Project with the [Cloud DNS](https://cloud.google.com/dns/) enabled.
+2. A custom IAM role with the permissions listed in `util/vmpooler-dns-gcp-role.yaml`.
+3. A service account assigned to the custom role above.
+4. A service account key, using the account above, exported as `GOOGLE_APPLICATION_CREDENTIALS` where VMPooler is run.
+
 ## Usage
 
-Examples of deploying VMPooler with extra providers can be found in the [puppetlabs/vmpooler-deployment](https://github.com/puppetlabs/vmpooler-deployment) repository.
+Example dns config setup:
+
+```yaml
+:dns_configs:
+  :example:
+    dns_class: gcp
+    project: vmpooler-example
+    domain: vmpooler.example.com
+    zone_name: vmpooler-example-com
+```
+
+Examples of deploying VMPooler with dns configs can be found in the [puppetlabs/vmpooler-deployment](https://github.com/puppetlabs/vmpooler-deployment) repository.
 
 ## Update the Gemfile Lock
 
diff --git a/sig/vmpooler/dns/google/clouddns.rbs b/sig/vmpooler/dns/google/clouddns.rbs
deleted file mode 100644
index ee79317..0000000
--- a/sig/vmpooler/dns/google/clouddns.rbs
+++ /dev/null
@@ -1,10 +0,0 @@
-module Vmpooler
-  module Dns
-    module Google
-      module Clouddns
-        VERSION: String
-        # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-      end
-    end
-  end
-end
diff --git a/util/vmpooler-dns-gcp-role.yaml b/util/vmpooler-dns-gcp-role.yaml
new file mode 100644
index 0000000..bff6b98
--- /dev/null
+++ b/util/vmpooler-dns-gcp-role.yaml
@@ -0,0 +1,14 @@
+title: VMPooler DNS GCP
+description: VMPooler DNS GCP Plugin
+stage: GA
+includedPermissions:
+- dns.changes.create
+- dns.changes.get
+- dns.changes.list
+- dns.managedZones.get
+- dns.managedZones.list
+- dns.resourceRecordSets.create
+- dns.resourceRecordSets.update
+- dns.resourceRecordSets.delete
+- dns.resourceRecordSets.get
+- dns.resourceRecordSets.list