[kots]: add the KOTS installation manifests #8395

mrsimonemms · 2022-02-22T16:50:26Z

Description

This incorporates the Replicated/KOTS installation into the installation section of the repo. KOTS is a way of allowing us to manage how enterprises install our software

The change to .gitpod.yml is to install the Replicated CLI (to publish the manifests) and the KOTS (to install Gitpod with KOTS) plugin

Tested on:

NB this does not install the external dependencies, but merely that it provisions the application in those environments

I'm proposing avoiding the AWS testing at this stage until we establish whether the errors with the 2022.02.0 release are caused by this release or (more likely) an error in the AWS setup

Related Issue(s)

Fixes #

How to test

Release Notes

[kots]: add the KOTS installation manifests

Documentation

codecov · 2022-02-22T16:54:23Z

Codecov Report

Merging #8395 (cdedf00) into main (d4a2db8) will decrease coverage by 3.88%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #8395      +/-   ##
==========================================
- Coverage   15.06%   11.17%   -3.89%     
==========================================
  Files          51       18      -33     
  Lines        4899      993    -3906     
==========================================
- Hits          738      111     -627     
+ Misses       4089      880    -3209     
+ Partials       72        2      -70

Flag	Coverage Δ
components-gitpod-cli-app	`11.17% <ø> (ø)`
components-local-app-app-darwin-amd64	`?`
components-local-app-app-darwin-arm64	`?`
components-local-app-app-linux-amd64	`?`
components-local-app-app-linux-arm64	`?`
components-local-app-app-windows-386	`?`
components-local-app-app-windows-amd64	`?`
components-local-app-app-windows-arm64	`?`
components-ws-daemon-app	`?`
components-ws-daemon-lib	`?`
install-installer-raw-app	`?`

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

Impacted Files	Coverage Δ
...l/installer/pkg/components/ws-manager/tlssecret.go
components/ws-daemon/pkg/content/config.go
...installer/pkg/components/ws-manager/rolebinding.go
components/ws-daemon/pkg/content/initializer.go
install/installer/pkg/common/storage.go
components/ws-daemon/pkg/cpulimit/cpulimit.go
components/local-app/pkg/auth/auth.go
install/installer/pkg/common/render.go
components/ws-daemon/pkg/cpulimit/cfs.go
components/ws-daemon/pkg/daemon/markunmount.go
... and 23 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d4a2db8...cdedf00. Read the comment docs.

corneliusludmann · 2022-02-28T09:28:23Z

install/kots/Makefile

+helm:
+	@echo "Installing Helm dependencies"
+	@rm -f manifests/*.tgz
+	@for f in $(shell ls -d charts/*/); do cd $${f} && helm dep up && helm package . --destination ../../manifests && cd -; done


Instead of this helm magic, couldn't we just download the cert-manager package like this?

$ curl -sSLO https://charts.jetstack.io/charts/cert-manager-v1.7.0.tgz

Or wouldn't this work for some reason?

That would work, but I've done it as a general function in case we ever put a second Helm chart in there - we use external-dns in all the guides which might be worth offering in Kots in future

It's awesome that we have a generic solution for this problem at hand. To be honest, I would prefer the simple curl command, for now, to keep it simple. With that, we wouldn't need to add (and maintain) helm to the workspace image right now.

I know it's not easy to part with such an elegant, generic solution once you've poured it into code. However, this still exists in the archived gitpod-io/replicated repo and we can release it from there at any time as soon as we need it. You're not forgotten you beautiful code. We remember you! Promise! 👋

What do you think?

Oh @corneliusludmann, you'll make me blush 😊

Again, as I said in the .gitpod.yml comment - I treat these as a proposition and then we all talk about it. I'm happy with switching to a simpler solution.

Right, I think that my original approach is the correct one. Using the .tgz file provided by cert-manager has everything nested in a cert-manager folder. For KOTS to work, it needs to be in the root of the .tgz file - try pulling in the curl command you used and then run make lint to see the error.

So, that makes there two ways of achieving this:

create a noddy Chart.yaml file and use the helm package function

download the .tgz file, extract it, re-compress it with the cert-manager and use that new .tgz file

Whilst both have their limitations, I think approach 1 is the simpler and more maintainable one. We could just put the correct .tgz file in there, but I think that this might be forgotten when we come to do an update in future

Thoughts?

Agree. When a simple curl does not work, using helm seems to be the better approach.

github-actions · 2022-03-01T15:41:41Z

⚠️ Hey reviewer! BE CAREFUL ⚠️
Review the code before opening in your Gitpod. .gitpod.yml was changed and it might be harmful.

.gitpod.yml

install/installer/pkg/components/gitpod/configmap.go

corneliusludmann · 2022-03-01T17:31:08Z

install/kots/Makefile

+helm:
+	@echo "Installing Helm dependencies"
+	@rm -f manifests/*.tgz
+	@for f in $(shell ls -d charts/*/); do cd $${f} && helm dep up && helm package . --destination ../../manifests && cd -; done


It's awesome that we have a generic solution for this problem at hand. To be honest, I would prefer the simple curl command, for now, to keep it simple. With that, we wouldn't need to add (and maintain) helm to the workspace image right now.

