diff --git a/content/en/docs/help/building.md b/content/en/docs/help/building.md index 9b0b502..7b89758 100644 --- a/content/en/docs/help/building.md +++ b/content/en/docs/help/building.md @@ -15,24 +15,19 @@ toc: true # Building the operator -## General environment requirements +## Prerequisites -### A kubernetes cluster +### Go -Currently the operator is tested against kubernetes v1.25 and above. -You can install a [Minikube](https://minikube.sigs.k8s.io/docs/) or a [CodeReady Containers(CRC)](https://developers.redhat.com/products/codeready-containers/overview) to deploy the operator. +Download the Go version v1.20.13 from the [download page](https://go.dev/dl/) and install it following the [installation instructions](https://go.dev/doc/install). -### Docker - -Current version being used is v23.0.3. Checkout [this page](https://docs.docker.com/get-docker/) for help on installing docker on your specific operating system. +### Operator SDK -### Go v1.19 +Install [Operator SDK](https://sdk.operatorframework.io/) version [v1.28.0](https://github.com/operator-framework/operator-sdk/releases/tag/v1.28.0) following the [installation instructions from a GitHub release](https://sdk.operatorframework.io/docs/installation/#install-from-github-release). -Install Go version v1.19 following [this guide](https://go.dev/doc/install). - -### operator-sdk v1.28.0 +### Docker -Install [operator-sdk](https://sdk.operatorframework.io/) following [this guide](https://sdk.operatorframework.io/docs/installation/). +Install Docker following the [installation instructions](https://docs.docker.com/get-docker/). ## Get the code @@ -86,4 +81,4 @@ or use the make target **docker-push** make OPERATOR_IMAGE_REPO= OPERATOR_VERSION= docker-push ``` -Now follow the [quickstart]({{< ref "../getting-started/quick-start.md" >}}) to deploy the operator. +Now follow the [quickstart](../getting-started/quick-start.md) to deploy the operator. diff --git a/content/en/docs/help/operator.md b/content/en/docs/help/operator.md index 6afac40..2b6292e 100644 --- a/content/en/docs/help/operator.md +++ b/content/en/docs/help/operator.md @@ -1263,7 +1263,7 @@ Note: this feature currently is experimental. Feedback is welcomed. The operator provides options in the custom resource that utilizes cert-manager x509 certificates to configure SSL/TLS transports for brokers. It also works with [trust-manager](https://github.com/cert-manager/trust-manager) to distribute trust CA bundles. -Before configuring a broker you need to have the certificates and bundles ready. In the following example a self-signed isser is used as a root CA. +Before configuring a broker you need to have the certificates and bundles ready. The bundle target secret key must end with `.pem`. In the following example a self-signed isser is used as a root CA. Step 1 - create the root self-signed issuer @@ -1330,7 +1330,7 @@ spec: kind: ClusterIssuer ``` -Step 5 - create the ca bundle from the root CA using trust-manager +Step 5 - create the ca bundle from the root CA using trust-manager and setting a target secret key that ends with `.pem` ```yaml apiVersion: trust.cert-manager.io/v1alpha1