Bug 1740043

Summary: Give an example for file used to enable API federation
Product: OpenShift Container Platform Reporter: Qin Ping <piqin>
Component: FederationAssignee: Aniket Bhat <anbhat>
Status: CLOSED WONTFIX QA Contact: Qin Ping <piqin>
Severity: low Docs Contact:
Priority: unspecified    
Version: 4.2.0CC: anbhat, nagrawal
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: Environment:
Last Closed: 2020-05-06 00:02:51 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 Qin Ping 2019-08-12 07:39:11 UTC
Description of problem:
Give an example for file used to enable API federation

Version-Release number of selected component (if applicable):
kubefedctl version: version.Info{Version:"v4.2.0", GitCommit:"b8ae65cee603cc9c746911debd3dc23b922222d8", GitTreeState:"clean", BuildDate:"2019-08-08T18:18:54Z", GoVersion:"go1.12.6", Compiler:"gc", Platform:"linux/amd64"}

How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:
$ kubefedctl enable -h

		Enables a Kubernetes API type (including a CRD) to be propagated
		to clusters registered with a KubeFed control plane.  A CRD for
		the federated type will be generated and a FederatedTypeConfig will
		be created to configure a sync controller.

		Current context is assumed to be a Kubernetes cluster hosting
		the kubefed control plane. Please use the
		--host-cluster-context flag otherwise.

Usage:
  kubefedctl enable (NAME | -f FILENAME) [flags]

Examples:

		# Enable federation of Deployments
		kubefedctl enable deployments.apps --host-cluster-context=cluster1

		# Enable federation of Deployments identified by name specified in
		# deployment.yaml
		kubefedctl enable -f deployment.yaml




Expected results:
Give an example for deployment.yaml

Additional info:

Comment 1 Maru Newby 2019-08-15 17:32:35 UTC
I think the `-f` flag should simply be removed. It was a convenience for testing and expected to be used by installers that would execute `kubefedctl enable` but that use never materialized.

Comment 2 Aniket Bhat 2019-08-15 17:55:03 UTC
The team thinks that the support for -f should be obsolete. I will create a PR for disabling this in the CLI.