Add note to docs to describe rules for cluster-name

Signed-off-by: Steve Sloka <[email protected]>
projectcontour · Apr 20, 2018 · 6bec96d · 6bec96d
1 parent ffe5629
commit 6bec96d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/kubernetes-discoverer.md b/docs/kubernetes-discoverer.md
@@ -22,7 +22,7 @@ Arguments are available to customize the discoverer, most have defaults but othe
 | num-threads  | 2  |  Specify number of threads to use when processing queue items
 | gimbal-kubecfg-file  | ""  | Location of kubecfg file for access to Kubernetes cluster hosting Gimbal
 | discover-kubecfg-file | ""  | Location of kubecfg file for access to remote Kubernetes cluster to watch for services / endpoints 
-| cluster-name  | ""  |   Name of cluster scraping for services & endpoints 
+| cluster-name  | ""  |   Name of cluster scraping for services & endpoints (Cannot start or end with a hyphen and must be alpha-numeric)
 | debug | false | Enable debug logging 
 
 ### Credentials

diff --git a/docs/openstack-discoverer.md b/docs/openstack-discoverer.md
@@ -21,7 +21,7 @@ Arguments are available to customize the discoverer, most have defaults but othe
 | version  |  false | Show version, build information and quit  
 | num-threads  | 2  |  Specify number of threads to use when processing queue items
 | gimbal-kubecfg-file  | ""  | Location of kubecfg file for access to Kubernetes cluster hosting Gimbal
-| cluster-name  | ""  |   Name of cluster scraping for services & endpoints 
+| cluster-name  | ""  |   Name of cluster scraping for services & endpoints (Cannot start or end with a hyphen and must be alpha-numeric)
 | debug | false | Enable debug logging 
 | reconciliation-period | 30s | The interval of time between reconciliation loop runs 
 | http-client-timeout | 5s | The HTTP client request timeout