Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Update v5 docs for gatekeeper, vpa, nginx #1613

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions examples/do-not-use/docs/gatekeeper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Gatekeeper

Gatekeeper is an admission controller that validates requests to create and update Pods on Kubernetes clusters, using the Open Policy Agent (OPA). Using Gatekeeper allows administrators to define policies with a constraint, which is a set of conditions that permit or deny deployment behaviors in Kubernetes.

For complete project documentation, please visit the [Gatekeeper](https://open-policy-agent.github.io/gatekeeper/website/docs/).
For reference templates refer [Templates](https://github.com/open-policy-agent/gatekeeper/tree/master/charts/gatekeeper/templates)

## Usage

Gatekeeper can be deployed by enabling the add-on via the following.

```hcl
enable_gatekeeper = true
```

You can also customize the Helm chart that deploys `gatekeeper` via the following configuration:

```hcl
enable_gatekeeper = true

gatekeeper = {
name = "gatekeeper"
chart_version = "3.12.0"
repository = "https://open-policy-agent.github.io/gatekeeper/charts"
namespace = "gatekeeper-system"
values = [templatefile("${path.module}/values.yaml", {})]
}
```
38 changes: 38 additions & 0 deletions examples/do-not-use/docs/nginx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Nginx

This add-on installs [Nginx Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/) on Amazon EKS. The Nginx ingress controller uses [Nginx](https://www.nginx.org/) as a reverse proxy and load balancer.

Other than handling Kubernetes ingress objects, this ingress controller can facilitate multi-tenancy and segregation of workload ingresses based on host name (host-based routing) and/or URL Path (path based routing).

## Usage

Nginx Ingress Controller can be deployed by enabling the add-on via the following.

```hcl
enable_ingress_nginx = true
```

You can also customize the Helm chart that deploys `ingress-nginx` via the following configuration:

```sh
$ kubectl get pods -n ingress-nginx
NAME READY STATUS RESTARTS AGE
ingress-nginx-controller-f6c55fdc8-8bt2z 1/1 Running 0 44m
```

Note that the ingress controller is deployed in the `ingress-nginx` namespace.

You can optionally customize the Helm chart that deploys `nginx` via the following configuration.

```hcl
enable_ingress_nginx = true

ingress_nginx = {
name = "ingress-nginx"
chart_version = "4.6.1"
repository = "https://kubernetes.github.io/ingress-nginx"
namespace = "ingress-nginx"
values = [templatefile("${path.module}/values.yaml", {})]
}

```
4 changes: 2 additions & 2 deletions examples/do-not-use/docs/velero.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ You can also customize the Helm chart that deploys `velero` via the following co

```hcl
enable_velero = true

velero = {
name = "velero"
description = "A Helm chart for velero"
chart = "velero"
chart_version = "3.1.6"
repository = "https://vmware-tanzu.github.io/helm-charts/"
namespace = "velero"
values = <EXTRA_HELM_VALUES>
values = [templatefile("${path.module}/values.yaml", {})]
}
```

Expand Down
28 changes: 28 additions & 0 deletions examples/do-not-use/docs/vpa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Vertical Pod Autoscaler
[VPA](https://github.com/kubernetes/autoscaler/tree/master/vertical-pod-autoscaler) Vertical Pod Autoscaler (VPA) automatically adjusts the CPU and memory reservations for your pods to help "right size" your applications. When configured, it will automatically request the necessary reservations based on usage and thus allow proper scheduling onto nodes so that the appropriate resource amount is available for each pod. It will also maintain ratios between limits and requests that were specified in initial container configuration.

NOTE: Metrics Server add-on is a dependency for this addon

## Usage

This step deploys the Vertical Pod Autoscaler with default Helm Chart config

```hcl
enable_vpa = true
enable_metrics_server = true
```

You can also customize the Helm chart that deploys `vpa` via the following configuration:

```hcl
enable_vpa = true
enable_metrics_server = true

vpa = {
name = "vpa"
chart_version = "1.7.5"
repository = "https://charts.fairwinds.com/stable"
namespace = "vpa"
values = [templatefile("${path.module}/values.yaml", {})]
}
```
4 changes: 2 additions & 2 deletions examples/do-not-use/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -374,8 +374,8 @@ variable "enable_gatekeeper" {

variable "gatekeeper" {
description = "Gatekeeper add-on configuration"
type = bool
default = false
type = any
default = {}
}

################################################################################
Expand Down