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

docs: Document pod/service filter prefix behavior #733

Merged

Conversation

slayer321
Copy link
Contributor

Document pod/service filter prefix behavior

Fixes: #501
Signed-off-by: slayer321 sachin.maurya7666@gmail.com

@slayer321 slayer321 requested review from a team and joamaki and removed request for a team June 3, 2022 10:00
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label PR is blocked until the release note is set label Jun 3, 2022
@kaworu kaworu requested review from rolinh and removed request for joamaki June 3, 2022 10:35
@kaworu kaworu added 📄 area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. ⌨️ area/cli Impacts the command line interface of any command in the repository. release-note/misc This PR makes changes that have no direct user impact. labels Jun 3, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label PR is blocked until the release note is set label Jun 3, 2022
Copy link
Member

@rolinh rolinh left a comment

Choose a reason for hiding this comment

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

According to #501, there are 6 docstrings to fix (--from-pod, --pod, --to-pod and --from-service, --service, --to-service), not just --pod and --service. I also find the description too verbose. I think that something along the line of the following would be enough:

      --from-pod filter         Show all flows originating in the given pod name prefix ([namespace/]<pod-name>). If namespace is not provided, 'default' is used.

cmd/observe/flows.go Outdated Show resolved Hide resolved
@rolinh
Copy link
Member

rolinh commented Jun 8, 2022

Thanks @slayer321. Could you please squash your commits before we merge the PR?

Signed-off-by: slayer321 <sachin.maurya7666@gmail.com>
@slayer321 slayer321 force-pushed the pr/slayer321/prefix-pod-service-name branch from 7d5495f to 7abdb17 Compare June 8, 2022 14:38
@rolinh rolinh merged commit 0c1fdeb into cilium:master Jun 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⌨️ area/cli Impacts the command line interface of any command in the repository. 📄 area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document pod/service filter prefix behavior
3 participants