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

[kots] remove cert-manager from Gitpod package #8785

Merged
merged 1 commit into from
Mar 16, 2022
Merged

Conversation

Pothulapati
Copy link
Contributor

@Pothulapati Pothulapati commented Mar 14, 2022

Description

Currently, We include cert-manager instance into the
Gitpod kots package, and install it whenever Gitpod installation
is requested.

This causes the following problems:

  • cert-manager is a separate beast on its own, There are numerous
    configurations that might be needed to be set to make it run correctly
    based on the cluster config.
  • A lot users could have already have it installed, and have to
    struggle to get Gitpod up and running in those cases.

To solve them, We could either provide all the configurations of
cert-manager into the Gitpod package to cater users with all
config needs or remove the package and expect cert-manager as a
pre-requisite and make sure its documented.

The latter feels better as it removes the maintenance of cert-manager for
us while also allowing users to have specific configuration. The install
path for cert-manager is also pretty well documented
with all the changes needed based on the cluster environment.

This PR also removes the cert-manager issuers and updates the config to allow
users to use pre-configured resources

Signed-off-by: Tarun Pothulapati tarun@gitpod.io

Related Issue(s)

Fixes #8749

How to test

  • Install Gitpod using k kots install gitpod-pov/dev-tar

Release Notes

[kots] Remove `cert-manager` from the Gitpod package

Documentation

@Pothulapati Pothulapati requested a review from a team March 14, 2022 07:47
@github-actions github-actions bot added the team: delivery Issue belongs to the self-hosted team label Mar 14, 2022
@codecov
Copy link

codecov bot commented Mar 14, 2022

Codecov Report

Merging #8785 (7bc9e11) into main (77a3414) will not change coverage.
The diff coverage is n/a.

❗ Current head 7bc9e11 differs from pull request most recent head c904a6a. Consider uploading reports for the commit c904a6a to get more accurate results

@@           Coverage Diff           @@
##             main    #8785   +/-   ##
=======================================
  Coverage   11.17%   11.17%           
=======================================
  Files          18       18           
  Lines         993      993           
=======================================
  Hits          111      111           
  Misses        880      880           
  Partials        2        2           
Flag Coverage Δ
components-gitpod-cli-app 11.17% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

Copy link
Contributor

@mrsimonemms mrsimonemms left a comment

Choose a reason for hiding this comment

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

Good start, but a couple of thoughts on it

install/kots/manifests/gitpod-installer-job.yaml Outdated Show resolved Hide resolved
install/kots/manifests/kots-config.yaml Outdated Show resolved Hide resolved
@Pothulapati Pothulapati force-pushed the tar/kots-remove-cert branch 2 times, most recently from a630840 to c139f27 Compare March 14, 2022 12:03
@Pothulapati Pothulapati force-pushed the tar/kots-remove-cert branch 2 times, most recently from d0049ef to 137091a Compare March 14, 2022 15:20
@Pothulapati
Copy link
Contributor Author

Pothulapati commented Mar 14, 2022

Updated the PR to not mention the pre-requisite requirement of cert-manager as we have multiple ways to do that, and are discussing with replicated folks on the best way to have it i.e either a pre-flight check, or in the config itself.

Will raise a PR once we take a decision there. We can review and merge this removal meanwhile.

mrsimonemms
mrsimonemms previously approved these changes Mar 15, 2022
Copy link
Contributor

@mrsimonemms mrsimonemms left a comment

Choose a reason for hiding this comment

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

/hold

This is good work @Pothulapati. I'd like to get the work in to remove the (cluster)issuer setup as well which is why I've put this on hold - if you want me to do it, remove the hold and we'll merge yours in. If you want to add it to this PR, please do so and I'll add that to the review.

Currently, We include `cert-manager` instance into the
Gitpod kots package, and install it whenever Gitpod installation
is requested.

This causes the following problems:

- `cert-manager` is a separate beast on its own, There are numerous
configurations that might be needed to be set to make it run correctly.
- A lot users could have already have it installed, and have to
  struggle to get Gitpod up and running in those cases.

To solve them, We could either provide all the configurations of
`cert-manager` into the Gitpod package to cater users with all
config needs or remove the package and expect `cert-manager` as a
pre-requisite and make sure its documented.

The latter feels better as it removes the maintaince of cert-manager for
us while also allowing users to have specific configuration. The install
path for `cert-manager` is [also pretty well documented](https://cert-manager.io/docs/installation/)
with all the [changes needed based on the cluster environment](https://cert-manager.io/docs/installation/compatibility/).

This PR also removes the cert-manager issuers and updates the config to allow
users to use pre-configured resources

Signed-off-by: Tarun Pothulapati <tarun@gitpod.io>
@Pothulapati
Copy link
Contributor Author

@mrsimonemms I've updated the commit log to include a single commit for both this and the other PR that got merged into this.

@mrsimonemms mrsimonemms self-requested a review March 16, 2022 08:11
Copy link
Contributor

@mrsimonemms mrsimonemms left a comment

Choose a reason for hiding this comment

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

LGTM

@mrsimonemms
Copy link
Contributor

/unhold

@roboquat roboquat merged commit 783c8d6 into main Mar 16, 2022
@roboquat roboquat deleted the tar/kots-remove-cert branch March 16, 2022 08:52
Pothulapati added a commit that referenced this pull request Mar 16, 2022
With #8785, We expect users
to install their own `cert-manager` install. This PR adds a new
pre-flight check to verify the existence of the `cert-manager`.

As there is no general way to check for the existence of `cert-manager`,
We check for the `certificates.cert-manager.io` CRD instead.

Signed-off-by: Tarun Pothulapati <tarun@gitpod.io>
Pothulapati added a commit that referenced this pull request Mar 21, 2022
With #8785, We expect users
to install their own `cert-manager` install. This PR adds a new
pre-flight check to verify the existence of the `cert-manager`.

As there is no general way to check for the existence of `cert-manager`,
We check for the `certificates.cert-manager.io` CRD instead.

Signed-off-by: Tarun Pothulapati <tarun@gitpod.io>
roboquat pushed a commit that referenced this pull request Mar 21, 2022
With #8785, We expect users
to install their own `cert-manager` install. This PR adds a new
pre-flight check to verify the existence of the `cert-manager`.

As there is no general way to check for the existence of `cert-manager`,
We check for the `certificates.cert-manager.io` CRD instead.

Signed-off-by: Tarun Pothulapati <tarun@gitpod.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note size/XXL team: delivery Issue belongs to the self-hosted team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[installer] Remove cert-manager Helm chart from Kots
3 participants