diff --git a/README.md b/README.md index 80fa61b..b8f780b 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,24 @@ You can build the docker container by running: docker build . ``` +# Usage + +## Environment config + +* `NSM_NAME` - Name of Endpoint (default: "cmd-nsc-vpp") +* `NSM_DIAL_TIMEOUT` - timeout to dial NSMgr (default: "5s") +* `NSM_REQUEST_TIMEOUT` - timeout to request NSE (default: "15s") +* `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_NETWORK_SERVICES` - A list of Network Service Requests +* `NSM_AWARENESS_GROUPS` - Awareness groups for mutually aware NSEs +* `NSM_LOG_LEVEL` - Log level (default: "INFO") +* `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_LIVENESS_CHECK_ENABLED` - Dataplane liveness check enabled/disabled (default: "true") +* `NSM_LIVENESS_CHECK_INTERVAL` - Dataplane liveness check interval (default: "1200ms") +* `NSM_LIVENESS_CHECK_TIMEOUT` - Dataplane liveness check timeout (default: "1s") + # Testing ## Testing Docker container @@ -72,4 +90,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 16e0746..331dddc 100644 --- a/main.go +++ b/main.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"); @@ -76,12 +78,12 @@ 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"` - LivenessCheckEnabled bool `default:"true" desc:"Dataplane liveness check enabled/disabled"` - LivenessCheckInterval time.Duration `default:"1200ms" desc:"Dataplane liveness check interval"` - LivenessCheckTimeout time.Duration `default:"1s" desc:"Dataplane liveness check timeout"` + LivenessCheckEnabled bool `default:"true" desc:"Dataplane liveness check enabled/disabled" split_words:"true"` + LivenessCheckInterval time.Duration `default:"1200ms" desc:"Dataplane liveness check interval" split_words:"true"` + LivenessCheckTimeout time.Duration `default:"1s" desc:"Dataplane liveness check timeout" split_words:"true"` } func main() {