Skip to content

Commit 3cb1995

Browse files
committed
Edit for GitLab section, fix formatting for Code Manager.
1 parent 88124c1 commit 3cb1995

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Our [Puppet Community Slack](http://slack.puppet.com) is a great way to interact
2424

2525
This control-repo and the steps below are intended to be used with a new installation of PE 2016.1.z.
2626

27-
**Warning:** When using an existing PE installation any existing code or modules in `/etc/puppetlabs/code` will be copied to a backup directory `/etc/puppetlabs/code_bak_<timestamp>` in order to allow deploying code from code manager.
27+
**Warning:** When using an existing PE installation any existing code or modules in `/etc/puppetlabs/code` will be copied to a backup directory `/etc/puppetlabs/code_bak_<timestamp>` in order to allow deploying code from Code Manager.
2828

2929
# What you get from this control-repo
3030

@@ -42,39 +42,40 @@ When you finish the instructions below, you will have the beginning of a best pr
4242

4343
### GitLab
4444

45-
1. On a new server, install GitLab
45+
1. On a new server, install GitLab.
4646
- https://about.gitlab.com/downloads/
4747

48-
2. After GitLab is installed you may sign into the web UI with the `root` user and password `5iveL!fe`
48+
2. After GitLab is installed, sign into the web UI with the user `root`.
49+
- The first time you visit the UI it will force you to enter a password for the `root` user.
4950

50-
2. In the GitLab UI, create a group called `puppet` ( this is case sensitive )
51+
2. In the GitLab UI, create a group called `puppet`.
5152
- http://doc.gitlab.com/ce/workflow/groups.html
5253

53-
3. In the GitLab UI, make a user for yourself
54+
3. In the GitLab UI, make yourself a user to edit and push code.
5455

55-
4. From your laptop or development machine, make an SSH key to link with your user.
56-
- Note: this is used for your laptop to communicate with your GitLab server to push code
56+
4. From your laptop or development machine, make an SSH key and link it with your GitLab user.
57+
- Note: The SSH key allows your laptop to communicate with the GitLab server and push code.
5758
- https://help.github.com/articles/generating-ssh-keys/
5859
- http://doc.gitlab.com/ce/ssh/README.html
5960

60-
7. In the GitLab UI, add your user to the `puppet` group
61-
- Make sure to give your user at least master permissions so you can complete the below steps
61+
7. In the GitLab UI, add your user to the `puppet` group.
62+
- You must give your user at least master permissions to complete the following steps.
6263
- Read more about permissions:
6364
- https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/permissions/permissions.md
6465

65-
8. In the GitLab UI, create a project called `control-repo` and set its Namespace to the `puppet` group
66+
8. In the GitLab UI, create a project called `control-repo` and set its Namespace to the `puppet` group.
6667

67-
10. On your laptop, clone this PuppetLabs-RampUpProgram control repo
68+
10. On your laptop, clone this PuppetLabs-RampUpProgram control repo.
6869
- `git clone https://github.com/PuppetLabs-RampUpProgram/control-repo.git`
6970
- `cd control-repo`
7071

71-
14. On your laptop, remove the origin remote
72+
14. On your laptop, remove the origin remote.
7273
- `git remote remove origin`
7374

74-
15. On your laptop, add your internal repo as the origin remote
75+
15. On your laptop, add your GitLab repo as the origin remote.
7576
- `git remote add origin <SSH URL of your GitLab repo>`
7677

77-
16. On your laptop, push the production branch of the repo from your machine up to your Git server
78+
16. On your laptop, push the production branch of the repo from your machine up to your Git server.
7879
- `git push origin production`
7980

8081
### Stash
@@ -112,7 +113,7 @@ We will set up a deploy key in the Git server that will allow an SSH key we make
112113
/usr/bin/ssh-keygen -t rsa -b 2048 -C 'code_manager' -f /etc/puppetlabs/puppetserver/ssh/id-control_repo.rsa -q -N ''
113114
cat /etc/puppetlabs/puppetserver/ssh/id-control_repo.rsa.pub
114115
~~~
115-
116+
116117
- References:
117118
- https://help.github.com/articles/generating-ssh-keys/
118119
- http://doc.gitlab.com/ce/ssh/README.html
@@ -161,7 +162,7 @@ We will set up a deploy key in the Git server that will allow an SSH key we make
161162
162163
## Setup a webhook in your Git server
163164
164-
Independent of which Git server you choose you will grab the webhook URL from your master. Then each Git Server will have similar but slightly different ways to add the webhook.
165+
Independent of which Git server you choose you will grab the webhook URL from your master. Then each Git Server will have similar but slightly different ways to add the webhook.
165166
166167
1. On your Puppet master
167168
- `cat /etc/puppetlabs/puppetserver/.puppetlabs/webhook_url.txt`
@@ -181,7 +182,7 @@ Independent of which Git server you choose you will grab the webhook URL from yo
181182
182183
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 deploy the branch you just pushed.
183184
184-
1. On your Puppet Master, `tail -f /var/log/puppetlabs/puppetserver/puppetserver.log`
185+
1. On your Puppet Master, `tail -f /var/log/puppetlabs/puppetserver/puppetserver.log`.
185186
2. On your laptop in a separate terminal window:
186187
- Add a new file
187188
@@ -192,7 +193,7 @@ One of the components setup by this control-repo is that when you "push" code to
192193
git push origin production
193194
~~~
194195
195-
3. Allow the push to complete and then wait a few seconds for everything to sync over
196-
- On your Puppet Master, `ls -l /etc/puppetlabs/code/environments/production`
196+
3. Allow the push to complete and then wait a few seconds for everything to sync over.
197+
- On your Puppet Master, `ls -l /etc/puppetlabs/code/environments/production`.
197198
- Confirm test_file is present
198-
4. In your first terminal window review the `puppetserver.log` to see the type of logging each sync will create
199+
4. In your first terminal window review the `puppetserver.log` to see the type of logging each sync will create.

0 commit comments

Comments
 (0)