Skip to content

Commit 6501f3a

Browse files
lucywymanscotty-c
authored andcommitted
(maint) Fix some typos in the readme (#72)
1 parent 256a6f1 commit 6501f3a

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
#### Table of Contents
88

99
1. [Description](#description)
10+
1. [Installing the Module](#install)
1011
1. [Setup - The basics of getting started with kubernetes](#setup)
1112
* [Setup requirements](#setup-requirements)
1213
* [Beginning with kubernetes](#beginning-with-kubernetes)
@@ -24,16 +25,27 @@ This module installs and configures [Kubernetes](https://kubernetes.io/). Kubern
2425

2526
It groups containers that make up an application into logical units for easy management and discovery.
2627

28+
## Install
29+
30+
To use this module, add this declaration to your Puppetfile:
31+
```
32+
mod 'puppetlabs-kubernetes', '1.0.3'
33+
```
34+
To manually install this module with puppet module tool:
35+
```
36+
puppet module install puppetlabs-kubernetes --version 1.0.3
37+
```
38+
2739
## Setup
2840

2941
### Setup Requirements
3042

31-
This module includes a configuration tool called `kubetool` to auto generate
32-
all the security parameters, the bootstrap token, and other configurations for
33-
your Kubernetes cluster into a Hiera file. The tool is available as a Docker
43+
This module includes a configuration tool called
44+
[kubetool](tooling/kube_tool.rb) to auto generate all the security
45+
parameters, the bootstrap token, and other configurations for your Kubernetes
46+
cluster into a Hiera file. The tool is available as a Docker
3447
image to simplify installation and use.
3548

36-
3749
#### Generate the module's configuration
3850

3951
If you do not already have Docker installed on your workstation, install it [here](https://www.docker.com/community-edition)
@@ -64,9 +76,9 @@ values are re-generated, including the certificates and tokens.
6476

6577
#### 2. Add the `kubernetes.yaml` file to Hiera
6678

67-
The resuling `kubernetes.yaml` file should be added to your [control repo](https://puppet.com/docs/pe/2017.3/code_management/control_repo.html) where you keep your [Hiera](https://docs.puppet.com/hiera/) data, usually the `data` directory. Each cluster can be given its own configuration by leveraging location facts such as the [pp_datacenter](https://puppet.com/docs/puppet/5.0/ssl_attributes_extensions.html#puppet-specific-registered-ids) [trusted fact](https://puppet.com/docs/puppet/5.0/lang_facts_and_builtin_vars.html#trusted-facts).
79+
The resulting `kubernetes.yaml` file should be added to your [control repo](https://puppet.com/docs/pe/2017.3/code_management/control_repo.html) where you keep your [Hiera](https://docs.puppet.com/hiera/) data, usually the `data` directory. Each cluster can be given its own configuration by leveraging location facts such as the [pp_datacenter](https://puppet.com/docs/puppet/5.0/ssl_attributes_extensions.html#puppet-specific-registered-ids) [trusted fact](https://puppet.com/docs/puppet/5.0/lang_facts_and_builtin_vars.html#trusted-facts).
6880

69-
### Begininning with kubernetes
81+
### Begininning with Kubernetes
7082

7183
After your `kubernetes.yaml` file has been added to the Hiera directory on your Puppet server, configure your node with one of the following parameters:
7284

0 commit comments

Comments
 (0)