2
2
3
3
# Tiller Module
4
4
5
+ <!-- NOTE: We use absolute linking here instead of relative linking, because the terraform registry does not support
6
+ relative linking correctly.
7
+ -->
8
+
5
9
This repo contains a Module for deploying Tiller (the server component of Helm) on Kubernetes clusters with
6
10
[ Terraform] ( https://www.terraform.io ) . This repo is a part of [ the Gruntwork Infrastructure as Code
7
11
Library] ( https://gruntwork.io/infrastructure-as-code-library/ ) , a collection of reusable, battle-tested, production
8
- ready infrastructure code. Read the [ Gruntwork Philosophy] ( GRUNTWORK_PHILOSOPHY.md ) document to learn more about how
9
- Gruntwork builds production grade infrastructure code.
12
+ ready infrastructure code. Read the [ Gruntwork
13
+ Philosophy] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/blob/master/GRUNTWORK_PHILOSOPHY.md ) document to
14
+ learn more about how Gruntwork builds production grade infrastructure code.
10
15
11
16
12
17
## Quickstart Guide
@@ -26,38 +31,44 @@ The general idea is to:
26
31
Tiller instance.
27
32
1 . Deploy Tiller.
28
33
29
- You can checkout the [ ` k8s-tiller-minikube ` example documentation] ( /examples/k8s-tiller-minikube/README.md ) for detailed
30
- instructions on deploying against ` minikube ` .
34
+ You can checkout the [ ` k8s-tiller-minikube ` example
35
+ documentation] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/tree/master/examples/k8s-tiller-minikube ) for
36
+ detailed instructions on deploying against ` minikube ` .
31
37
32
38
33
39
## What is in this repo
34
40
35
41
This repo provides a Gruntwork IaC Package and has the following folder structure:
36
42
37
- * [ root] ( ./ ) : The root folder contains an example of how to deploy Tiller using
38
- [ ` kubergrunt ` ] ( https://github.com/gruntwork-io/kubergrunt ) , which implements all the logic for deploying Tiller with
39
- all the security best practices.
40
- * [ modules] ( / modules) : This folder contains the main implementation code for this Module, broken down into multiple
41
- standalone Submodules.
43
+ * [ root] ( https://github.com/gruntwork-io/terraform-kubernetes-helm ) : The root folder contains an example of how to
44
+ deploy Tiller using [ ` kubergrunt ` ] ( https://github.com/gruntwork-io/kubergrunt ) , which implements all the logic for
45
+ deploying Tiller with all the security best practices.
46
+ * [ modules] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/tree/master/ modules) : This folder contains the
47
+ main implementation code for this Module, broken down into multiple standalone Submodules.
42
48
43
49
The primary module is:
44
50
45
- * [ k8s-tiller] ( /modules/k8s-tiller ) : Deploy Tiller with all the security features turned on. This includes using
46
- ` Secrets ` for storing state and enabling TLS verification.
51
+ * [ k8s-tiller] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/tree/master/modules/k8s-tiller ) : Deploy
52
+ Tiller with all the security features turned on. This includes using ` Secrets ` for storing state and enabling TLS
53
+ verification.
47
54
48
55
The deployed Tiller requires TLS certificate key pairs to operate. Additionally, clients will each need to their
49
56
own TLS certificate key pairs to authenticate to the deployed Tiller instance. This is based on [ kubergrunt model of
50
57
deploying helm] ( https://github.com/gruntwork-io/kubergrunt/blob/master/HELM_GUIDE.md ) .
51
58
52
59
There are also several supporting modules that help with setting up the deployment:
53
60
54
- * [ k8s-namespace] ( /modules/k8s-namespace ) : Provision a Kubernetes ` Namespace ` with a default set of RBAC roles.
55
- * [ k8s-namespace-roles] ( /modules/k8s-namespace-roles ) : Provision a default set of RBAC roles to use in a ` Namespace ` .
56
- * [ k8s-service-account] ( /modules/k8s-service-account ) : Provision a Kubernetes ` ServiceAccount ` .
61
+ * [ k8s-namespace] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/tree/master/modules/k8s-namespace ) :
62
+ Provision a Kubernetes ` Namespace ` with a default set of RBAC roles.
63
+ * [ k8s-namespace-roles] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/tree/master/modules/k8s-namespace-roles ) :
64
+ Provision a default set of RBAC roles to use in a ` Namespace ` .
65
+ * [ k8s-service-account] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/tree/master/modules/k8s-service-account ) :
66
+ Provision a Kubernetes ` ServiceAccount ` .
57
67
58
- * [ examples] ( /examples ) : This folder contains examples of how to use the Submodules. The [ example root
59
- README] ( /examples/README.md ) provides a quickstart guide on how to use the Submodules in this Module.
60
- * [ test] ( /test ) : Automated tests for the Submodules and examples.
68
+ * [ examples] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/tree/master/examples ) : This folder contains
69
+ examples of how to use the Submodules.
70
+ * [ test] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/tree/master/test ) : Automated tests for the Submodules
71
+ and examples.
61
72
62
73
63
74
## What is Kubernetes?
@@ -113,13 +124,14 @@ Gruntwork can help with:
113
124
114
125
## How do I contribute to this Module?
115
126
116
- Contributions are very welcome! Check out the [ Contribution Guidelines] ( /CONTRIBUTING.md ) for instructions.
127
+ Contributions are very welcome! Check out the [ Contribution
128
+ Guidelines] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/blob/master/CONTRIBUTING.md ) for instructions.
117
129
118
130
119
131
## How is this Module versioned?
120
132
121
133
This Module follows the principles of [ Semantic Versioning] ( http://semver.org/ ) . You can find each new release, along
122
- with the changelog, in the [ Releases Page] ( ../.. /releases) .
134
+ with the changelog, in the [ Releases Page] ( https://github.com/gruntwork-io/terraform-kubernetes-helm /releases) .
123
135
124
136
During initial development, the major version will be 0 (e.g., ` 0.x.y ` ), which indicates the code does not yet have a
125
137
stable API. Once we hit ` 1.0.0 ` , we will make every effort to maintain a backwards compatible API and use the MAJOR,
@@ -128,6 +140,7 @@ MINOR, and PATCH versions on each release to indicate any incompatibilities.
128
140
129
141
## License
130
142
131
- Please see [ LICENSE] ( /LICENSE ) for how the code in this repo is licensed.
143
+ Please see [ LICENSE] ( https://github.com/gruntwork-io/terraform-kubernetes-helm/blob/master/LICENSE ) for how the code in
144
+ this repo is licensed.
132
145
133
146
Copyright © ; 2019 Gruntwork, Inc.
0 commit comments