Skip to content

Commit 57eb79f

Browse files
authored
Merge pull request #3598 from olehermanse/master
Fixed typos and grammar mistakes
2 parents 9c5e035 + 5f9112d commit 57eb79f

36 files changed

Lines changed: 174 additions & 174 deletions

content/getting-started/01-installation/_index.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ We will use an Ubuntu 20.04 Linux virtual machine as the CFEngine Hub, and we wi
2323
If you've never set up a virtual machine (VM) before, these are some easy ways:
2424

2525
- Cloud: Create a VM in Digital Ocean, AWS, or any other cloud vendor. **(Recommended)**
26-
- Mac OS: Install and run Vagrant and Virtual Box.
26+
- macOS: Install and run Vagrant and VirtualBox.
2727
- Linux: Install and run Vagrant and libvirt.
2828
- Windows: Use Windows Subsystem for Linux (WSL).
2929

30-
We recommend using Digital Ocean because it is very easy to use the GUI, and spawn a virtual without installing something locally.
31-
However, since it requires you to create an account, some users might prefer to install virtualization software and run everything themself.
30+
We recommend using Digital Ocean because it is very easy to use the GUI, and spawn a virtual machine without installing something locally.
31+
However, since it requires you to create an account, some users might prefer to install virtualization software and run everything themselves.
3232
This is also possible, for example using Vagrant and VirtualBox, and we will provide instructions for both.
3333

3434
## Development machine and CFEngine Hub
@@ -152,7 +152,7 @@ For example, in Digital Ocean, the username is `root`, and the IP might be `128.
152152

153153
**Note:** In the rest of this tutorial, replace the IP address we use in the examples, `192.168.56.2` with that IP.
154154

155-
**Using Vagrant and Virtualbox:**
155+
**Using Vagrant and VirtualBox:**
156156

157157
Come back to this tutorial after you have completed the installation and setup of a VM as explained in this tutorial:
158158

@@ -198,7 +198,7 @@ Policy server : None
198198
Binaries : dpkg, apt
199199
```
200200

201-
The output shows you the information needed for SSH (username and hostname / IP) as well as some key information about the host, such as architecture and operating system:
201+
The output shows you the information needed for SSH (username and hostname / IP) as well as some key information about the host, such as architecture and operating system.
202202

203203
## Install CFEngine
204204

@@ -217,7 +217,7 @@ Open the CFEngine web UI in a web browser by clicking this link, or typing the a
217217
https://192.168.56.2/
218218

219219
You might get warnings about an insecure connection or invalid certificate.
220-
At this point, your hub has a self signed certificate, which means there is no certificate authority that can verify which server you are talking to.
220+
At this point, your hub has a self-signed certificate, which means there is no certificate authority that can verify which server you are talking to.
221221
In the future you might want to set up a DNS entry for your hub and give it a proper certificate, but for now, you can click the options in your browser to Ignore / Continue.
222222
(In Chrome, there might not be an "Accept and continue button", but you can type `thisisunsafe` to bypass the security warning).
223223

content/getting-started/01-installation/general-installation/_index.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Check the [Pre-installation checklist][Pre-installation checklist] and [Supporte
1717
CFEngine Enterprise is provided in two packages; one is for the Policy
1818
Server (hub) and the other is for each Host (client).
1919

20-
Note: See [Installing Community][Installing Community] for the community version of CFEngine)
20+
Note: See [Installing Community][Installing Community] for the community version of CFEngine.
2121

2222
**Log in as root** and then follow these steps to install CFEngine Enterprise:
2323

@@ -35,7 +35,7 @@ Note: See [Installing Community][Installing Community] for the community version
3535
[Debian/Ubuntu] # apt -y install /path/to/<agent package>.deb
3636
```
3737

38-
Note: Install actions logged to `/var/logs/cfengine-install.log`.
38+
Note: Install actions are logged to `/var/logs/cfengine-install.log`.
3939

4040
## Bootstrap
4141

@@ -58,7 +58,7 @@ ifconfig
5858
sudo /var/cfengine/bin/cf-agent --bootstrap <IP address of policy server>
5959
```
6060

61-
The bootstrap command must then be run on any client attaching itself to this server, using the ip address of the policy server (i.e. exactly the same as the command run on the policy server itself).
61+
The bootstrap command must then be run on any client attaching itself to this server, using the IP address of the policy server (i.e. exactly the same as the command run on the policy server itself).
6262

