From 3daf52c2ad6a06e3297be91a46bf0a65a861b888 Mon Sep 17 00:00:00 2001 From: Arpad Kiss Date: Mon, 22 Apr 2024 16:23:47 +0200 Subject: [PATCH 1/2] Align env vars Signed-off-by: Arpad Kiss --- README.md | 24 +++++++++++++++++++++++- main.go | 2 +- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 80fa61b..2165344 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,28 @@ You can build the docker container by running: docker build . ``` +# Usage + +## Environment config + +* `NSM_NAME` - Name of ICMP Server (default: "icmp-server") +* `NSM_BASE_DIR` - base directory (default: "./") +* `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 provided services (default: "icmp-responder") +* `NSM_PAYLOAD` - Name of provided service payload (default: "ETHERNET") +* `NSM_LABELS` - Endpoint labels +* `NSM_DNS_CONFIGS` - DNSConfigs represents array of DNSConfig in json format. See at model definition: https://github.com/networkservicemesh/api/blob/main/pkg/api/networkservice/connectioncontext.pb.go#L426-L435 (default: "[]") +* `NSM_CIDR_PREFIX` - List of CIDR Prefix to assign IPv4 and IPv6 addresses from (default: "169.254.0.0/16") +* `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: "false") +* `NSM_PBR_CONFIG_PATH` - Path to policy based routing config file (default: "/etc/policy-based-routing/config.yaml") +* `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") + # Testing ## Testing Docker container @@ -72,4 +94,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 bf3b9bd..a9d1e31 100644 --- a/main.go +++ b/main.go @@ -94,7 +94,7 @@ type Config struct { UnregisterItself bool `default:"false" desc:"if true then NSE unregister itself when it completes working" split_words:"true"` PBRConfigPath string `default:"/etc/policy-based-routing/config.yaml" desc:"Path to policy based routing config file" 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"` } From 27293da3232d02a6b985ffd3dd6f8f351a201b58 Mon Sep 17 00:00:00 2001 From: Arpad Kiss Date: Wed, 24 Apr 2024 16:35:10 +0200 Subject: [PATCH 2/2] Update license Signed-off-by: Arpad Kiss --- main.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/main.go b/main.go index a9d1e31..4085a36 100644 --- a/main.go +++ b/main.go @@ -1,6 +1,9 @@ // Copyright (c) 2020-2023 Doc.ai and/or its affiliates. +// // Copyright (c) 2021-2023 Nordix 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");