Skip to content
This repository has been archived by the owner on Aug 19, 2024. It is now read-only.

docs: add note in CRD that using Routes with external certificates in TLS Secrets is Technical Preview in OCP [RHDHBUGS-45] #413

Conversation

rm3l
Copy link
Member

@rm3l rm3l commented Jul 25, 2024

Description

This is a follow-up to https://issues.redhat.com/browse/RHDHBUGS-45

Right now, using the Operator, a user can reference an external certificate as a Secret in their CR, like so:

spec: 
  application: 
    route: 
      enabled: true
      host: my-rhdh.apps.example.com
      tls: 
        externalCertificateSecretName: my-rhdh-tls-cert

However, as depicted in https://docs.openshift.com/container-platform/4.16/networking/routes/secured-routes.html#nw-ingress-route-secret-load-external-cert_secured-routes, Securing route with external certificates in TLS secrets is a Technology Preview feature only. As such, it requires enabling the RouteExternalCertificate Feature Gate in OpenShift.

This updates the doc about the spec.application.route.tls.externalCertificateSecretName CRD field accordingly.

Note that there is a dedicated issue for the product docs team to call this out: https://issues.redhat.com/browse/RHIDP-3292

Which issue(s) does this PR fix or relate to

PR acceptance criteria

  • Tests
  • Documentation
  • If the bundle manifests have been updated, make sure to review the rhdh-operator.csv.yaml file accordingly

How to test changes / Special notes to the reviewer

Preview of how this looks like in the OCP web console:

image

Copy link

sonarcloud bot commented Jul 25, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
16.0% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

@rm3l
Copy link
Member Author

rm3l commented Jul 25, 2024

/cc @gazarenkov

@openshift-ci openshift-ci bot requested a review from gazarenkov July 25, 2024 13:06
@rm3l rm3l changed the title docs: add note in CRD that Routes with external certificates in TLS Secrets is Technical Preview in OCP [RHDHBUGS-45] docs: add note in CRD that using Routes with external certificates in TLS Secrets is Technical Preview in OCP [RHDHBUGS-45] Jul 25, 2024
@openshift-ci openshift-ci bot added the lgtm PR is ready to be merged. Required by Prow. label Jul 26, 2024
Copy link

openshift-ci bot commented Jul 26, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gazarenkov

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved PR has been approved by an approver from all required OWNERS files. Required by Prow. label Jul 26, 2024
@rm3l
Copy link
Member Author

rm3l commented Jul 26, 2024

/override "SonarCloud Code Analysis"

Duplication here is a result of having the same doc generated in the bundle manifests.

Copy link

openshift-ci bot commented Jul 26, 2024

@rm3l: Overrode contexts on behalf of rm3l: SonarCloud Code Analysis

In response to this:

/override "SonarCloud Code Analysis"

Duplication here is a result of having the same doc generated in the bundle manifests.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-merge-bot openshift-merge-bot bot merged commit 00f5555 into janus-idp:main Jul 26, 2024
8 of 9 checks passed
@rm3l rm3l deleted the RHDHBUGS-45--doc-in-crd-that-external-certificate-secret-name-is-tp-in-ocp branch July 26, 2024 11:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved PR has been approved by an approver from all required OWNERS files. Required by Prow. lgtm PR is ready to be merged. Required by Prow.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants