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

doc: gwctl - improve readme, add Makefile #2706

Merged
merged 1 commit into from
Jan 17, 2024

Conversation

pottekkat
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Adds a basic Makefile to build the gwctl binary and improves the documentation in the readme.

Which issue(s) this PR fixes: none

Does this PR introduce a user-facing change?:

NONE

Signed-off-by: Navendu Pottekkat <navendu@apache.org>
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 7, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @pottekkat!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @pottekkat. 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/test-infra 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/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 7, 2024
@pottekkat
Copy link
Contributor Author

Hi, I have a question. gwctl should be in a separate repository similar to https://github.com/kubernetes-sigs/ingress2gateway, right? Is there any particular reason why it is kept here? Having a separate repository could make it easier to manage.

I can help improve gwctl, as mentioned by @robscott in this comment: #2428 (comment).

But I don't see any open issues. Do you think I should create them? Some of the problems I think we need to fix initially are:

  1. Failing gracefully: Currently, gwctl throws a lot of errors when an expected resource or something else is missing. We can add checks to prevent this and fail gracefully while showing better messages to the user.
  2. Move subcommands to proper packages: The way the code is organized can be a bit confusing. Refactoring it to look like other Go/Cobra CLI projects would be better.
  3. Add tests.
  4. Set up a workflow to publish binaries instead of installing them from the source.
  5. Change the CLI name to kubectl-gw so that it is a kubectl plugin.

I think these are reasonable first steps, and after this, we can proceed as mentioned in the comment by sketching out a desired UX to be a drop-in replacement for kubectl get can be achieved.

Let me know what you think and I can fix these!

@pottekkat
Copy link
Contributor Author

Another thing here is that if we are running go mod vendor, shouldn't those files under the vendor folder be committed? But I don't think we need it and we can remove the command from the build process.

@robscott
Copy link
Member

robscott commented Jan 8, 2024

Thanks @pottekkat!

/assign @gauravkghildiyal

@robscott
Copy link
Member

robscott commented Jan 8, 2024

/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 Jan 8, 2024
@youngnick youngnick changed the title doc: improve readme, add Makefile doc: gwctl - improve readme, add Makefile Jan 15, 2024
@youngnick
Copy link
Contributor

I think that when we started work on gwctl, the reason we've put it in this repo is so that it eventually ends up getting released at the same time and version as the API. ingress2gateway has a slightly different use case which means that releasing separately makes more sense.

I also updated the title to make it clearer that this is for gwctl.

@gauravkghildiyal
Copy link
Member

Thanks @pottekkat! This LGTM.

/lgtm

Yes I have an upcoming PR (should be out this week) to discuss and document the next steps of gwctl, which will be followed by the creation of the relevant issues. This should help facilitate contributions towards a common goal from everyone community :)

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

Thanks @pottekkat!

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pottekkat, robscott

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 Jan 17, 2024
@pottekkat
Copy link
Contributor Author

@gauravkghildiyal That sounds great! I would like to get involved. I was also working on a PR to organize the code better and fail gracefully with better error messages. I can also open that PR.

@gauravkghildiyal
Copy link
Member

@pottekkat

That's great! I can only hope you don't run into issues with the changes from #2708 I'm trying to get this in sooner so it unblocks other development. Otherwise someone will have to deal with lots of merge conflicts :)

@gauravkghildiyal
Copy link
Member

Hmmm I don't think the pull-gateway-api-verify is supposed to take so long.

/retest

@k8s-ci-robot k8s-ci-robot merged commit 567de2b into kubernetes-sigs:main Jan 17, 2024
8 checks passed
@pottekkat pottekkat deleted the doc/improve-readme/1 branch January 17, 2024 03:16
@pottekkat
Copy link
Contributor Author

I did not notice #2708 before. I will wait till it is merged before I open the other PR.

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/documentation Categorizes issue or PR as related to documentation. 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. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants