summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRafael Chicoli <rafaelchicoli@hotmail.com>2016-01-28 21:10:58 +0100
committerRafael Chicoli <rafaelchicoli@hotmail.com>2016-01-28 23:10:02 +0100
commit2bc9d47add521d78f8ade7ff5de36b77104d0371 (patch)
tree8e43271f80b0751f0cee2482ecb348263962ef01
parent30215b4afecbeb591fc3c66cd5be9fc2f59fc54d (diff)
update README usage section
-rw-r--r--README.markdown26
1 files changed, 23 insertions, 3 deletions
diff --git a/README.markdown b/README.markdown
index f0bb736..7434c2d 100644
--- a/README.markdown
+++ b/README.markdown
@@ -37,13 +37,33 @@ If your module requires anything extra before setting up (pluginsync enabled, et
###Beginning with gitlab_ci_multi_runner
-The very basic steps needed for a user to get the module up and running.
+To use the gitlab_ci_multi_runner with default parameters, declare the ```gitlab_ci_multi_runner``` class.
-If your most recent release breaks compatibility or requires particular steps for upgrading, you may wish to include an additional section here: Upgrading (For an example, see http://forge.puppetlabs.com/puppetlabs/firewall).
+```puppet
+include gitlab_ci_multi_runner
+```
+
+**Note:** The main gitlab_ci_multi_runner class is required by all other classes, types, and defines in this module. You must declare it whenever you use the module.
##Usage
-Put the classes, types, and resources for customizing, configuring, and doing the fancy stuff with your module here.
+### Hiera
+
+```hiera
+gitlab_ci_multi_runner::runners:
+ 'host01-ssh':
+ url: 'https://gitlab.example.com/ci'
+ token: 'abb0d7b09e8491ccc6a0d4264fc319ca'
+ tls_skip_verify: true
+ tls_ca_file: '/usr/local/share/ca-certificates/ca.crt'
+ executor: 'ssh'
+ ssh_params:
+ host: "%{::fqdn}"
+ port: '22'
+ user: 'gitlab-runner'
+ password: 'strongpassword'
+ identity_file: ''
+```
##Reference