Merge pull request #2702 from kasturinarra/fix_resource_sync

📖 Add example on how resource name should be provided for syncing

Author: openshift-merge-robot

docs/content/en/main/concepts/syncer.md

@@ -89,6 +89,15 @@ To sync resources that the KCP server does not have an APIExport to support yet,
 kubectl kcp workload sync <mycluster> --syncer-image <image name> --resources foo.bar -o syncer.yaml
 ```
 
+Make sure to have the resource name in the form of `resourcename.<gvr_of_the_resource>` to be able to
+sync succesfully to the physical cluster.
+
+For example to sync resource `routes` to physical cluster run the command below
+
+```sh
+kubectl kcp workload sync <mycluster> --syncer-image <image name> --resources routes.route.openshift.io -o syncer.yaml
+```
+
 And apply the generated manifests to the physical cluster. The syncer will then import the API schema of foo.bar
 to the workspace of the synctarget, following up with an auto generated kubernetes APIExport/APIBinding in the same workspace.
 You can then create foo.bar in this workspace, or create an APIBinding in another workspace to bind this APIExport.

pkg/cliplugins/workload/plugin/sync.go

@@ -123,7 +123,8 @@ func NewSyncOptions(streams genericclioptions.IOStreams) *SyncOptions {
 func (o *SyncOptions) BindFlags(cmd *cobra.Command) {
 	o.Options.BindFlags(cmd)
 
-	cmd.Flags().StringSliceVar(&o.ResourcesToSync, "resources", o.ResourcesToSync, "Resources to synchronize with kcp.")
+	cmd.Flags().StringSliceVar(&o.ResourcesToSync, "resources", o.ResourcesToSync, "Resources to synchronize with kcp, each resource should be in the format of resourcename.<gvr_of_the_resource>,"+
+		"e.g. to sync routes to physical cluster the resource name should be given as --resource routes.route.openshift.io")
 	cmd.Flags().StringSliceVar(&o.APIExports, "apiexports", o.APIExports,
 		"APIExport to be supported by the syncer, each APIExport should be in the format of <absolute_ref_to_workspace>:<apiexport>, "+
 			"e.g. root:compute:kubernetes is the kubernetes APIExport in root:compute workspace")