Overview

Allows you to manage github depoloy_keys. You can specify one or more deploy_keys to a repository. Here is an example:

github_deploy_key { 'authentication/owner/repo:key_name':
  ensure    => 'present',
  key       => 'ssh-rsa XXXXB3NzaC5yc2EXXXXDAQABXXABAQDgrJyY5r+jfg+J5/nagq46UFVSwCLFwMh3UClkNTBxseuMxSa+GTBmeBnTDJySq5QxaCPj6P3oIIOUhjWZcjXo7MxAMXeTiPaMDQH9q8NJGiXhP19UDvEQMllHZG6qJmSNxAWkrFAIDxLO03AQYkYYoZSwF3lqcWQhCNtiRiCq2ivWBoRgotfXa6muo3yVvvsHVQnv9EojyfBdCxBZmRnRY9cAXGBQ2fx9TFba3cURgH9T9q2E6rB6TRI0jVDwvmdL/wLQPrNxUBD8lxd/uk4cE45emMFtQm0Hu4D/zlQLNarsiBhIaFFFOqIW+SJvmYipL6YxDX+huFdDrlfhFmwp',
  read_only => 'false',
}

When you are specifying a different key or change the read_only property, under the hood puppet will delete the key and create a new one.

Attributes

Attribute Name Short Description
credentials The credentials to use for github operations.
deploy_key The name of the deploy_key.
ensure The basic property that the resource should be in.
id For internal use only.
key The contents of the key.
name The full name of the deploy key.
owner the owner of the repository.
provider resource.
read_only If true, the key will only be able to read repository contents.
repository The name of the repository.

credentials

The credentials to use for github operations. This parameter is extracted from the full name. No need to specify it in the body of the puppet type.

This is the first part of the title of all github types

github_repo { 'credentials/....':
  ...
}

The credentials must first be specfied by using github_credentials

Back to overview of github_deploy_key

deploy_key

The name of the deploy_key. This parameter is extracted from the full name. No need to specify it in the body of the puppet type.

Back to overview of github_deploy_key

ensure

The basic property that the resource should be in.

Valid values are present, absent. Back to overview of github_deploy_key

id

For internal use only. Don’t use!

Back to overview of github_deploy_key

key

The contents of the key. Use a public key. Here is an example:

github_deploy_key { 'autorisation/owner/repo_name:key_name':
  ...
  key => 'ssh-rsa ...',
  ...
}

Back to overview of github_deploy_key

name

The full name of the deploy key. The full name consists of the

  • autorisation
  • owner
  • repo name
  • key name

Here is an example:

github_deploy_key { 'autorisation/owner/repo_name:key_name':
  ...
}

Puppet will map these values to the right puppet parameters.

Back to overview of github_deploy_key

owner

the owner of the repository. This parameter is extracted from the full name. No need to specify it in the body of the puppet type.

Back to overview of github_deploy_key

provider

The specific backend to use for this github_deploy_key resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.Available providers are:

simple
Manage github deploy keys

Back to overview of github_deploy_key

read_only

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

github_deploy_key { 'autentication/owner/my_repo:key_name':
  ...
  read_only => 'false',
  ...
}

Valid values are true, false. Back to overview of github_deploy_key

repository

The name of the repository. This parameter is extracted from the full name. No need to specify it in the body of the puppet type.

Back to overview of github_deploy_key