Puppet docs should accurately explain how to install puppet modules. (#…

…523) Merged PR #523.
GoogleCloudPlatform · Oct 3, 2018 · b35d8fc · b35d8fc
1 parent 8fe53bd
commit b35d8fc
Show file tree

Hide file tree

Showing 15 changed files with 46 additions and 39 deletions.
diff --git a/build/puppet/_bundle b/build/puppet/_bundle
diff --git a/build/puppet/auth b/build/puppet/auth
diff --git a/build/puppet/bigquery b/build/puppet/bigquery
diff --git a/build/puppet/compute b/build/puppet/compute
diff --git a/build/puppet/container b/build/puppet/container
diff --git a/build/puppet/dns b/build/puppet/dns
diff --git a/build/puppet/pubsub b/build/puppet/pubsub
diff --git a/build/puppet/resourcemanager b/build/puppet/resourcemanager
diff --git a/build/puppet/spanner b/build/puppet/spanner
diff --git a/build/puppet/sql b/build/puppet/sql
diff --git a/build/puppet/storage b/build/puppet/storage
diff --git a/build/terraform b/build/terraform
diff --git a/products/_bundle/templates/puppet/README.md.erb b/products/_bundle/templates/puppet/README.md.erb
@@ -49,6 +49,21 @@ Puppet module installer:
 
     puppet module install google/cloud
 
+Since these modules depend on the `googleauth` and `google-api-client` gems,
+you will also need to install those, with
+
+    /opt/puppetlabs/puppet/bin/gem install googleauth google-api-client
+
+If you prefer, you could also add the following to your puppet manifest:
+
+		package { [
+				'googleauth',
+				'google-api-client',
+			]:
+				ensure   => present,
+				provider => puppet_gem,
+		}
+
 ### Upgrading pre-release versions
 
 If you already have pre-release modules installed (pre-release = modules with

diff --git a/products/auth/puppet/README.md b/products/auth/puppet/README.md
@@ -23,11 +23,10 @@ automatically install this module, as it will be listed in their dependencies._
 
 ### Required gem (libraries)
 
-The authentication module depends on a gem released by Google. Puppet does not
-install gems automatically as it is to change the underlying system without
-administrator consent. To install it run:
+The authentication module depends on gems released by Google. Puppet does not
+install gems automatically as part of installing modules. To install, run:
 
-    gem install googleauth google-api-client
+    /opt/puppetlabs/puppet/bin/gem install googleauth google-api-client
 
 As everything related to system configuration, you can install the gem using
 Puppet itself ;-)...
@@ -38,32 +37,10 @@ package { [
     'google-api-client',
   ]:
     ensure   => present,
-    provider => gem,
+    provider => puppet_gem,
 }
 ```
 
-#### Installing gems for Puppet Agent/Master only
-
-In case you wish to use Google gems exclusively on Puppet you can install them
-into the Puppet Ruby sandbox. That will have less requirement burden, as it will
-not require to have `rubygems` and other Ruby packages to be installed on the
-host.
-
-    puppet resource package googleauth ensure=present provider=puppet_gem
-    puppet resource package google-api-client ensure=present provider=puppet_gem
-
-Once executed it will output the confirmation and version installed:
-
-    Notice: /Package[googleauth]/ensure: created
-    package { 'googleauth':
-      ensure => ['0.6.2'],
-    }
-
-    Notice: /Package[google-api-client]/ensure: created
-    package { 'google-api-client':
-      ensure => ['0.19.8'],
-    }
-
 ## Usage
 
 ```puppet

diff --git a/templates/puppet/README.md.erb b/templates/puppet/README.md.erb
@@ -95,6 +95,21 @@ once by installing our "bundle" [`google-cloud`][bundle-forge] module:
 
     puppet module install google-cloud
 
+Since this module depends on the `googleauth` and `google-api-client` gems,
+you will also need to install those, with
+
+    /opt/puppetlabs/puppet/bin/gem install googleauth google-api-client
+
+If you prefer, you could also add the following to your puppet manifest:
+
+		package { [
+				'googleauth',
+				'google-api-client',
+			]:
+				ensure   => present,
+				provider => puppet_gem,
+		}
+
 ## Usage
 
 ### Credentials