Skip to content

Commit

Permalink
README.md: table of contents cleanup
Browse files Browse the repository at this point in the history
Fix heading levels, add missing sections to the table of contents, fix
table of contents numbering, some whitespace cleanups.
  • Loading branch information
kenyon committed Jun 28, 2020
1 parent c369d91 commit e4ba797
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,20 @@
#### Table of Contents

1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with r10k](#setup)
1. [Module Description - What the module does and why it is useful](#module-description)
1. [Setup - The basics of getting started with r10k](#setup)
* [Prefix Example](#prefix-example)
* [What r10k affects](#what-r10k-affects)
* [Setup requirements](#setup-requirements)
* [Setup Requirements](#setup-requirements)
* [Beginning with r10k](#beginning-with-r10k)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
* [Using an internal gem server](#using-an-internal-gem-server)
* [Mcollective Support](#mcollective-support)
1. [Webhook Support](#webhook-support)
1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
1. [Limitations - OS compatibility, etc.](#limitations)
1. [Support](#support)
1. [Development - Guide for contributing to the module](#development)
1. [Running tests](#running-tests)

## Overview

Expand Down Expand Up @@ -251,7 +256,7 @@ class { '::r10k::mcollective':
}
```

### Install mcollective support for post receive hooks
#### Install mcollective support for post receive hooks
Install the `mco` command from the puppet enterprise installation directory i.e.
```shell
cd ~/puppet-enterprise-3.0.1-el-6-x86_64/packages/el-6-x86_64
Expand Down Expand Up @@ -280,7 +285,7 @@ and copy the certs to somewhere that is readable by the respective user.
~~~
_Note: PE2 only requires the .mcollective file as the default auth was psk_

### Removing the mcollective agent
#### Removing the mcollective agent

```puppet
class { 'r10k::mcollective':
Expand All @@ -289,7 +294,7 @@ class { 'r10k::mcollective':
```
This will remove the mcollective agent/application and ddl files from disk. This likely would be if you are migrating to Code manager in Puppet Enterprise.

# Webhook Support
## Webhook Support

![alt tag](https://gist.githubusercontent.com/acidprime/be25026c11a76bf3e7fb/raw/44df86181c3e5d14242a1b1f4281bf24e9c48509/webhook.gif)
For version control systems that use web driven post-receive processes you can use the example webhook included in this module.
Expand Down Expand Up @@ -398,6 +403,7 @@ git_webhook { 'web_post_receive_webhook_for_module' :
provider => 'github',
}
```

### Webhook Bitbucket Example
This is an example of using the webhook with Atlassian Bitbucket (former Stash).
Requires the `external hooks` addon by https://marketplace.atlassian.com/plugins/com.ngs.stash.externalhooks.external-hooks/server/overview
Expand Down Expand Up @@ -564,8 +570,8 @@ git_webhook { 'web_post_receive_webhook' :
provider => 'gitlab',
}
```

### Webhook FOSS support with MCollective

Currently the webhook relies on existing certificates for its ssl configuration.
Expand Down Expand Up @@ -669,7 +675,6 @@ class { 'r10k::webhook::config':
}
```


### Webhook Default Branch

The default branch of the controlrepo is commonly called `production`. This value can be overridden if you use another default branch name, such as `master`.
Expand Down

0 comments on commit e4ba797

Please sign in to comment.