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

Contradicting kubectl apply documentation #22465

Closed
SebStrug opened this issue Jul 10, 2020 · 2 comments
Closed

Contradicting kubectl apply documentation #22465

SebStrug opened this issue Jul 10, 2020 · 2 comments

Comments

@SebStrug
Copy link

Contradicting kubectl apply documentation

Problem:
The kubectl apply documentation here:
https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#apply

Says that the -k flag should be used for a directory.

However the documentation here for the kubectl overview:
https://kubernetes.io/docs/concepts/configuration/overview/#using-kubectl

Suggests using the -f flag for a directory. Why is there a discrepancy?

Proposed Solution:
If -f is best practice for a limited use case this should be made clear in the documentation. Separately it should be clear that -f can be used for a directory, not just for a file.

Pages to Update:
One of the following pages should be updated or clarified:
https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#apply
or
https://kubernetes.io/docs/concepts/configuration/overview/#using-kubectl

@sftim
Copy link
Contributor

sftim commented Jul 11, 2020

@SebStrug I recommend filing this issue against kubectl to clarify that -f can take a file, a manifest URL, or a local directory containing manifests. That change will cascade into the page at https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#apply

You can file that report using https://github.com/kubernetes/kubectl/issues/new?labels=kind%2Fbug&template=bug-report.md and then close this issue, referencing the URL of the replacement issue you logged.

@SebStrug
Copy link
Author

Thank you @sftim
I have filed the issue here: kubernetes/kubectl#896 , and will close issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants