diff --git a/README.md b/README.md index 80fa61b..ac5a7f0 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,17 @@ Testing is run via a Docker container. To run testing run: docker run --privileged --rm $(docker build -q --target test .) ``` +# Usage + +## Environment config + +* `NSM_LISTEN_ON` - url to listen on. +* `NSM_LOG_LEVEL` - Log level +* `NSM_OPEN_TELEMETRY_ENDPOINT` - OpenTelemetry Collector Endpoint +* `NSM_METRICS_EXPORT_INTERVAL` - interval between mertics exports +* `NSM_PREFIX` - CIDR Prefix to allocate CIDR prefixes for clients +* `NSM_CLIENT_PREFIX_LEN` - Default len of clients prefix + # Debugging ## Debugging the tests @@ -72,4 +83,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 e4fd6e1..9afc833 100644 --- a/main.go +++ b/main.go @@ -1,5 +1,7 @@ // Copyright (c) 2022-2023 Cisco and/or its affiliates. // +// Copyright (c) 2024 OpenInfra Foundation Europe. All rights reserved. +// // SPDX-License-Identifier: Apache-2.0 // // Licensed under the Apache License, Version 2.0 (the "License"); @@ -45,7 +47,7 @@ import ( type Config struct { ListenOn []url.URL `default:"unix:///listen.on.socket" desc:"url to listen on." split_words:"true"` LogLevel string `default:"INFO" desc:"Log level" 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"` Prefix string `default:"169.254.0.0/16" desc:"CIDR Prefix to allocate CIDR prefixes for clients" split_words:"true"` ClientPrefixLen uint8 `default:"24" desc:"Default len of clients prefix" split_words:"true"`