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]: create dev channels in KOTS and formalise the release process #8689

Merged
merged 1 commit into from
Mar 9, 2022

Conversation

mrsimonemms
Copy link
Contributor

Description

Formalise the development and release process in the KOTS ecosystem. This came as a result of a conversation with @Pothulapati where it was clear a lot of the process was in my head rather than formally documented

Related Issue(s)

Fixes #8688

How to test

Follow readme

Release Notes

[kots]: create dev channels in KOTS and formalise the release process

Documentation

@mrsimonemms
Copy link
Contributor Author

mrsimonemms commented Mar 9, 2022

NB I have kept the envvars with REPLICATED rather than KOTS convention because this is relevant to the paid-for ecosystem, rather than the KOTS open source package

@mrsimonemms mrsimonemms marked this pull request as ready for review March 9, 2022 14:13
@mrsimonemms mrsimonemms requested a review from a team March 9, 2022 14:13
@github-actions github-actions bot added the team: delivery Issue belongs to the self-hosted team label Mar 9, 2022
## Authentication

Two environment variables are required to be able to publish to our Replicated account:
The following environment variables are required to be able to publish to our Replicated account:

- `REPLICATED_APP`: the unique application slug
Copy link
Contributor

Choose a reason for hiding this comment

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

We still use gitpod-pov, right? Eventually, we will use gitpod for prod but still keep a different dev app slug, right? Should we mention the app slugs in use here?

By the way: What do you think of renaming gitpod-pov to gitpod-dev (or create if renaming does not work)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, we are using gitpod-pov which is what's defined by the REPLICATED_APP value. I'm not against documenting in there, but I don't think it's necessary

I can see why gitpod-dev would be preferable, but I'm not that bothered by renaming it. If the majority want to rename it, that's fine, but it's effectively our internal dev service so it's fine as is.

I think we'll likely abandon gitpod-pov in future and just use gitpod but that's a future discussion

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not against documenting in there, but I don't think it's necessary

How does a new colleague know which value to set here? Maybee, we need also a link to the vendor portal where an API key can be generated. Would make the onboarding of new folks easier when we have this written down somewhere and why not here in the readme?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok. I've changed the wording slightly.

The vendor portal is linked in the REPLICATED_API_TOKEN. I'm reluctant to duplicate too much of their development readme in ours as it means we then have to maintain that as well as our own application.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok. I've changed the wording slightly.

The vendor portal is linked in the REPLICATED_API_TOKEN. I'm reluctant to duplicate too much of their development readme in ours as it means we then have to maintain that as well as our own application.

Awesome! Thanks a lot! 👍

Copy link
Contributor

@corneliusludmann corneliusludmann left a comment

Choose a reason for hiding this comment

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

/hold

looks good to me, adding hold in case @Pothulapati will check this as well or if you would like to add something for #8689 (comment)

Pothulapati
Pothulapati previously approved these changes Mar 9, 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.

Change Looks good to me! Thanks for taking the time @mrsimonemms

@mrsimonemms
Copy link
Contributor Author

mrsimonemms commented Mar 9, 2022

/werft with-clean-slate-deployment

👎 unknown command: with-clean-slate-deployment
Use /werft help to list the available commands

@mrsimonemms
Copy link
Contributor Author

mrsimonemms commented Mar 9, 2022

/werft help

👍 You can interact with werft using: /werft command <args>.
Available commands are:

  • /werft run [annotation=value] which starts a new werft job from this context.
    You can optionally pass multiple whitespace-separated annotations.
  • /werft help displays this help

@mrsimonemms
Copy link
Contributor Author

mrsimonemms commented Mar 9, 2022

/werft run with-clean-slate-deployment

👍 started the job as gitpod-build-sje-kots-channels.2

@corneliusludmann
Copy link
Contributor

corneliusludmann commented Mar 9, 2022

@mrsimonemms: Installing preview env fails due to exceeded quota.

Why not using … ?

/werft run no-preview

👍 started the job as gitpod-build-sje-kots-channels.3

(since this change has no effect on the preview env (does it?) a preview env would indeed unnecessary)

@mrsimonemms
Copy link
Contributor Author

mrsimonemms commented Mar 9, 2022

(I'm tired and just want Werft to work 😄 )

Copy link
Contributor

@corneliusludmann corneliusludmann left a comment

Choose a reason for hiding this comment

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

/unhold

@roboquat roboquat merged commit 754114d into main Mar 9, 2022
@roboquat roboquat deleted the sje/kots-channels branch March 9, 2022 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note size/M team: delivery Issue belongs to the self-hosted team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable users to push to their own KOTS channel for development purposes
4 participants