Skip to content
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

Document how to configure cert-manager via OLM #983

Merged
merged 7 commits into from May 20, 2022

Conversation

wallrj
Copy link
Member

@wallrj wallrj commented May 19, 2022

I've tried to document the OLM configuration options that are available today and mention some of the limitations.

Part of:

Signed-off-by: Richard Wall <richard.wall@jetstack.io>
@jetstack-bot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@jetstack-bot jetstack-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels May 19, 2022
@netlify
Copy link

netlify bot commented May 19, 2022

Deploy Preview for cert-manager-website ready!

Name Link
🔨 Latest commit b6d7691
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager-website/deploys/628622f5d3ec2e0008080b39
😎 Deploy Preview https://deploy-preview-983--cert-manager-website.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 settings.

Signed-off-by: Richard Wall <richard.wall@jetstack.io>
Signed-off-by: Richard Wall <richard.wall@jetstack.io>
…urce

Signed-off-by: Richard Wall <richard.wall@jetstack.io>
@jetstack-bot jetstack-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 19, 2022
Signed-off-by: Richard Wall <richard.wall@jetstack.io>
@wallrj wallrj marked this pull request as ready for review May 19, 2022 14:43
@wallrj wallrj changed the title WIP: Document how to configure cert-manager via OLM Subscription Document how to configure cert-manager via OLM May 19, 2022
@jetstack-bot jetstack-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 19, 2022
@wallrj wallrj requested a review from jahrlin May 19, 2022 14:46
Signed-off-by: Richard Wall <richard.wall@jetstack.io>
Signed-off-by: Richard Wall <richard.wall@jetstack.io>
Copy link
Contributor

@jahrlin jahrlin left a comment

Choose a reason for hiding this comment

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

Great!

/lgtm

> 🔰 Refer to the [Subscription API documentation](https://pkg.go.dev/github.com/operator-framework/api@v0.14.0/pkg/operators/v1alpha1#Subscription).

Here are some examples of configuration that can be achieved by modifying the Subscription resource.
In each case we assume that you are starting with the following [default Subscription from OperatorHub.io]((https://operatorhub.io/install/cert-manager.yaml)):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In each case we assume that you are starting with the following [default Subscription from OperatorHub.io]((https://operatorhub.io/install/cert-manager.yaml)):
In each case we assume that you are starting with the following [default Subscription from OperatorHub.io](https://operatorhub.io/install/cert-manager.yaml):

@@ -91,9 +91,146 @@ in accordance with [OLM's Recommended Channel Naming][].
If you have any issues with your installation, please refer to the
[FAQ](../faq/README.md).

## Configuration

The configuration options are quite limited when you install cert-manager using OLM.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just out of curiosity: are the options limited because of limitations with OLM or is it limitation we have imposed?

Copy link
Member Author

Choose a reason for hiding this comment

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

The current version of OLM has limited support for modifying the deployment, as documented in this PR.
For example, it does not provide an easy way for the OLM package author to allow the container command line flags to be overridden.
But on the other hand, if all the cert-manager components could be configured using a config file in a configmap and if all the existing command line options could also be declared inthose config files, that particular problem would be solved.

There are some other limitations such as not being able to customize the resource requests of individual Deployments in the OLM package:

The current API seems to be designed around there only being a single Deployment in each package, but cert-manager has three.

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label May 20, 2022
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jahrlin, wallrj

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants