Skip to content

Commit

Permalink
Merge pull request voxpupuli#237 from actown/master
Browse files Browse the repository at this point in the history
Update the README with a few puppet-lint things and puppet highlighting.
  • Loading branch information
R. Tyler Croy committed Jan 16, 2015
2 parents 7e47b62 + 8c4357b commit 470b9d6
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@ puppet module install rtyler/jenkins
```

```puppet
node 'hostname.example.com' {
include jenkins
}
```
Then the service should be running at [http://hostname.example.com:8080/](http://hostname.example.com:8080/).
Expand Down Expand Up @@ -60,10 +58,9 @@ site](http://updates.jenkins-ci.org/download/plugins)
#### Latest

By default, the resource will install the latest plugin, i.e.:

jenkins::plugin {
"git" : ;
}
```puppet
jenkins::plugin { 'git': }
```

If you specify `version => 'latest'` in current releases of the module, the
plugin will be downloaded and installed with *every* run of Puppet. This is a
Expand All @@ -72,11 +69,11 @@ that you pin plugin versions when using the `jenkins::plugin` type.

#### By version
If you need to peg a specific version, simply specify that as a string, i.e.:

jenkins::plugin {
"git" :
version => "1.1.11";
}
```puppet
jenkins::plugin { 'git':
version => '1.1.11',
}
```

#### Plugin dependencies
Dependencies are not automatically installed. You need to manually determine the plugin dependencies and include those as well. The Jenkins wiki is a good place to do this. For example: The Git plugin page is at https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin.
Expand Down Expand Up @@ -117,12 +114,12 @@ The dependencies for this module currently are:

If you have any resource in Puppet that *depends* on Jenkins being present, add
the following `require` statement:

exec {
"some-exec" :
require => Class["jenkins::package"],
# ... etc
}
```puppet
exec { 'some-exec':
require => Class['jenkins::package'],
# ... etc
}
```


### Advanced features
Expand Down Expand Up @@ -155,10 +152,11 @@ credentials.

The CLI helper assumes unauthenticated access unless configured otherwise.
You can configure jenkins::cli_helper to use an SSH key on the managed system:

class {'jenkins::cli_helper':
ssh_keyfile => '/path/to/id_rsa',
}
```puppet
class {'jenkins::cli_helper':
ssh_keyfile => '/path/to/id_rsa',
}
```

There's an open bug in Jenkins (JENKINS-22346) that causes authentication to
fail when a key is used but authentication is disabled. Until the bug is fixed,
Expand Down Expand Up @@ -198,11 +196,12 @@ security policy are configured in the correct order. For example:
Email and password are required.

Create a `johndoe` user account whose full name is "Managed by Puppet":

jenkins::user {'johndoe':
email => '[email protected]',
password => 'changeme',
}
```puppet
jenkins::user { 'johndoe':
email => '[email protected]',
password => 'changeme',
}
```

### Credentials

Expand All @@ -212,11 +211,12 @@ absolute path to a key file on the managed system.

Create ssh credentials named 'github-deploy-key', providing an unencrypted
private key:

jenkins::credentials {'github-deploy-key':
```puppet
jenkins::credentials { 'github-deploy-key':
password => '',
private_key_or_path => hiera('::github_deploy_key'),
}
```

### Configuring Security

Expand Down

0 comments on commit 470b9d6

Please sign in to comment.