Skip to content

Conversation

@tobico
Copy link

@tobico tobico commented Feb 6, 2025

Adds a note for a frequently encountered issue that will prevent users from being able to use a ClusterIssuer as suggested in the documentation.

Solution comes from this issue comment: cert-manager/cert-manager#3246 (comment)

Adds a note for a frequently encountered issue that will prevent users from being able to use a ClusterIssuer as suggested in the documentation.

Solution comes from this issue comment: cert-manager/cert-manager#3246 (comment)

Signed-off-by: Tobias Cohen <[email protected]>
@cert-manager-prow cert-manager-prow bot added the dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. label Feb 6, 2025
@cert-manager-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign inteon for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@cert-manager-prow cert-manager-prow bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 6, 2025
@netlify
Copy link

netlify bot commented Feb 6, 2025

Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0821273
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager/deploys/67a4356c27fd240008f2196a
😎 Deploy Preview https://deploy-preview-1640--cert-manager.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hawksight
Copy link
Member

Hello @tobico, thank you for contributing an enhancement to our documentation. I struggled to actually find the page when reviewing but finally found it. I have a couple of suggestions, but let me just suggest an alternate wording:

When cert-manager is installed using Helm, the CRDs are not included by default.
Please refer to our [helm installation instructions](../installation/helm.md#2-install-cert-manager) 
for the correct input value to enable the CRDs during installation.

Mainly this was to:

  • Not repeat the values flags in more pages as they need to be updated and will likely be forgotten in the future
  • Point to existing instruction which has the right flag: --set crds.enabled=true

If you are happy to update with something similar to above that'd be great. If not I can always make the change if you don't have time.


Note that when cert-manager is installed using Helm, the CRDs for the ClusterIssuer
resource type are not included by default. They can be included by adding the flag
`--set installCRDs=true` during installation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`--set installCRDs=true` during installation.
`--set crds.enabled=true` during installation.

Comment on lines +40 to +41
Note that when cert-manager is installed using Helm, the CRDs for the ClusterIssuer
resource type are not included by default. They can be included by adding the flag
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note that when cert-manager is installed using Helm, the CRDs for the ClusterIssuer
resource type are not included by default. They can be included by adding the flag
Note that when cert-manager is installed using Helm, the CRDs are not included by default.
They can be included by adding the flag

The CRD for Issuer is also not installed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants