Skip to content

Commit

Permalink
Merge pull request #521 from Fedosin/helm_no_cert_manager
Browse files Browse the repository at this point in the history
⚠️ remove cert-manager support from helm chart
  • Loading branch information
k8s-ci-robot committed May 22, 2024
2 parents cc612a3 + 4123e88 commit e644619
Show file tree
Hide file tree
Showing 13 changed files with 28 additions and 107 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,6 @@ release-manifests: $(KUSTOMIZE) $(RELEASE_DIR) ## Builds the manifests to publis
release-chart: $(HELM) $(KUSTOMIZE) $(RELEASE_DIR) $(CHART_DIR) $(CHART_PACKAGE_DIR) ## Builds the chart to publish with a release
cp -rf $(ROOT)/hack/charts/cluster-api-operator/. $(CHART_DIR)
$(KUSTOMIZE) build ./config/chart > $(CHART_DIR)/templates/operator-components.yaml
$(ROOT)/hack/inject-cert-manager-chart-version.sh $(CERT_MANAGER_VERSION)
$(HELM) package $(CHART_DIR) --app-version=$(HELM_CHART_TAG) --version=$(HELM_CHART_TAG) --destination=$(CHART_PACKAGE_DIR)

.PHONY: release-staging
Expand Down
14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,21 @@ The lexicon used in this document is described in more detail [here](https://git

## Installation

### Method 1: Apply Manifests from Release Assets
### Prerequisites

Before installing the Cluster API Operator this way, you must first ensure that cert-manager is installed, as the operator does not manage cert-manager installations. To install cert-manager, run the following command:
Before installing the Cluster API Operator, you must first ensure that cert-manager is installed, as the operator does not manage cert-manager installations. To install cert-manager, run the following command:

```bash
kubectl apply -f https://github.com/jetstack/cert-manager/releases/latest/download/cert-manager.yaml
```

Wait for cert-manager to be ready before proceeding.

After cert-manager is successfully installed, you can install the Cluster API operator directly by applying the latest release assets:
After cert-manager is successfully installed, you can proceed installing the Cluster API operator.

### Method 1: Apply Manifests from Release Assets

You can install the Cluster API operator directly by applying the latest release assets:

```bash
kubectl apply -f https://github.com/kubernetes-sigs/cluster-api-operator/releases/latest/download/operator-components.yaml
Expand All @@ -83,10 +87,6 @@ helm repo update
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system
```

#### Installing cert-manager using Helm chart

CAPI operator Helm chart supports provisioning of cert-manager as a dependency. It is disabled by default, but you can enable it with `--set cert-manager.enabled=true` option to `helm install` command or inside of `cert-manager` section in [values.yaml](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/hack/charts/cluster-api-operator/values.yaml) file. Additionally you can define other [parameters](https://artifacthub.io/packages/helm/cert-manager/cert-manager#configuration) provided by the cert-manager chart.

#### Installing providers using Helm chart

The operator Helm chart supports a "quickstart" option for bootstrapping a management cluster. The user experience is relatively similar to [clusterctl init](https://cluster-api.sigs.k8s.io/clusterctl/commands/init.html?highlight=init#clusterctl-init):
Expand Down
3 changes: 2 additions & 1 deletion docs/book/src/01_user/02_quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ For more detailed information, please refer to the full documentation.

- [Running Kubernetes cluster](https://cluster-api.sigs.k8s.io/user/quick-start#install-andor-configure-a-kubernetes-cluster).
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) for interacting with the management cluster.
- [Cert Manager](https://cert-manager.io/docs/installation/) for managing operator certificates.
- [Helm](https://helm.sh/docs/intro/install/) for installing operator on the cluster (optional).

## Install and configure Cluster API Operator
Expand Down Expand Up @@ -37,7 +38,7 @@ helm repo update
Deploy Cluster API components with docker provider using a single command during operator installation

```bash
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker --set cert-manager.enabled=true --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
```

Docker provider can be replaced by any provider supported by [clusterctl](https://cluster-api.sigs.k8s.io/reference/providers.html#infrastructure).
Expand Down
11 changes: 11 additions & 0 deletions docs/book/src/02_installation/01_prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Prerequisites

Before installing the Cluster API Operator, you must first ensure that cert-manager is installed, as the operator does not manage cert-manager installations. To install cert-manager, run the following command:

```bash
kubectl apply -f https://github.com/jetstack/cert-manager/releases/latest/download/cert-manager.yaml
```

Wait for cert-manager to be ready before proceeding.

After cert-manager is successfully installed, you can proceed installing the Cluster API operator.
15 changes: 0 additions & 15 deletions docs/book/src/02_installation/02_manifest-installation.md

This file was deleted.

7 changes: 7 additions & 0 deletions docs/book/src/02_installation/03_manifest-installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Using Manifests from Release Assets

You can install the Cluster API operator directly by applying the latest release assets:

```bash
kubectl apply -f https://github.com/kubernetes-sigs/cluster-api-operator/releases/latest/download/operator-components.yaml
```
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ helm repo update
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system
```

#### Installing cert-manager using Helm chart

CAPI operator Helm chart supports provisioning of cert-manager as a dependency. It is disabled by default, but you can enable it with `--set cert-manager.enabled=true` option to `helm install` command or inside of `cert-manager` section in [values.yaml](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/hack/charts/cluster-api-operator/values.yaml) file. Additionally you can define other [parameters](https://artifacthub.io/packages/helm/cert-manager/cert-manager#configuration) provided by the cert-manager chart.

#### Installing providers using Helm chart

The operator Helm chart supports a "quickstart" option for bootstrapping a management cluster. The user experience is relatively similar to [clusterctl init](https://cluster-api.sigs.k8s.io/clusterctl/commands/init.html?highlight=init#clusterctl-init):
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/04_developer/02_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/
Ensure the cert-manager webhook service is ready before creating the Cluster API Operator components.

This can be done by following instructions for [manual verification](https://cert-manager.io/docs/installation/verify/#manual-verification)
from the [cert-manager] web site.
from the [cert-manager] website.
Note: make sure to follow instructions for the release of cert-manager you are installing.

[cert-manager]: https://github.com/cert-manager/cert-manager
Expand Down
5 changes: 0 additions & 5 deletions hack/charts/cluster-api-operator/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,3 @@ description: Cluster API Operator
type: application
version: 0.0.0
appVersion: "0.0.0"
dependencies:
- name: cert-manager
version: "0.0.0"
repository: https://charts.jetstack.io
condition: cert-manager.enabled

This file was deleted.

7 changes: 0 additions & 7 deletions hack/charts/cluster-api-operator/values.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
# Cert Manager options
# Full list of supported values is available at https://artifacthub.io/packages/helm/cert-manager/cert-manager
cert-manager:
enabled: false
fullnameOverride: "cert-manager"
namespace: "cert-manager"
installCRDs: true
# ---
# Cluster API provider options
core: ""
Expand Down
58 changes: 0 additions & 58 deletions hack/inject-cert-manager-chart-version.sh

This file was deleted.

0 comments on commit e644619

Please sign in to comment.