Skip to content

Commit cd17888

Browse files
author
jbondpdx
committed
light editing, mostly for style
1 parent 3f94daf commit cd17888

File tree

1 file changed

+26
-37
lines changed

1 file changed

+26
-37
lines changed

README.md

Lines changed: 26 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,82 +4,71 @@ Table of Contents
44
* [Where Did All The Previous Code Go?](#where-did-all-the-previous-code-go)
55
* [What You Get From This control\-repo](#what-you-get-from-this-control-repo)
66
* [Copy This Repo Into Your Own Git Server](#copy-this-repo-into-your-own-git-server)
7-
* [Gitlab](#gitlab)
7+
* [GitLab](#gitlab)
88
* [Stash](#stash)
99
* [Github](#github)
1010

1111
Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc.go)
1212

1313
# Where Did All The Previous Code Go?
1414

15-
Initially, the control-repo project began as a 'starter' template for anyone
16-
who wanted to get started with R10k. As time passed (and Code Manager was
17-
integrated into Puppet Enterprise), the scope of this project grew to include
18-
opinionated Puppet profiles to setup many Puppet Enterprise components. As the
19-
code increased, so did the complexity of the control-repo project. To reduce
20-
that complexity, as well as continue to meet the needs of individuals who would
21-
like a more minimal template, this repository was stripped of anything other
22-
than the bare minimum files necessary to get started with a functioning
23-
control-repo. All of the code that was previously in this repository still
24-
exists in separate repositories under the [Puppet Labs RampUp Program namespace within Github](https://github.com/PuppetLabs-RampUpProgram)
25-
and can easily be re-connected to an existing control-repo if that is required
26-
(simply add the modules to the Puppetfile). Alternatively, if that
27-
previously-opinoinated control-repo is desired, [it still exists on Github under the Puppet Labs RampUp Program namespace.](https://github.com/PuppetLabs-RampUpProgram/control-repo)
28-
This control-repo project will remain a template for anyone who would like a minimal
29-
'starter' template.
15+
Initially, the control-repo project began as a 'starter' template for anyone who wanted to get started with r10k. As time passed, and Code Manager was integrated into Puppet Enterprise, the scope of this project grew to include opinionated Puppet profiles to set up many Puppet Enterprise components. As the code increased, so did the complexity of the control-repo project. To reduce that complexity, as well as continuing to meet the needs of individuals who would like a more minimal template, this repository was stripped of anything other than the bare minimum files necessary to get started with a functioning
16+
control-repo.
17+
18+
All of the code that was previously in this repository still exists in separate repositories under the [Puppet Labs RampUp Program namespace within Github](https://github.com/PuppetLabs-RampUpProgram) and can be re-connected to an existing control-repo if that is required by adding the modules to the Puppetfile. Alternatively, if that previously-opinoinated control-repo is desired, [it still exists on Github under the Puppet Labs RampUp Program namespace.](https://github.com/PuppetLabs-RampUpProgram/control-repo) This control-repo project will remain a template for anyone who would like a minimal 'starter' template.
3019

3120
# What You Get From This control-repo
3221

33-
This repository exists as a template control-repo that can be used with R10k or Puppet Enterprise Code Manager.
22+
This repository is a template control-repo that can be used with r10k or Puppet Enterprise Code Manager.
3423

3524
The major points are:
3625
- An environment.conf that correctly implements:
37-
- A site directory for roles, profiles, and any custom modules for your organization
38-
- A config_version script
39-
- Provided config_version scripts to output the commit of code that your agent just applied
40-
- Basic example of roles/profiles code
41-
- Example hieradata directory with pre-created common.yaml and nodes directory
42-
- These match the default hierarchy that ships with PE
26+
- A site directory for roles, profiles, and any custom modules for your organization.
27+
- A config_version script.
28+
- Provided config_version scripts to output the commit of code that your agent just applied.
29+
- Basic example of roles/profiles code.
30+
- Example hieradata directory with pre-created common.yaml and nodes directory.
31+
- These match the default hierarchy that ships with PE.
4332

44-
##Copy This Repo Into Your Own Git Server
33+
## Copy This Repo Into Your Own Git Server
4534

46-
###Gitlab
35+
### GitLab
4736

48-
1. Install Gitlab
37+
1. Install GitLab.
4938
- https://about.gitlab.com/downloads/
5039

51-
2. After Gitlab is installed you may sign if with the `root` user and password `5iveL!fe`
40+
2. After GitLab is installed you may sign if with the `root` user and password `5iveL!fe`.
5241

53-
3. Make a user for yourself
42+
3. Make a user for yourself.
5443

55-
4. Make an ssh key to link with your user. You’ll want to do this on the machine you intend to edit code from ( most likely not your puppet master but your local workstation / laptop )
44+
4. Make an SSH key to link with your user. You’ll want to do this on the machine you intend to edit code from (most likely not your Puppet master, but your local workstation or laptop).
5645
- http://doc.gitlab.com/ce/ssh/README.html
5746
- https://help.github.com/articles/generating-ssh-keys/
5847

59-
5. Create a group called `puppet` ( this is case sensitive )
48+
5. Create a group called `puppet` (this is case sensitive).
6049
- http://doc.gitlab.com/ce/workflow/groups.html
6150

62-
6. Add your user to the `puppet` group as well
51+
6. Add your user to the `puppet` group as well.
6352

64-
7. Create a project called `control-repo` and set the Namespace to be the `puppet` group
53+
7. Create a project called `control-repo`, and set the Namespace to be the `puppet` group.
6554

66-
8. Clone this control repository to your laptop/workstation
55+
8. Clone this control repository to your laptop/workstation:
6756
- `git clone <repository url>`
6857
- `cd control-repo`
6958

70-
9. Remove this repository as the origin remote
59+
9. Remove this repository as the origin remote:
7160
- `git remote remove origin`
7261

73-
10. Add your internal repository as the origin remote
62+
10. Add your internal repository as the origin remote:
7463
- `git remote add origin <url of your gitlab repository>`
7564

7665
11. Push the production branch of the repository from your machine up to your git server
7766
- `git push origin production`
7867

79-
###Stash
68+
### Stash
8069

8170
Coming soon!
8271

83-
###Github
72+
### Github
8473

8574
Coming soon!

0 commit comments

Comments
 (0)