Red Hat Bugzilla – Bug 1316157
[DOCS] oc port-forward/exec documentation and cli help use examples with deprecated syntax
Last modified: 2016-07-15 11:12:52 EDT
2. oc help port-forward
Section Number and Name:
Devloper Guide -> Port Forwarding
Describe the issue:
The document and online help both give several examples using the -p option to specify the pod. In 3.2, using the -p option gives a warning message that the flag has been deprecated. The new syntax is:
oc port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] [options]
Suggestions for improvement:
For oc exec, the documentation is right. But cli help also uses -p
Work in progress: https://github.com/openshift/openshift-docs/pull/2286
@Andrew, please review and note the comment from Xingxing Xia regarding CLI help. Thanks!
@ Mike, Please review as well. Thanks.
+1 for me.
The CLI is, paradoxically, maintained by the Web UI team. Added jforrest to the cc:
CLI issue fixed in https://github.com/openshift/origin/pull/9351
@ Ashley Hardin
The doc PR LGTM. Thanks!
@ Fabiano Franz
Tested with oc v1.3.0-alpha.1-379-g662753c, works:
oc port-forward -h
# Listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
oc port-forward mypod 5000 6000
-p, --pod='': Pod name (deprecated)
Seems better to correct `oc exec -h` too (comment 1)? As far as I know, that is the only left sub-command with deprecated '--pod'. Thank you.
Commits pushed to master at https://github.com/openshift/openshift-docs
Bug 1316157, updated outdated syntax instances of
Merge pull request #2286 from ahardin-rh/port-forwarding
Bug 1316157, updated outdated syntax instances of oc port-forward -p
Right, `oc exec` fixed in https://github.com/openshift/origin/pull/9382.
Thanks. Saw the change of `oc exec -h` in devenv-rhel7_4393, looks fine.
Content is now published: