Skip to content

Commit

Permalink
fix(docs): removes unnecessary references to cert-manager.
Browse files Browse the repository at this point in the history
Kubewarden controller now manages its own certificates structure.
Therefore, it's not necessary to install cert-manager anymore. This
commit removes the references to the cert-manager in the documentation.

Signed-off-by: José Guilherme Vanz <[email protected]>
  • Loading branch information
jvanz committed Sep 4, 2024
1 parent d15deaf commit 765e6ad
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 61 deletions.
5 changes: 2 additions & 3 deletions docs/howtos/Rancher-Fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@ It does this by defining [Fleet Bundles](https://fleet.rancher.io/concepts).

## Installing

The Kubewarden charts are standard charts,
they have dependencies (such as `cert-manager`),
and depend transitively on each other
The Kubewarden charts are standard charts, they depend transitively on each
other

`kubewarden-crds``kubewarden-controller``kubewarden-defaults`

Expand Down
36 changes: 5 additions & 31 deletions docs/howtos/airgap/02-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,6 @@ Alternatively, the `imagelist.txt` and `policylist.txt` files are shipped inside

:::

1. Add `cert-manager`, if not available, to your private registry.

```console
helm repo add jetstack https://charts.jetstack.io
helm repo update
helm pull jetstack/cert-manager
helm template ./cert-manager-<Version>.tgz | \
awk '$1 ~ /image:/ {print $2}' | sed s/\"//g >> ./kubewarden-images.txt
```

1. Download `kubewarden-save-images.sh` and `kubewarden-load-images.sh` from the
[utilities repository](https://github.com/kubewarden/utils).
1. Save Kubewarden container images into a `.tar.gz` file:
Expand Down Expand Up @@ -84,12 +74,6 @@ helm pull kubewarden/kubewarden-controller
helm pull kubewarden/kubewarden-defaults
```

Download `cert-manager`, if not installed, to the air gap cluster.

```shell
helm pull jetstack/cert-manager
```

## Populate private registry

Move these files to the air gap environment:
Expand Down Expand Up @@ -136,22 +120,12 @@ in the documentation to learn about configuring the `sources.yaml` file

## Install Kubewarden

Now that your private registry has everything required you can install Kubewarden.
The only difference to a standard Kubewarden installation is that you need to change the registry in the container images and policies to be the private registry.

Install `cert-manager`, if not already installed, in the air gap cluster:

```shell
helm install --create-namespace cert-manager ./cert-manager-<Version>.tgz \
-n kubewarden \
--set crds.enabled=true \
--set image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/jetstack/cert-manager-controller \
--set webhook.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/jetstack/cert-manager-webhook \
--set cainjector.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/jetstack/cert-manager-cainjector \
--set startupapicheck.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/jetstack/cert-manager-ctl
```
Now that your private registry has everything required you can install
Kubewarden. The only difference to a standard Kubewarden installation is that
you need to change the registry in the container images and policies to be the
private registry.

Now install the Kubewarden stack:
Install the Kubewarden stack:

```shell
helm install --wait -n kubewarden \
Expand Down
4 changes: 2 additions & 2 deletions docs/howtos/telemetry/20-tracing-qs.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ echo http://`minikube ip`
We can proceed to the deployment of Kubewarden in the usual way.

:::note
cert-manager is a requirement of Kubewarden, and OpenTelemetry is required for this
feature, but we've already installed them in a previous section of this book.
cert-manager is a requirement of OpenTelemetry, but we've already installed
them in a previous section of this book.
:::

As a first step, we have to add the Helm repository that contains Kubewarden:
Expand Down
4 changes: 2 additions & 2 deletions docs/howtos/telemetry/30-metrics-qs.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ EOF
We can now install Kubewarden in the recommended way with Helm charts.

:::note
cert-manager is a requirement of Kubewarden, and OpenTelemetry is required for this
feature, but we've already installed them in a previous section of this book.
cert-manager is a requirement of OpenTelemetry, but we've already installed
them in a previous section of this book.
:::

As a first step, we have to add the Helm repository that contains Kubewarden:
Expand Down
14 changes: 0 additions & 14 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,6 @@ The Kubernetes Custom Resource Definitions (CRDs) defined by Kubewarden are desc

## Installation

:::info Prerequisites
The Helm chart depends on `cert-manager`. Ensure you install [`cert-manager`](https://cert-manager.io/docs/installation/) _before_ the `kubewarden-controller` chart.

You can install the latest version of `cert-manager` through Helm by running the following commands:

```console
helm repo add jetstack https://charts.jetstack.io

helm install --wait --namespace cert-manager --create-namespace \
--set crds.enabled=true cert-manager jetstack/cert-manager
```

:::

:::info Authentication
Kubewarden policies can be retrieved from the GitHub container registry at https://ghcr.io.
You need authentication to use the repository with the Kubewarden CLI, a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) (PAT).
Expand Down
8 changes: 0 additions & 8 deletions docs/reference/dependency-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,6 @@ backwards-incompatible changes still happen. Kubewarden devs do their best to
track Opentelemetry stack changes and adjust to them. Kubewarden is tested against a known working
range of Opentelemetry, metrics and tracing stack.

## Hard dependencies

Needed for Kubewarden deployments.

| Chart dependency | Helm chart `appVersion` | Helm chart `version` | Comments |
| ----------------------------- | :---------------------: | :------------------: | :--------------------: |
| `jetstack/cert-manager` chart | `>= 1.13 < 2` | Example: `v1.13.2` | Plans to make optional |

## Optional dependencies

Needed for specific features.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/threat-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ For example, by:
- using unsigned and malicious images for:
- Kubewarden-controller
- policy-server
- any of the Kubewarden dependencies (cert-manager)
- any of the Kubewarden dependencies
- any optional dependencies (Grafana, Prometheus, and others)
- by compromising the Helm charts payload

Expand Down

0 comments on commit 765e6ad

Please sign in to comment.