diff --git a/README.md b/README.md index 80fa61b..f136d54 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,21 @@ You can build the docker container by running: docker build . ``` +# Usage + +## Environment config + +* `NSM_NAME` - Name of the client +* `NSM_DIAL_TIMEOUT` - timeout to dial NSMgr +* `NSM_REQUEST_TIMEOUT` - timeout to request NSE +* `NSM_CONNECT_TO` - url to connect to +* `NSM_MAX_TOKEN_LIFETIME` - maximum lifetime of tokens +* `NSM_NETWORK_SERVICES` - A list of Network Service Requests +* `NSM_AWARENESS_GROUPS` - Awareness groups for mutually aware NSEs +* `NSM_LOG_LEVEL` - Log level +* `NSM_OPEN_TELEMETRY_ENDPOINT` - OpenTelemetry Collector Endpoint +* `NSM_METRICS_EXPORT_INTERVAL` - interval between mertics exports + # Testing ## Testing Docker container @@ -72,4 +87,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/config/config.go b/internal/config/config.go index 5ad9a64..48e8749 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -2,6 +2,8 @@ // // Copyright (c) 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"); @@ -36,6 +38,6 @@ type Config struct { NetworkServices []url.URL `default:"" desc:"A list of Network Service Requests" split_words:"true"` AwarenessGroups awarenessgroups.Decoder `defailt:"" desc:"Awareness groups for mutually aware NSEs" 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"` }