Skip to content

Commit

Permalink
Clarify documention for cli_ssh_keyfile param.
Browse files Browse the repository at this point in the history
  • Loading branch information
Bob Vincent committed Dec 10, 2015
1 parent eccae5d commit a54e8f7
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,13 +220,18 @@ credentials.
### CLI Helper

The CLI helper assumes unauthenticated access unless configured otherwise.
You can configure jenkins::cli_helper to use an SSH key on the managed system:
You can configure jenkins::cli_helper to use an SSH key on the managed system
by passing the keyfile path as a class parameter:
```puppet
class {'jenkins::cli_helper':
ssh_keyfile => '/path/to/id_rsa',
class {'jenkins':
cli_ssh_keyfile => '/path/to/id_rsa',
}
```

... or via hiera:

jenkins::cli_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,
you may need to bootstrap jenkins out-of-band to ensure that resources and
Expand Down

0 comments on commit a54e8f7

Please sign in to comment.