I know it's not easy to part with such an elegant, generic solution once you've poured it into code. However, this still exists in the archived gitpod-io/replicated repo and we can release it from there at any time as soon as we need it. You're not forgotten you beautiful code. We remember you! Promise! 👋

What do you think?

@corneliusludmann

Original work by @corneliusludmann

@corneliusludmann

Original work by @corneliusludmann

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/XXL labels Feb 22, 2022

mrsimonemms force-pushed the sje/kots-install branch from a52c201 to 6ab3fd6 Compare February 22, 2022 16:52

mrsimonemms force-pushed the sje/kots-install branch 3 times, most recently from f18f93b to 23d39ac Compare February 23, 2022 16:22

roboquat added release-note and removed do-not-merge/release-note-label-needed labels Feb 23, 2022

mrsimonemms force-pushed the sje/kots-install branch 8 times, most recently from 9ae983f to f87fe10 Compare February 24, 2022 16:32

corneliusludmann reviewed Feb 28, 2022

View reviewed changes

mrsimonemms force-pushed the sje/kots-install branch from f87fe10 to a4db25c Compare February 28, 2022 11:59

Set /install to be owned by self-hosted team

2ed2272

mrsimonemms force-pushed the sje/kots-install branch 5 times, most recently from 96fdaa9 to fd35036 Compare March 1, 2022 13:17

mrsimonemms changed the title ~~WIP: [kots]: add the KOTS installation manifests~~ [kots]: add the KOTS installation manifests Mar 1, 2022

mrsimonemms marked this pull request as ready for review March 1, 2022 15:38

mrsimonemms requested a review from a team March 1, 2022 15:38

roboquat removed the do-not-merge/work-in-progress label Mar 1, 2022

mrsimonemms requested a review from corneliusludmann March 1, 2022 15:38

github-actions bot added the team: delivery Issue belongs to the self-hosted team label Mar 1, 2022

mrsimonemms force-pushed the sje/kots-install branch from fd35036 to 98f75d9 Compare March 1, 2022 15:41

corneliusludmann requested changes Mar 1, 2022

View reviewed changes

mrsimonemms marked this pull request as draft March 2, 2022 08:41

roboquat added the do-not-merge/work-in-progress label Mar 2, 2022

mrsimonemms force-pushed the sje/kots-install branch 2 times, most recently from 71f1942 to c62a6e2 Compare March 2, 2022 10:11

[kots]: initial commit

20aac44

mrsimonemms force-pushed the sje/kots-install branch from c62a6e2 to f994cc3 Compare March 2, 2022 10:56

Simon Emms added 5 commits March 2, 2022 12:52

[kots]: create the initial working installation

3c16e55

[kots]: add cert-manager as a Helm dependency

b75a35e

[kots]: configure Gitpod as a KOTS-installable app

836118c

[kots]: add support for SSH gateway (allows JetBrains IDE et al)

44568e3

Original work by @corneliusludmann

[kots]: add Gitpod config patch file as advanced option

cdedf00

Original work by @corneliusludmann

mrsimonemms force-pushed the sje/kots-install branch from f994cc3 to cdedf00 Compare March 2, 2022 12:53

mrsimonemms marked this pull request as ready for review March 2, 2022 13:07

roboquat removed the do-not-merge/work-in-progress label Mar 2, 2022

mrsimonemms requested a review from corneliusludmann March 2, 2022 13:09

corneliusludmann approved these changes Mar 2, 2022

View reviewed changes

roboquat merged commit 863bb02 into main Mar 2, 2022

roboquat deleted the sje/kots-install branch March 2, 2022 13:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[kots]: add the KOTS installation manifests #8395

[kots]: add the KOTS installation manifests #8395

mrsimonemms commented Feb 22, 2022 •

edited

Loading

codecov bot commented Feb 22, 2022 •

edited

Loading

corneliusludmann Feb 28, 2022

mrsimonemms Feb 28, 2022

corneliusludmann Mar 1, 2022

mrsimonemms Mar 2, 2022

mrsimonemms Mar 2, 2022 •

edited

Loading

corneliusludmann Mar 2, 2022

github-actions bot commented Mar 1, 2022

corneliusludmann Mar 1, 2022

[kots]: add the KOTS installation manifests #8395

[kots]: add the KOTS installation manifests #8395

Conversation

mrsimonemms commented Feb 22, 2022 • edited Loading

Description

Tested on:

Related Issue(s)

How to test

Release Notes

Documentation

codecov bot commented Feb 22, 2022 • edited Loading

Codecov Report

corneliusludmann Feb 28, 2022

Choose a reason for hiding this comment

mrsimonemms Feb 28, 2022

Choose a reason for hiding this comment

corneliusludmann Mar 1, 2022

Choose a reason for hiding this comment

mrsimonemms Mar 2, 2022

Choose a reason for hiding this comment

mrsimonemms Mar 2, 2022 • edited Loading

Choose a reason for hiding this comment

corneliusludmann Mar 2, 2022

Choose a reason for hiding this comment

github-actions bot commented Mar 1, 2022

corneliusludmann Mar 1, 2022

Choose a reason for hiding this comment

mrsimonemms commented Feb 22, 2022 •

edited

Loading

codecov bot commented Feb 22, 2022 •

edited

Loading

mrsimonemms Mar 2, 2022 •

edited

Loading