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

[installer]: add secret template to certs #11524

Merged
merged 2 commits into from
Jul 21, 2022
Merged

Conversation

mrsimonemms
Copy link
Contributor

@mrsimonemms mrsimonemms commented Jul 21, 2022

Description

The support bundle secret collector looks for a label app=gitpod. As of v1.5, cert-manager supports a secretTemplate option on the certs which adds a label and/or annotation to the secrets - NB I haven't updated to latest version of cert-manager as that requires a change of name and lots of updates to packages, including a Helm one that would require renaming the internal charts to lower case values

This upgrades cert-manager to latest (included renaming the package), adds the labels to the secret and configures the secretTemplate. As this is still cert-manager v1, this does not seems to introduce any regressions and have tested both upgrades and fresh installs.

The reason for this change is because I was helping a Discord user debug a cert issue and had no way of knowing if the cert had been created from the support bundle. This solves this issue by included the secret metadata in the support bundle

How to test

Install via KOTS or Installer and check for app: gitpod in the secret's labels

Release Notes

[installer]: add secret template to certs

Documentation

Werft options:

  • /werft with-preview

@mrsimonemms
Copy link
Contributor Author

mrsimonemms commented Jul 21, 2022

/werft run publish-to-kots

👍 started the job as gitpod-build-sje-cert-manager-update.1
(with .werft/ from main)

@mrsimonemms mrsimonemms force-pushed the sje/cert-manager-update branch from e43d726 to afb11a6 Compare July 21, 2022 09:40
@mrsimonemms
Copy link
Contributor Author

mrsimonemms commented Jul 21, 2022

/werft run publish-to-kots

👍 started the job as gitpod-build-sje-cert-manager-update.3
(with .werft/ from main)

@mrsimonemms mrsimonemms force-pushed the sje/cert-manager-update branch from afb11a6 to 4677847 Compare July 21, 2022 10:01
@roboquat roboquat added size/L and removed size/XL labels Jul 21, 2022
Simon Emms added 2 commits July 21, 2022 10:03
This introduces the `secretTemplate` parameter
This allows them to be picked up by the KOTS support bundle
@mrsimonemms mrsimonemms force-pushed the sje/cert-manager-update branch from 4677847 to 7aab955 Compare July 21, 2022 10:05
@mrsimonemms
Copy link
Contributor Author

mrsimonemms commented Jul 21, 2022

/werft run publish-to-kots

👍 started the job as gitpod-build-sje-cert-manager-update.6
(with .werft/ from main)

@mrsimonemms mrsimonemms marked this pull request as ready for review July 21, 2022 10:25
@mrsimonemms mrsimonemms requested review from a team July 21, 2022 10:25
@github-actions github-actions bot added team: delivery Issue belongs to the self-hosted team team: workspace Issue belongs to the Workspace team labels Jul 21, 2022
Copy link
Contributor

@Pothulapati Pothulapati left a comment

Choose a reason for hiding this comment

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

LGTM! Like we discussed, We should be showcasing the cert-manager requirement >=1.5.

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-sje-cert-manager-update.7 because the annotations in the pull request description changed
(with .werft/ from main)

@roboquat roboquat merged commit 3aa56e6 into main Jul 21, 2022
@roboquat roboquat deleted the sje/cert-manager-update branch July 21, 2022 14:15
@Furisto
Copy link
Member

Furisto commented Jul 21, 2022

Tested that labels have been applied to the certificates and I do not see any adverse effects this would have on workspace components.

@roboquat roboquat added the deployed: workspace Workspace team change is running in production label Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployed: workspace Workspace team change is running in production release-note size/L team: delivery Issue belongs to the self-hosted team team: workspace Issue belongs to the Workspace team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants