-
Notifications
You must be signed in to change notification settings - Fork 171
SSCSI-235, CM-821, ESO-277: Add quickstart guides for secrets management operators #1073
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
Merged
openshift-merge-bot
merged 1 commit into
openshift:main
from
chiragkyal:oape-quickstart
Dec 17, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| apiVersion: console.openshift.io/v1 | ||
| kind: ConsoleQuickStart | ||
| metadata: | ||
| name: install-cert-manager | ||
| annotations: | ||
| include.release.openshift.io/ibm-cloud-managed: "true" | ||
| include.release.openshift.io/self-managed-high-availability: "true" | ||
| include.release.openshift.io/single-node-developer: "true" | ||
| capability.openshift.io/name: Console | ||
| spec: | ||
| accessReviewResources: | ||
| - group: operators.coreos.com | ||
| resource: operatorgroups | ||
| verb: list | ||
| - group: packages.operators.coreos.com | ||
| resource: packagemanifests | ||
| verb: list | ||
| displayName: Install the cert-manager Operator for Red Hat OpenShift | ||
| durationMinutes: 5 | ||
| description: >- | ||
| Install the cert-manager Operator for Red Hat OpenShift to manage TLS | ||
| certificates from an external PKI. | ||
| tags: | ||
| - security | ||
| - certificates | ||
| - tls | ||
| introduction: |- | ||
| ### In this quick start, you'll install the cert-manager Operator for Red Hat OpenShift to manage TLS certificates in your cluster. | ||
|
|
||
| The cert-manager Operator enables you to create and sign TLS certificates from an external PKI for your workloads | ||
| running on an OpenShift cluster. It provides Kubernetes-native certificate management capabilities that | ||
| integrate seamlessly with your cluster's security infrastructure. | ||
|
|
||
| ### What is cert-manager? | ||
|
|
||
| cert-manager adds certificates and certificate issuers as resource types in OpenShift clusters and simplifies | ||
| the process of obtaining, renewing and using those certificates. | ||
|
|
||
| ### Usage | ||
|
|
||
| You can use an **Issuer** or **ClusterIssuer** to define what will be issuing the certificates, and a **Certificate** | ||
| resource to define what the contents of the certificate should contain. cert-manager supports various certificate | ||
| authorities including Let's Encrypt, HashiCorp Vault, Venafi, self-signed certificates etc. | ||
| tasks: | ||
| - title: Install the cert-manager Operator for Red Hat OpenShift | ||
| description: |- | ||
| ### To install the cert-manager Operator: | ||
|
|
||
| 1. Go to the **Software Catalog** from the [Ecosystem]{{highlight qs-nav-ecosystem}} section of the navigation. | ||
|
|
||
| 2. In the **Filter by keyword** field, type `cert-manager`. | ||
|
|
||
| 3. Look for **cert-manager Operator for Red Hat OpenShift**. If the tile has an **Installed** label on it, the Operator is already installed. You can close this quick start. | ||
|
|
||
| 4. Click the tile to open the side panel. | ||
|
|
||
| 5. At the top of the side panel, click **Install**. | ||
|
|
||
| 6. On the Install Operator page, ensure the **Update Channel** is set to the latest stable version. | ||
|
|
||
| 7. Click **Install** to begin the installation process. | ||
|
|
||
| 8. Wait for the cert-manager Operator's status to change from **Installing operator** to **Operator installed - Ready for use**. | ||
| review: | ||
| instructions: |- | ||
| #### Verify the cert-manager Operator was successfully installed: | ||
|
|
||
| 1. Navigate to **Ecosystem** → **Installed Operators** from the [Ecosystem]{{highlight qs-nav-ecosystem}} section. | ||
|
|
||
| 2. Look for **cert-manager Operator for Red Hat OpenShift** in the list. | ||
|
|
||
| 3. In the Status column, is the cert-manager Operator's status **Succeeded**? | ||
|
|
||
| To verify the pods are running: | ||
|
|
||
| 1. Navigate to **Workloads** → **Pods** from the [Workloads]{{highlight qs-nav-workloads}} section. | ||
|
|
||
| 2. In the **Project** dropdown menu at the top, select **cert-manager**. | ||
|
|
||
| 3. Verify that the following pods are in **Running** status: | ||
| - cert-manager | ||
| - cert-manager-cainjector | ||
| - cert-manager-webhook | ||
| failedTaskHelp: >- | ||
| This task isn't verified yet. Try the task again, or [read | ||
| more](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift) | ||
| about installing the cert-manager Operator. | ||
| summary: | ||
| success: >- | ||
| You just installed the cert-manager Operator for Red Hat OpenShift! | ||
| You can now create Issuers and Certificates to manage TLS certificates | ||
| for your workloads. | ||
| failed: >- | ||
| This task is incomplete. Try the task again, or read more about this | ||
| topic. | ||
| conclusion: >- | ||
| Your cert-manager Operator is ready! You can now create certificate issuers | ||
| and certificates to secure your applications. To learn more about using | ||
| cert-manager, refer to the [OpenShift documentation](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift). | ||
| nextQuickStart: [] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| apiVersion: console.openshift.io/v1 | ||
| kind: ConsoleQuickStart | ||
| metadata: | ||
| name: install-external-secrets-operator | ||
| annotations: | ||
| include.release.openshift.io/ibm-cloud-managed: "true" | ||
| include.release.openshift.io/self-managed-high-availability: "true" | ||
| include.release.openshift.io/single-node-developer: "true" | ||
| capability.openshift.io/name: Console | ||
| spec: | ||
| accessReviewResources: | ||
| - group: operators.coreos.com | ||
| resource: operatorgroups | ||
| verb: list | ||
| - group: packages.operators.coreos.com | ||
| resource: packagemanifests | ||
| verb: list | ||
| displayName: Install the External Secrets Operator for Red Hat OpenShift | ||
| durationMinutes: 10 | ||
| description: >- | ||
| Install the External Secrets Operator for Red Hat OpenShift to synchronize secrets from external | ||
| secret management systems into OpenShift. | ||
| tags: | ||
| - security | ||
| - secrets | ||
| - vault | ||
| - integration | ||
| introduction: |- | ||
| ### In this quick start, you'll install the External Secrets Operator for Red Hat OpenShift to manage secrets from external sources. | ||
|
|
||
| The External Secrets Operator for Red Hat OpenShift is a OpenShift operator that integrates external secret management systems like | ||
| HashiCorp Vault, AWS Secrets Manager, Azure Key Vault, Google Secret Manager and more. | ||
| It reads information from external APIs and automatically injects the values into a Kubernetes Secret. | ||
|
|
||
|
|
||
| ### Usage | ||
|
|
||
| You can use a **SecretStore** or **ClusterSecretStore** to define how to connect to your external secrets manager, | ||
| and use an **ExternalSecret** resource to define which secrets to pull and where to place them in your OpenShift cluster. | ||
| tasks: | ||
| - title: Install the External Secrets Operator for Red Hat OpenShift | ||
| description: |- | ||
| ### To install the External Secrets Operator: | ||
|
|
||
| 1. Go to the **Software Catalog** from the [Ecosystem]{{highlight qs-nav-ecosystem}} section of the navigation. | ||
|
|
||
| 2. In the **Filter by keyword** field, type `External Secrets`. | ||
|
|
||
| 3. Look for **External Secrets Operator for Red Hat OpenShift**. If the tile has an **Installed** label on it, the Operator is already installed. Proceed to task two. | ||
|
|
||
| 4. Click the tile to open the side panel. | ||
|
|
||
| 5. At the top of the side panel, click **Install**. | ||
|
|
||
| 6. On the Install Operator page, ensure the **Update Channel** is set to the latest stable version. | ||
|
|
||
| 7. Select the installation mode and namespace. The default **All namespaces on the cluster** is recommended. | ||
|
|
||
| 8. Click **Install** to begin the installation process. | ||
|
|
||
| 9. Wait for the External Secrets Operator for Red Hat OpenShift's status to change from **Installing operator** to **Operator installed - Ready for use**. | ||
| review: | ||
| instructions: |- | ||
| #### Verify the External Secrets Operator was successfully installed: | ||
|
|
||
| 1. Navigate to **Ecosystem** → **Installed Operators** from the [Ecosystem]{{highlight qs-nav-ecosystem}} section. | ||
|
|
||
| 2. Look for **External Secrets Operator for Red Hat OpenShift** in the list. | ||
|
|
||
| 3. In the Status column, is the External Secrets Operator for Red Hat OpenShift's status **Succeeded**? | ||
| failedTaskHelp: >- | ||
| This task isn't verified yet. Try the task again, or [read | ||
| more](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/security_and_compliance/external-secrets-operator-for-red-hat-openshift) | ||
| about installing the External Secrets Operator. | ||
| summary: | ||
| success: >- | ||
| You just installed the External Secrets Operator for Red Hat OpenShift! Next, we'll deploy | ||
| the ExternalSecretsConfig to activate the operator components. | ||
| failed: >- | ||
| This task is incomplete. Try the task again, or read more about this | ||
| topic. | ||
| - title: Deploy the ExternalSecretsConfig custom resource | ||
| description: |- | ||
| ### What is ExternalSecretsConfig? | ||
|
|
||
| Installing the External Secrets Operator for Red Hat OpenShift provides you with the necessary APIs to deploy the ExternalSecrets operand. | ||
| When an ExternalSecretsConfig CR is deployed, a new Deployment is created that manages the external-secrets singleton and | ||
| keeps it in the desired state. | ||
|
|
||
| ### To deploy the ExternalSecretsConfig custom resource: | ||
|
|
||
| 1. Navigate to **Ecosystem** → **Installed Operators** from the [Ecosystem]{{highlight qs-nav-ecosystem}} section. | ||
|
|
||
| 2. Click on **External Secrets Operator for Red Hat OpenShift** from the list. | ||
|
|
||
| 3. Find the **ExternalSecretsConfig** custom resource in the **Provided APIs** list or in the top side-scrolling menu bar. | ||
| - From the list of **Provided APIs** click the **Create instance** link | ||
| - From the **top side-scrolling menu bar** click **ExternalSecretsConfig** and then click **Create ExternalSecretsConfig** | ||
|
|
||
| 4. For this quick start, you can use the default configurations for the ExternalSecretsConfig deployment, including an allow-all egress policy. | ||
| - **Note**: An allow-all egress policy is not recommended in production environments. | ||
|
|
||
| 5. Copy the below manifest into the console editor for the ExternalSecretsConfig deployment: | ||
|
|
||
| ```yaml | ||
| spec: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shouldn't this be a full manifest? And users can be asked to overwrite sample content displayed in the editor. |
||
| controllerConfig: | ||
| networkPolicies: | ||
| - name: allow-external-secrets-egress | ||
| componentName: ExternalSecretsCoreController | ||
| egress: | ||
| - {} | ||
| ``` | ||
|
|
||
| 6. Click **Create** to deploy the ExternalSecretsConfig. | ||
|
|
||
| 7. Wait for the controller pods to start running. | ||
| review: | ||
| instructions: |- | ||
| #### Verify the ExternalSecretsConfig was successfully deployed: | ||
|
|
||
| 1. Navigate to **Workloads** → **Pods** from the [Workloads]{{highlight qs-nav-workloads}} section. | ||
|
|
||
| 2. In the **Project** dropdown menu at the top, select **external-secrets**. | ||
|
|
||
| 3. Verify that the following pods are in **Running** status: | ||
| - external-secrets | ||
| - external-secrets-cert-controller | ||
| - external-secrets-webhook | ||
|
|
||
| Do all pods show a **Running** status? | ||
| failedTaskHelp: >- | ||
| This task isn't verified yet. Try the task again. If the pods are not | ||
| running, check the operator logs for more details. | ||
| summary: | ||
| success: >- | ||
| You have completely deployed the External Secrets Operator for Red Hat OpenShift! You can | ||
| now create SecretStores and ExternalSecrets to synchronize secrets | ||
| from external sources. Check out the next quick start for a simple | ||
| example of how to use the Custom Resources provided by the operator. | ||
| failed: >- | ||
| This task is incomplete. Check your work to make sure the ExternalSecretsConfig | ||
| was created correctly. | ||
| conclusion: >- | ||
| Your External Secrets Operator for Red Hat OpenShift is ready! You can now configure connections | ||
| to external secret management systems and start synchronizing secrets into | ||
| your OpenShift cluster. To learn more about using the External Secrets Operator, | ||
| refer to the [OpenShift documentation](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/security_and_compliance/external-secrets-operator-for-red-hat-openshift). | ||
| nextQuickStart: [] | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.