Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1409761

Summary:	[DOCS] Missing info about generator in docs
Product:	OpenShift Container Platform	Reporter:	Vladislav Walek <vwalek>
Component:	Documentation	Assignee:	Brandi Munilla <bmcelvee>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Xingxing Xia <xxia>
Severity:	low	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	low
Version:	3.3.0	CC:	aos-bugs, ffranz, jokerman, jvallejo, mmccomas
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:
Clones:	1420165 (view as bug list)		Environment:
Last Closed:	2017-02-22 14:39:28 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Vladislav Walek 2017-01-03 09:40:09 UTC

Document URL: 
https://docs.openshift.com/container-platform/3.3/cli_reference/basic_cli_operations.html#expose

Section Number and Name: 
expose

Describe the issue: 
Missing information about the generator parameter.

Suggestions for improvement:
Default values for generator. Usage when it required or optional. With which parameters it should be executed. 

Additional information: 
Customer reported the issue when trying running the command:
oc expose service server --port=12201 --protocol=UDP --target-port=12201   --name=logstash-ingress --external-ip=192.168.102.201 --generator="route/v1"

It gives error:
cannot use --external-ip with --generator=route/v1
cannot use --protocol with --generator=route/v1
cannot use --target-port with --generator=route/v1.

Comment 1 Xingxing Xia 2017-01-09 10:20:10 UTC

Thanks

Also missing in oc help info:
oc expose -h

Adding Fabiano Franz and Juan Vallejo Orozco in cc list. Because minor, so bug not opened in CLI component. If needed, will open one :)

Comment 2 Brandi Munilla 2017-01-27 21:17:27 UTC

Hi Xingxing and Vladislav, 

I added more context around the generator parameter in the Expose section of the CLI Reference chapter in PR3577[1]. Please take a look when you get a chance. 

Xingxing, 

For the `oc expose -h` command, does that belong in the `oc expose` section of the CLI Reference chapter? If so, would you please provide a brief description that I can include?

Thanks!

[1] https://github.com/openshift/openshift-docs/pull/3577

Comment 3 Xingxing Xia 2017-02-08 02:12:07 UTC

Doc PR LGTM, thanks! Moving to VERIFIED

(In reply to Brandi from comment #2)
> Xingxing, 
> 
> For the `oc expose -h` command, does that belong in the `oc expose` section
> of the CLI Reference chapter? If so, would you please provide a brief
> description that I can include?
I mean to add generator info in the output of `oc expose -h` command. Opened bug 1420165 for it.

Comment 6 openshift-github-bot 2017-02-08 21:28:29 UTC

Commits pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/d348f6f6958bd1369c12d68046a0c1f74fc2787d
Bug 1409761 Added information about the generator parameter

https://github.com/openshift/openshift-docs/commit/7c3ce819565d933b343839eae3730d6444f458eb
Merge pull request #3577 from bmcelvee/BZ1409761

Bug 1409761 Added information about the generator parameter

Comment 7 Brandi Munilla 2017-02-22 14:39:28 UTC

Link to documentation on the Customer Portal: https://access.redhat.com/documentation/en-us/openshift_container_platform/3.4/html-single/cli_reference/#expose