From 6bec96d33a431b5d755b9ea2557e1cc6fe7501f1 Mon Sep 17 00:00:00 2001 From: Steve Sloka Date: Thu, 19 Apr 2018 20:29:40 -0400 Subject: [PATCH] Add note to docs to describe rules for cluster-name Signed-off-by: Steve Sloka --- docs/kubernetes-discoverer.md | 2 +- docs/openstack-discoverer.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/kubernetes-discoverer.md b/docs/kubernetes-discoverer.md index ac3491cf..906455c4 100644 --- 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 index c2d47d44..f7812d2c 100644 --- 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