From 2e06f1c2729d4da030fa07a312d35013df00d278 Mon Sep 17 00:00:00 2001 From: Arpad Kiss Date: Tue, 23 Apr 2024 13:43:19 +0200 Subject: [PATCH] Align env vars Signed-off-by: Arpad Kiss --- README.md | 25 ++++++++++++++++++++++++- main.go | 2 +- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 80fa61b..4ba5994 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,29 @@ You can build the docker container by running: docker build . ``` +# Usage + +## Environment config + +* `NSM_NAME` - Name of vL3 Server (default: "vL3-server") +* `NSM_DIAL_TIMEOUT` - timeout to dial NSMgr (default: "5s") +* `NSM_REQUEST_TIMEOUT` - timeout to request NSE (default: "15s") +* `NSM_LISTEN_ON` - listen on socket (default: "listen.on.sock") +* `NSM_CONNECT_TO` - url to connect to (default: "unix:///var/lib/networkservicemesh/nsm.io.sock") +* `NSM_MAX_TOKEN_LIFETIME` - maximum lifetime of tokens (default: "10m") +* `NSM_REGISTRY_CLIENT_POLICIES` - paths to files and directories that contain registry client policies (default: "etc/nsm/opa/common/.*.rego,etc/nsm/opa/registry/.*.rego,etc/nsm/opa/client/.*.rego") +* `NSM_SERVICE_NAMES` - Name of providing service (default: "vL3") +* `NSM_LABELS` - Endpoint labels +* `NSM_REQUEST_LABELS` - Adds labels to request on requesting vl3 nse +* `NSM_IDLE_TIMEOUT` - timeout for automatic shutdown when there were no requests for specified time. Set 0 to disable auto-shutdown. (default: "0") +* `NSM_REGISTER_SERVICE` - if true then registers network service on startup (default: "true") +* `NSM_UNREGISTER_ITSELF` - if true then NSE unregister itself when it completes working (default: "true") +* `NSM_OPEN_TELEMETRY_ENDPOINT` - OpenTelemetry Collector Endpoint (default: "otel-collector.observability.svc.cluster.local:4317") +* `NSM_METRICS_EXPORT_INTERVAL` - interval between mertics exports (default: "10s") +* `NSM_PREFIX_SERVER_URL` - URL to VL3 IPAM server(s) (default: "vl3-ipam:5006") +* `NSM_DNS_TEMPLATES` - Represents domain naming templates in go-template format. It is using for generating the domain name for each nse/nsc in the vl3 network (default: "{{ index .Labels "podName" }}.{{ .NetworkService }}.") +* `NSM_LOG_LEVEL` - Log level (default: "INFO") + # Testing ## Testing Docker container @@ -72,4 +95,4 @@ docker run --privileged -e DLV_LISTEN_FORWARDER=:50000 -p 40000:40000 -p 50000:5 ``` Please note, the tests **start** the cmd, so until you connect to port 40000 with your debugger and walk the tests -through to the point of running cmd, you will not be able to attach a debugger on port 50000 to the cmd. \ No newline at end of file +through to the point of running cmd, you will not be able to attach a debugger on port 50000 to the cmd. diff --git a/main.go b/main.go index 88d36b2..532c8b7 100644 --- a/main.go +++ b/main.go @@ -111,7 +111,7 @@ type Config struct { IdleTimeout time.Duration `default:"0" desc:"timeout for automatic shutdown when there were no requests for specified time. Set 0 to disable auto-shutdown." split_words:"true"` RegisterService bool `default:"true" desc:"if true then registers network service on startup" split_words:"true"` UnregisterItself bool `default:"true" desc:"if true then NSE unregister itself when it completes working" split_words:"true"` - OpenTelemetryEndpoint string `default:"otel-collector.observability.svc.cluster.local:4317" desc:"OpenTelemetry Collector Endpoint"` + OpenTelemetryEndpoint string `default:"otel-collector.observability.svc.cluster.local:4317" desc:"OpenTelemetry Collector Endpoint" split_words:"true"` MetricsExportInterval time.Duration `default:"10s" desc:"interval between mertics exports" split_words:"true"` PrefixServerURL []url.URL `default:"vl3-ipam:5006" desc:"URL to VL3 IPAM server(s)" split_words:"true"` DNSTemplates []string `default:"{{ index .Labels \"podName\" }}.{{ .NetworkService }}." desc:"Represents domain naming templates in go-template format. It is using for generating the domain name for each nse/nsc in the vl3 network" split_words:"true"`