From f8f5a485c2e71901c30b1ae3d96cb224fa244d9a Mon Sep 17 00:00:00 2001 From: Arpad Kiss Date: Tue, 23 Apr 2024 11:40:28 +0200 Subject: [PATCH] Align env vars Signed-off-by: Arpad Kiss --- README.md | 21 ++++++++++++--------- internal/pkg/config/config.go | 4 ++-- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index da55993..e202e00 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,17 @@ This repo contains 'nse-remote-vlan' an NSE application for Network Service Mesh `nse-remote-vlan` accept following environment variables: -* NSM_NAME Name of the endpoint -* NSM_CONNECT_TO An URL of registry service to connect to -* NSM_MAX_TOKEN_LIFETIME Maximum lifetime of tokens -* NSM_CIDR_PREFIX CIDR Prefix to assign IPs from -* NSM_IPV6_PREFIX Ipv6 Prefix for dual-stack -* NSM_REGISTER_SERVICE if true then registers network service on startup -* NSM_LISTEN_ON tcp:// url to be listen on. It will be used as public to register NSM -* NSM_SERVICES List of supported services +* `NSM_NAME` - Name of the endpoint (default: "vlan-server") +* `NSM_CONNECT_TO` - url of registry service to connect to (default: "nsm-registry-svc:5002") +* `NSM_MAX_TOKEN_LIFETIME` - maximum lifetime of tokens (default: "24h") +* `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_CIDR_PREFIX` - CIDR Prefix to assign IPs (IPv4 and/or IPv6) from (default: "169.254.0.0/16") +* `NSM_REGISTER_SERVICE` - if true then registers network service on startup (default: "true") +* `NSM_LISTEN_ON` - tcp:// url to be listen on. It will be used as public to register NSM (default: "tcp://:5003") +* `NSM_OPEN_TELEMETRY_ENDPOINT` - OpenTelemetry Collector Endpoint (default: "otel-collector.observability.svc.cluster.local:4317") +* `NSM_METRICS_EXPORT_INTERVAL` - interval between metrics exports (default: "10s") +* `NSM_LOG_LEVEL` - Log level (default: "INFO") +* `NSM_SERVICES` - list of supported services ## Build @@ -94,4 +97,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/internal/pkg/config/config.go b/internal/pkg/config/config.go index 54c3bea..4f11783 100644 --- a/internal/pkg/config/config.go +++ b/internal/pkg/config/config.go @@ -49,8 +49,8 @@ type Config struct { CidrPrefix cidr.Groups `default:"169.254.0.0/16" desc:"CIDR Prefix to assign IPs (IPv4 and/or IPv6) from" split_words:"true"` RegisterService bool `default:"true" desc:"if true then registers network service on startup" split_words:"true"` ListenOn url.URL `default:"tcp://:5003" desc:"tcp:// url to be listen on. It will be used as public to register NSM" split_words:"true"` - OpenTelemetryEndpoint string `default:"otel-collector.observability.svc.cluster.local:4317" desc:"OpenTelemetry Collector Endpoint"` - MetricsExportInterval time.Duration `default:"10s" desc:"interval between mertics exports" split_words:"true"` + 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 metrics exports" split_words:"true"` LogLevel string `default:"INFO" desc:"Log level" split_words:"true"` Services []ServiceConfig `default:"" desc:"list of supported services"` }