6363
## Post-installation configuration
6464

@@ -68,10 +68,10 @@ CFEngine itself is configured through policy as well (see [Components][] and
6868

6969
### Configure agent email settings
7070

71-
By default an email a summary of any `cf-agent` run initiated by `cf-execd`. You
71+
By default, `cf-execd` emails a summary of any `cf-agent` run. You
7272
may want to adjust the mailto or mailfrom. If you have a centralized reporting
73-
system like CFEngine Enterprise you may wish to disable agent emails all
74-
together.
73+
system like CFEngine Enterprise you may wish to disable agent emails
74+
altogether.
7575

7676
#### Configure mailto and mailfrom
7777

@@ -94,7 +94,7 @@ needing to make any additional changes elsewhere. However, any emails sent from
9494
the system might also end up flagged as spam and sent directly to a user's junk
9595
mailbox.
9696

97-
**Note:** It's best practice to restart daemons after adjusting it's settings to
97+
**Note:** It's best practice to restart daemons after adjusting its settings to
9898
ensure they have taken effect.
9999

100100
#### Disable agent emails
@@ -110,7 +110,7 @@ The preferred way to disable the agent from sending emails is to define
110110

111111
Alternatively you can define the class from `def.cf`.
112112

113-
**Note:** It's best practice to restart daemons after adjusting it's settings to
113+
**Note:** It's best practice to restart daemons after adjusting its settings to
114114
ensure they have taken effect.
115115

116116
### Server IP address and hostname

content/getting-started/01-installation/general-installation/installation-community-containerized.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ docker exec cfengine-hub bash -c "/usr/local/sbin/cf-agent --bootstrap \$(ip -4
7272

7373
## Preparing CFEngine host in container
7474

75-
The procedure to setup **cfengine-host** is similar to the **cfengine-hub** deployment. The changes are to name of the host container for better identification and bootstrap IP of the **cfengine-hub**.
75+
The procedure to setup **cfengine-host** is similar to the **cfengine-hub** deployment. The changes are to the name of the host container for better identification and bootstrap IP of the **cfengine-hub**.
7676

7777
```command
7878
docker run --privileged -dit --name=cfengine-host registry.access.redhat.com/ubi9-init /usr/sbin/init
@@ -108,7 +108,7 @@ docker exec cfengine-host bash -c "/usr/local/sbin/cf-agent --bootstrap ${CFENGI
108108

109109
### Preparing container image for CFEngine
110110

111-
Create a `Dockerfile` with following contents:
111+
Create a `Dockerfile` with the following contents:
112112

113113
```Dockerfile
114114
FROM registry.access.redhat.com/ubi9-init:latest
@@ -162,7 +162,7 @@ cfengine lts <IMAGE_ID> About an hour ago 302MB
162162

163163
### Using docker compose service
164164

165-
Create a `compose.yaml` file with following contents:
165+
Create a `compose.yaml` file with the following contents:
166166

167167
```yaml {file="compose.yaml"}
168168
name: cfengine-demo
@@ -211,7 +211,7 @@ Validate the `compose.yaml` file
211211
docker compose -f compose.yaml config 1>/dev/null
212212
```
213213

214-
**Note**: No output means valid yaml file.
214+
**Note**: No output means a valid YAML file.
215215

216216
Start service cfengine-demo
217217

content/getting-started/01-installation/general-installation/installation-community.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ sudo /var/cfengine/bin/cf-agent --bootstrap 192.168.1.12
115115

116116
Upon successful completion, a confirmation message appears: "Bootstrap to '192.168.1.12' completed successfully!"
117117

118-
Type the following to check which version of CFEngine your are running:
118+
Type the following to check which version of CFEngine you are running:
119119

120120
```command
121121
/var/cfengine/bin/cf-promises --version

content/getting-started/01-installation/general-installation/installation-enterprise-free-aws-rhel.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This tutorial will cover the following steps:
2424

2525
### Configure 2 RHEL virtual machine instances in AWS
2626

27-
- Login to AWS.
27+
- Log in to AWS.
2828
- Under `Create Instance` click on `Launch Instance`.
2929
- On the line `Red Hat Enterprise Linux 64 Bit Free tier eligible` press the `Select` button.
3030
- On the `Choose Instance Type` screen ensure the `Micro Instances` tab on the left is selected.
@@ -51,7 +51,7 @@ This tutorial will cover the following steps:
5151

5252
### Configure the security group
5353

54-
- On the left hand side of the AWS console click `NETWORK & SECURITY > Security Groups`
54+
- On the left-hand side of the AWS console click `NETWORK & SECURITY > Security Groups`
5555
- Remembering the `Security group` name from earlier, click on the appropriate line item in the list.
5656
- Below the list of security group names will display details for the current security group.
5757
- Click the `Inbound` tab.
@@ -117,7 +117,7 @@ Note: Turning off the firewall in a production environment is considered unsafe.
117117

118118
## CFEngine installation overview
119119

120-
We ready now ready to install the CFEngine software on both the server and client virtual machines. These also referred to as the "hub" and "host" machines, respectively. During the course of the instructions outlined in this guide, you will perform the following tasks:
120+
We are now ready to install the CFEngine software on both the server and client virtual machines. These are also referred to as the "hub" and "host" machines, respectively. During the course of the instructions outlined in this guide, you will perform the following tasks:
121121

122122
- Install CFEngine Enterprise onto a Policy Server and onto Hosts. A Policy Server (hub) is a CFEngine instance that contains promises (business policy) that get deployed to Hosts. Hosts are clients that retrieve and execute promises.
123123
- Bootstrap the policy server to itself and then bootstrap each of the Hosts to the Policy Server. Bootstrapping establishes a trust relationship between the Policy Server and all Hosts. Thus, business policy that you create in the Policy Server can be deployed to Hosts throughout your company. Bootstrapping completes the installation process.
@@ -147,7 +147,7 @@ This script installs the latest CFEngine Enterprise Policy Server on your server
147147

148148
Upon successful completion, a confirmation message appears: "Bootstrap to '172.31.3.25' completed successfully!"
149149

150-
- Type the following to check which version of CFEngine your are running:
150+
- Type the following to check which version of CFEngine you are running:
151151

152152
`/var/cfengine/bin/cf-promises --version`
153153

@@ -166,7 +166,7 @@ Note: The installation will work on 64-bit and 32-bit client machines (the host
166166

167167
![Bootstrap the policy server](Installing-CFE-on-AWS-11.png)
168168

169-
The client software (host), has been installed on the second virtual machine.
169+
The client software (host) has been installed on the second virtual machine.
170170

171171
Note: You can install CFEngine Enterprise on up to 25 hosts using the script above.
172172

@@ -184,7 +184,7 @@ Note: You can install CFEngine Enterprise on up to 25 hosts using the script abo
184184
- The Mission Portal is immediately accessible. Connect to the Policy Server through your web browser at: http://<External IP address of your Policy Server> (Note: The External IP address is available in the AWS console).
185185
- The default username for the Mission Portal is `admin`, and the password is also `admin`.
186186
- The Mission Portal runs TCP port 80 by default. [Configure mission portal to use HTTPS instead of HTTP](https://cfengine.zendesk.com/entries/25005193-Configure-Mission-Portal-to-use-HTTPS-instead-of-HTTP).
187-
- During the initial setup, the Host(s) might take a few minutes to show up in the Mission Portal. Refresh the web page and login again if necessary.
187+
- During the initial setup, the Host(s) might take a few minutes to show up in the Mission Portal. Refresh the web page and log in again if necessary.
188188

189189
## What next?
190190

content/getting-started/01-installation/general-installation/installation-enterprise-free.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ version of CFEngine Enterprise, but the number of Hosts (clients) is limited to
1616
- You need a minimum of 2 GB of available memory and a modern 64 bit processor.
1717
- Plan for approximately 100MB of disk space per host. You should provide an
1818
extra 2G to 4G of disk space if you plan to bootstrap more hosts later.
19-
- You need a least two VMs/servers, one for the Policy Server and one for a Host (client). They must be on the same network.
19+
- You need at least two VMs/servers, one for the Policy Server and one for a Host (client). They must be on the same network.
2020
- The Policy Server needs to run on a dedicated OS with a vanilla installation (i.e. it only has repositories and packages officially
2121
supported by the OS vendor)
2222

@@ -31,7 +31,7 @@ During the course of the instructions outlined in this guide, you will perform t
3131
and all Hosts. Thus, business policy that you create in the Policy Server can be deployed to Hosts throughout your company.
3232
Bootstrapping completes the installation process.
3333
- **Log in to the Mission Portal.** The Mission Portal is a graphical user interface that allows you to verify the
34-
the actual state of all your Hosts, thus ensuring that your promises are being executed.
34+
actual state of all your Hosts, thus ensuring that your promises are being executed.
3535
- **Try out the Tutorials.** Links to three tutorials give you a head start on learning CFEngine.
3636

3737
## 1. Download and install Enterprise on a policy server
@@ -60,7 +60,7 @@ sudo /var/cfengine/bin/cf-agent --bootstrap <IP address of policy server>
6060

6161
Upon successful completion, a confirmation message appears: "Bootstrap to '192.168.1.12' completed successfully!"
6262

63-
Type the following to check which version of CFEngine your are running:
63+
Type the following to check which version of CFEngine you are running:
6464

6565
```command
6666
/var/cfengine/bin/cf-promises --version
@@ -105,7 +105,7 @@ password: admin
105105

106106
The Mission Portal runs TCP port 80 by default. (Click [here] (https://cfengine.zendesk.com/entries/25005193-Configure-Mission-Portal-to-use-HTTPS-instead-of-HTTP)
107107
to configure the Mission Portal to use HTTPS instead of HTTP.) During the initial setup, the Host(s) might take a few minutes to show up in the Mission Portal. Simply refresh the web page
108-
and login again if necessary.
108+
and log in again if necessary.
109109

110110
Note: If you are running Enterprise with Vagrant, you must add the
111111
correct port: http://localhost:<port> in your browser. The <port> is the port-forwarder

content/getting-started/01-installation/general-installation/installation-enterprise-vagrant.markdown

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ explore CFEngine Enterprise. This guide describes how to set up a client-server
1111
model with CFEngine and, through policy, manage both machines. Vagrant will
1212
create one VirtualBox VM to be the Policy Server (server), and another machine
1313
that will be the Host Agent (client), or host that can be managed by CFEngine.
14-
Both running 64-bit Debian and communicate on a host-only network.
14+
Both run 64-bit Debian and communicate on a host-only network.
1515
Apart from a one-time download of Vagrant and VirtualBox, this setup requires
1616
just one command and takes between 5 and 15 minutes to complete (determined by
1717
your Internet connection and disk speed). Upon completion, you are ready to
@@ -46,7 +46,7 @@ different approach][General installation#More detailed installation guides].
4646
This tutorial uses Vagrant to configure your VMs. It is available for Linux,
4747
Windows and MacOS and can be downloaded from vagrantup.com. After
4848
downloading Vagrant, install it on your computer. You may want to reference the
49-
Windows Mac or Linux vagrant install guides.
49+
Windows, Mac, or Linux Vagrant install guides.
5050

5151
## Install Virtualbox
5252

@@ -75,7 +75,7 @@ vagrant up
7575
Vagrant performs the following processes:
7676

7777
- Downloads the basebox for both the hub and the client (if it has
78-
not already been cached by vagrant.
78+
not already been cached by vagrant).
7979
- Provisions, installs and bootstraps the hub
8080
- Provisions, installs and bootstraps clients
8181

@@ -125,15 +125,15 @@ Last login: Fri Jun 13 18:58:10 2014 from 10.0.2.2
125125

126126
#### Accessing via GUI
127127

128-
If you launch the virtualbox GUI you should find the vagrant vms named
128+
If you launch the VirtualBox GUI, you should find the vagrant vms named
129129
`CFEngine Enterprise {{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}} hub`, and `CFEngine Enterprise {{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}} agent host001`. Additionally, you can uncomment the `v.gui=true`
130130
option in the `Vagrantfile` to have the console gui start with the vms.
131131
**Note:** There are two `v.gui` settings to uncomment; one for the hub, and one
132132
for the clients.
133133

134134
### Check the status of the vms
135135

136-
Running `vagrant status` from the vagrant project directroy will produce
136+
Running `vagrant status` from the vagrant project directory will produce
137137
output like this.
138138

139139
```command
@@ -175,7 +175,7 @@ vagrant suspend
175175
```
176176

177177
To suspend the vms run `vagrant suspend`. This will freeze the state of each vm
178-
and allows for latter resuming of the environment.
178+
and allows for later resuming of the environment.
179179

180180
```command
181181
vagrant halt
@@ -210,7 +210,7 @@ vagrant destroy
210210

211211
## Uninstall Vagrant environment
212212

213-
When you have completed your evaluation are ready to use CFEngine on
213+
When you have completed your evaluation and are ready to use CFEngine on
214214
production servers, remove the VMs that you created above by following these
215215
simple instructions:
216216

0 commit comments

Comments
 (0)