Skip to content

Commit 752f2ef

Browse files
committed
Update README with info on how to upgrade from 2015.2
Mostly reorganized the README to be 2015.3 first and then have some extra info at the bottom about upgrading from 2015.2. Added a blurb about what the control-repo provides.
1 parent ad00dd7 commit 752f2ef

File tree

1 file changed

+52
-50
lines changed

1 file changed

+52
-50
lines changed

README.md

Lines changed: 52 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,44 @@
11
Table of Contents
22
=================
33

4-
* [Before Starting:](#before-starting)
5-
* [Setup a Trusted Fact On Your PE Master](#setup-a-trusted-fact-on-your-pe-master)
6-
* [If You Have Not Installed PE](#if-you-have-not-installed-pe)
7-
* [If You Have Already Installed PE](#if-you-have-already-installed-pe)
8-
* [Copy This Repo Into Your Own Git Server](#copy-this-repo-into-your-own-git-server)
9-
* [Gitlab](#gitlab)
10-
* [Stash](#stash)
11-
* [Github](#github)
12-
* [Configure PE to Use the Control\-Repo](#configure-pe-to-use-the-control-repo)
13-
* [Install PE](#install-pe)
14-
* [Get the Control\-Repo Deployed On Your Master](#get-the-control-repo-deployed-on-your-master)
15-
* [Test Code Manager](#test-code-manager)
16-
* [Test The Zack/r10k Webhook](#test-the-zackr10k-webhook)
17-
* [Miscellaneous](#miscellaneous)
18-
* [If You Want to Install Pointing To This Repo on Github](#if-you-want-to-install-pointing-to-this-repo-on-github)
19-
* [Setting Up Gitlab](#setting-up-gitlab)
20-
* [Setting up Github](#setting-up-github)
21-
* [Setting up Stash](#setting-up-stash)
22-
* [TODO](#todo)
23-
24-
# Before Starting:
4+
* [Before Starting](#before-starting)
5+
* [What You Get From This control\-repo](#what-you-get-from-this-control-repo)
6+
* [How To Set It All Up](#how-to-set-it-all-up)
7+
* [Setup a Trusted Fact On Your PE Master](#setup-a-trusted-fact-on-your-pe-master)
8+
* [If You Have Not Installed PE](#if-you-have-not-installed-pe)
9+
* [If You Have Already Installed PE](#if-you-have-already-installed-pe)
10+
* [Copy This Repo Into Your Own Git Server](#copy-this-repo-into-your-own-git-server)
11+
* [Gitlab](#gitlab)
12+
* [Stash](#stash)
13+
* [Github](#github)
14+
* [Configure PE to Use the Control\-Repo](#configure-pe-to-use-the-control-repo)
15+
* [Install PE](#install-pe)
16+
* [Get the Control\-Repo Deployed On Your Master](#get-the-control-repo-deployed-on-your-master)
17+
* [Test Code Manager](#test-code-manager)
18+
* [Updating From a Previous Version of PE](#updating-from-a-previous-version-of-pe)
19+
* [Upgrading to PE2015\.3\.z from PE 2015\.2\.z](#upgrading-to-pe20153z-from-pe-20152z)
20+
* [Appendix](#appendix)
21+
* [Test The Zack/r10k Webhook](#test-the-zackr10k-webhook)
22+
23+
# Before Starting
2524

2625
This control repo and the steps below are intended to be used during a new installation of PE.
2726

28-
This control repo has only been tested against PE2015.2.z and PE2015.3.z. It is likely close to working on PE3.8.z but has not been tested.
27+
The instructions are geared towards a new installation of PE2015.3.z. However, the control-repo should work just fine on [PE2015.2.z](#upgrading-to-pe20153z-from-pe-20152z)
2928

30-
If you intend to use it on an existing installation then be warned that if you've already written or downloaded modules when you start using r10k it will remove all of the existing modules and replace them with what you define in your Puppetfile. Please copy or move your existing modules to another directory to ensure you do not lose any work you've already started.
29+
If you intend to use this control-repo on an existing installation then be warned that if you've already written or downloaded modules when you start using r10k it will remove all of the existing modules and replace them with what you define in your Puppetfile. Please copy or move your existing modules to another directory to ensure you do not lose any work you've already started.
30+
31+
# What You Get From This control-repo
32+
33+
As a result of following the instructions below you will receive at least the beginning of a best-practices installation of PE including...
34+
35+
- A git server
36+
- The ability to push code to your git server and have it automatically deployed to your PE Master
37+
- A config_version script to output the commit of code that your agent just applied
38+
- Optimal tuning of PE settings for this configuration
39+
- Working and example roles/profiles code
40+
41+
# How To Set It All Up
3142

3243
## Setup a Trusted Fact On Your PE Master
3344

@@ -176,8 +187,26 @@ One of the components setup by this control-repo is that when you "push" code to
176187
- Confirm test_file is present
177188
4. In your first terminal window review the `puppetserver.log` to see the type of logging each sync will create
178189

190+
----
191+
# Updating From a Previous Version of PE
192+
193+
## Upgrading to PE2015.3.z from PE 2015.2.z
194+
195+
Remove `pe_r10k` from the PE master group in the console and instead add the following two parameters to the `puppet_enterprise::profile::master` class under the PE master group.
196+
197+
- `r10k_remote` = the ssh url for your internal repo
198+
- `r10k_private_key` = `/etc/puppetlabs/puppetserver/code_manager.key`
199+
200+
When upgrading the `puppet_enterprise::profile::master` class has the `file_sync_enabled` parameter set to `false`. This parameter should be removed so that code manager can configure file sync.
201+
202+
Finally, you’ll need to `echo 'code_manager_mv_old_code=true' > /opt/puppetlabs/facter/facts.d/code_manager_mv_old_code.txt` so that my puppet code will redeploy all of your code with code manager.
203+
204+
# Appendix
205+
179206
## Test The Zack/r10k Webhook
180207

208+
If you are using PE2015.2.z or if you've forced the use of the zack/r10k webhook then you'll want to test that it works.
209+
181210
One of the components setup by this control-repo is that when you "push" code to your git server, the git server will inform the puppet master to run `r10k deploy environment -p`.
182211

183212
1. Edit README.md
@@ -187,30 +216,3 @@ One of the components setup by this control-repo is that when you "push" code to
187216
4. `git push origin production`
188217
5. Allow the push to complete and then give it few seconds to complete
189218
- Open `/etc/puppetlabs/code/environments/production/README.md` and confirm your change is present
190-
191-
----
192-
#Miscellaneous
193-
194-
## If You Want to Install Pointing To This Repo on Github
195-
196-
### Setting Up Gitlab
197-
198-
1. Install Gitlab on a server by specifying the following trusted fact on the soon-to-be Gitlab server and then [install the PE agent](http://docs.puppetlabs.com/pe/latest/install_agents.html#using-the-puppet-agent-package-installation-script).
199-
200-
```
201-
---
202-
extension_requests:
203-
#pp_role
204-
1.3.6.1.4.1.34380.1.1.13: 'gitlab'
205-
```
206-
207-
### Setting up Github
208-
209-
Not yet completed.
210-
211-
### Setting up Stash
212-
213-
Not yet completed.
214-
215-
#TODO
216-
Flush out generating an answer file and then appending extra answers onto the end of it.

0 commit comments

Comments
 (0)