-
Notifications
You must be signed in to change notification settings - Fork 34
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
Add helm charts for lws. #266
Conversation
Hi @wqlparallel. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
/ok-to-test |
charts/lws/README.md
Outdated
##### Install chart using Helm v3.0+ | ||
|
||
```bash | ||
$ git clone [email protected]:kubernetes-sigs/kueue.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
$ git clone [email protected]:kubernetes-sigs/kueue.git | |
$ git clone [email protected]:kubernetes-sigs/lws.git |
charts/lws/README.md
Outdated
##### Verify that controller pods are running properly. | ||
|
||
```bash | ||
$ kubectl get deploy -n kueue-system |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
$ kubectl get deploy -n kueue-system | |
$ kubectl get deploy lws-system |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sorry,I referenced the queue project during development because the helm charts for queue and lws are quite similar. I've corrected the submission now. The helm chart has been tested and appears to be functioning correctly.
2b986bd
to
d2bcf84
Compare
/hold Put my concern here: #260 (comment) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we add a link to the helm-based installation instructions in https://github.com/kubernetes-sigs/lws/blob/main/docs/setup/install.md
# incremented each time you make changes to the application. Versions are not expected to | ||
# follow Semantic Versioning. They should reflect the version the application is using. | ||
# It is recommended to use it with quotes. | ||
appVersion: "v0.4.2" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this the only place that we need to update every time we make a release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this refers to the lws version, but we need to update the release version as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In each release, we should update at least two fields: appVersion
and version
. We typically update appVersion
when we're releasing a new version of LWS. But, always update the version
field with any change to the Helm chart. If there are no other changes to the Helm chart-liske adding more parameters or configuration-then you'll only need to focus on those two.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please add release instructions, and I will make them part of the release template when this gets merged
$ git clone [email protected]:kubernetes-sigs/lws.git | ||
$ cd charts | ||
$ helm install lws lws --create-namespace --namespace lws-system | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how do we install this from a release package? can we add instructions to making the helm charts an artifact of the release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can store the helm packages in github with gh-pages. But that's the next step.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Installing lws from a release package sounds good, and I agree that it's a step we consider next.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Install in a different namespace is another thing I'm concerned, but that can be follow up together.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you please open issues to track the follow up items?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ticketed here #289
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @wqlparallel could you solve the comments? And does this support install lws in a different namespace rather than lws-system?
|
||
#### Prerequisites | ||
|
||
- [Helm](https://helm.sh/docs/intro/quickstart/#install-helm) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add (Optional) [Cert-manager](https://cert-manager.io/docs/installation/)
as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your comment! I believe that Cert-manager should not be listed as a prerequisite for the Helm chart since it can be installed optionally if the user sets enableCertManager: true
in values.yaml
. In this context, prerequisites should only include Helm itself, while Cert-manager is treated as an application dependency that users can choose to enable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's why it's optional
# incremented each time you make changes to the application. Versions are not expected to | ||
# follow Semantic Versioning. They should reflect the version the application is using. | ||
# It is recommended to use it with quotes. | ||
appVersion: "v0.4.2" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this refers to the lws version, but we need to update the release version as well.
$ git clone [email protected]:kubernetes-sigs/lws.git | ||
$ cd charts | ||
$ helm install lws lws --create-namespace --namespace lws-system | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can store the helm packages in github with gh-pages. But that's the next step.
/hold cancel |
I have committed the code to address the comments. And this Helm chart supports installing the lws in a different namespace when referencing the main image. However, it may not work as expected in the latest release (v0.4.2) because the commit that deployed in the specified namespace hasn’t been merged yet. |
Please squash, I'm ok with the PR. Leave to @ahg-g for final approval. |
Signed-off-by: wqlparallel <[email protected]>
/label tide/merge-method-squash |
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ahg-g, wqlparallel 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 |
What type of PR is this?
/kind feature
What this PR does / why we need it
Added helm charts for lws.
Which issue(s) this PR fixes
Fixes #260
Special notes for your reviewer
Does this PR introduce a user-facing change?