Coordinate development of initial gwctl feature set

[gauravkghildiyal]

Creating a parent issue to track the development of the initial set of features for gwctl.

Getting Started

To gain a deeper understanding of gwctl's purpose and the concepts involved, please take some time to review the relevant sections of https://gateway-api.sigs.k8s.io/geps/gep-2722/

For insights into the structure and high-level organization of gwctl's code, refer to this guide.

Call for contributors

If you are interesting in helping out, please comment below indicating which area you'd like to work on (and get started working on it). I'll follow up by creating a GitHub issue and assigning the task to you. I'll make an effort to help clarify or provide more details as and when you require. THANK YOU for contributing!

Tasks

Implement basic get command support

Tasks

Preview Give feedback

1. Implement gwctl get namespace #2854
   area/gwctl +1
   
2. Implement gwctl get gateways #2778
   area/gwctl +1
   
3. Implement gwctl get gatewayclass #2846
   area/gwctl +1
   
4. Implement gwctl get backends #2866
   area/gwctl +1
   
5. Add missing columns to gwctl get httproutes #2804
   area/gwctl +1
   
6. Add missing columns to gwctl get policies #2807
   area/gwctl +1
   
7. Add missing columns to gwctl get policycrds #2810
   area/gwctl +1
   

Implement basic describe command support

Tasks

Preview Give feedback

1. Implement gwctl describe policycrds #2870
   area/gwctl +1
2. Implement gwctl describe namespaces #2795
   area/gwctl +1
   

Enhance describe command output

Tasks

Preview Give feedback

1. Expand output for gwctl describe gatewayclass #2796
   area/gwctl +1
   
2. Expand output for gwctl describe gateways #2994
   area/gwctl kind/feature +2
   
3. Migrate all describe views to using the new Describer utils (like gateway.go)
4. Add Events to all describe views (like gateway.go)
5. Add an Analysis section in gwctl describe views (like Gateway, HTTPRoute, Backend) which displays the Errors from the resource nodes
6. Expand output for gwctl describe httproutes #3037
   area/gwctl +1
   
7. Expand output for gwctl describe namespaces
8. Expand output for gwctl describe backends

Add label-based filtering

Tasks

Preview Give feedback

1. Add label filtering (-l) for get commands #2890
   area/gwctl +1
   
2. [gwctl] Add label filtering (-l) for get namespaces #2913
   +0
   
3. Add label filtering (-l) for describe commands #2933
   area/gwctl +1
   

Support custom output formats in get commands

Tasks

Preview Give feedback

1. Support wide output format for get commands (-o wide) #2889
   area/gwctl +1
   
2. Support JSON output format in get commands (-o json) #2931
   area/gwctl kind/feature +2
   
3. Support YAML output format in get commands (-o yaml) #2932
   area/gwctl kind/feature lifecycle/stale +3
   

Testing and Release

Tasks

Preview Give feedback

1. Add some basic e2e tests that can be made presubmit blockers during the initial development.
2. Add more thorough e2e tests covering a wider set of features.
3. Improve code coverage in existing packages like policymanager, resourcediscovery and relations.
4. Setup goreleaser configs for building binaries.
5. Add gwctl to the krew plugin index. Complete any further integration.

Miscellaneous

Tasks

Preview Give feedback

1. Gracefully handle errors when we try to calculate effective policy but the resource isn’t present. For example, if an HTTPRoute references a Gateway which does not exist, right now the code may panic.
2. Ensure that policy calculation takes into account the fact that namespaced policies can only be applied to resources within the same namespace (i.e. have no cross-namespace references in policies)
3. [gwctl] Handle resources from multiple versions (v1, v1beta1) of Gateway API. #3000
   area/gwctl +1
   
4. Check if Gateway accepts attachments of HTTPRoutes. If an HTTPRoute is attached to a Gateway which isn't permitted, display that as a user error when doing gwctl describe
5. Figure out a robust way of constructing the kubernetes client (for cases when kubeconfigpath is not set, which is usually the case). It's also possible that the current way is already the best thing possible

/assign @gauravkghildiyal

[gauravkghildiyal]

/help

[k8s-ci-robot]

@gauravkghildiyal:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

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.

[gauravkghildiyal]

/area gwctl

[jongwooo]

I'd like to work on implementing gwctl get command.

[Devaansh-Kumar]

Hello, I would like to work on implementing gwctl describe command.

[harshitasao]

Hey, I would like to work on enhancing the describe command output

[jongwooo]

@gauravkghildiyal For httproutes, there should be 6 columns fully implemented, but there are only 2(NAME, HOSTNAMES). I would appreciate it if you could add policies, policycrds, and httproutes to the task. Ref:
https://deploy-preview-2723--kubernetes-sigs-gateway-api.netlify.app/geps/gep-2722/#output-formats

[pottekkat]

Gracefully handle errors when we try to calculate effective policy but the resource isn’t present.

@gauravkghildiyal I can take on this task, at least partially. I was working on it before, but as mentioned here, it had conflicts with your previous PR. I can add those changes now that the PR is merged.

Opened a draft PR: #2825 but this does not address the issue mentioned here. Should I add that in the same PR or move to a different one? Because the current PR is already big.

[gauravkghildiyal]

Gracefully handle errors when we try to calculate effective policy but the resource isn’t present.

@gauravkghildiyal I can take on this task, at least partially. I was working on it before, but as mentioned here, it had conflicts with your previous PR. I can add those changes now that the PR is merged.

Opened a draft PR: #2825 but this does not address the issue mentioned here. Should I add that in the same PR or move to a different one? Because the current PR is already big.

@pottekkat -- Thanks, yes I remember our discussion. Yep please limit the scope of your current PR to what you originally intended. The other cleanups/improvements we can tackle separately.

[hgupta12]

Hey, I would like to work on the gwctl get backends command.

[Devaansh-Kumar]

@gauravkghildiyal I would like to take up gwctl describe policycrds command, could you create an issue for it?

[jongwooo]

Hey, I would like to work on the gwctl get backends command.

Hi @hgupta12, Thank you for your comment. I've already been assigned this issue in #2761 (comment), so if you don't mind, could you please choose another one?

[jongwooo]

I'd like to work on Support wide output format for get commands (-o wide).

[deszhou]

Hey, I would like to work on Add label filtering (-l) for get commands and Add label filtering (-l) for describe commands

[deszhou]

I would like to work on Add label filtering (- l) for get namespaces, could you help me create an issue for it?@gauravkghildiyal

[tdn21]

@gauravkghildiyal I would like to work on Expand output for gwctl describe httproutes, could you please help me create an issue for it?
Thank you! 🙇

[gauravkghildiyal]

Most of the tasks here have been completed. Some of these should also reach a conclusion with #3244. I'll close this out and open upcoming items separately.

[gauravkghildiyal]

/close

[k8s-ci-robot]

@gauravkghildiyal: Closing this issue.

In response to this:

/close

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.