doc: fixes markdown in hostnet policy troubleshooting #13146
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jed Salazar jed@isovalent.com
maintainer-s-little-helper
bot
added
the
dont-merge/needs-release-note-label
joestringer
added
needs-backport/1.8
release-note/misc
maintainer-s-little-helper
bot
removed
the
dont-merge/needs-release-note-label
joestringer
requested changes
Sep 10, 2020
Documentation/policy/language.rst
Outdated
| @@ -1124,7 +1124,7 @@ is labeled correctly in your environment. In the example configuration, you can | |||
| run ``kubectl get nodes -o wide|grep type=ingress-worker`` to verify labels | |||
| match the policy. | |||
|
|
|||
| You can verify the policy was properly parsed and applied by ``exec``ing into | |||
| You can verify the policy was applied by running ``kubectl exec`` in | |||
There was a problem hiding this comment.
This new wording can be read as "run kubectl inside the cilium agent pod", which doesn't make sense since kubectl isn't available there. Is it important for us to even mention execing or pods here or just say "Run cilium policy get..."?
If we think this should still be here, maybe we can clarify the wording a bit more, such as:
Suggested change
| You can verify the policy was applied by running ``kubectl exec`` in | |
| You can verify the policy was applied by running ``kubectl exec -n $CILIUM_NAMESPACE cilium-xxxx cilium policy get`` for the cilium pod ... |
There was a problem hiding this comment.
I changed the wording to be more clear per your suggestion but I'm open to making further changes. I was intending to assume no prior knowledge so I included the exec command in full in your example. Let me know if I should revert to something simpler.
Signed-off-by: Jed Salazar jed@isovalent.com
jedsalazar
changed the title
qmonnet
approved these changes
Sep 22, 2020
joestringer
approved these changes
Sep 30, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Jed Salazar jed@isovalent.com