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

Add helm charts for lws. #266

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Conversation

wqlparallel
Copy link
Contributor

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?


@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 24, 2024
@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Nov 24, 2024
@kannon92
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 24, 2024
##### Install chart using Helm v3.0+

```bash
$ git clone [email protected]:kubernetes-sigs/kueue.git
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
$ git clone [email protected]:kubernetes-sigs/kueue.git
$ git clone [email protected]:kubernetes-sigs/lws.git

##### Verify that controller pods are running properly.

```bash
$ kubectl get deploy -n kueue-system
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
$ kubectl get deploy -n kueue-system
$ kubectl get deploy lws-system

Copy link
Contributor Author

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.

@wqlparallel wqlparallel force-pushed the helm branch 3 times, most recently from 2b986bd to d2bcf84 Compare November 25, 2024 01:56
@kerthcet
Copy link
Contributor

/hold

Put my concern here: #260 (comment)

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 27, 2024
Copy link
Contributor

@ahg-g ahg-g left a 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"
Copy link
Contributor

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?

Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

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
```
Copy link
Contributor

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?

Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor

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?

Copy link
Contributor

@kerthcet kerthcet Dec 18, 2024

Choose a reason for hiding this comment

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

ticketed here #289

Copy link
Contributor

@kerthcet kerthcet left a 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)
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

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"
Copy link
Contributor

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
```
Copy link
Contributor

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.

@kerthcet
Copy link
Contributor

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 13, 2024
@wqlparallel
Copy link
Contributor Author

Hi @wqlparallel could you solve the comments? And does this support install lws in a different namespace rather than lws-system?

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.

@kerthcet
Copy link
Contributor

Please squash, I'm ok with the PR. Leave to @ahg-g for final approval.

Signed-off-by: wqlparallel <[email protected]>
@ahg-g
Copy link
Contributor

ahg-g commented Dec 17, 2024

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Dec 17, 2024
@ahg-g
Copy link
Contributor

ahg-g commented Dec 17, 2024

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 17, 2024
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 17, 2024
@k8s-ci-robot k8s-ci-robot merged commit a1ea3ef into kubernetes-sigs:main Dec 17, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding Helm Chart for lws
5 participants