From 7652f904d4feeb865c58e7a2d9eb48daf201eabe Mon Sep 17 00:00:00 2001 From: Arpad Kiss Date: Mon, 22 Apr 2024 16:20:08 +0200 Subject: [PATCH 1/2] Align env vars Signed-off-by: Arpad Kiss --- README.md | 19 ++++++++++++++++++- main.go | 4 ++-- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 80fa61b..9cd8e7d 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,23 @@ You can build the docker container by running: docker build . ``` +# Usage + +## Environment config + +* `NSM_NAME` - Name of Firewall Server (default: "firewall-server") +* `NSM_LISTEN_ON` - listen on socket (default: "listen.on.sock") +* `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_NAME` - Name of providing service +* `NSM_LABELS` - Endpoint labels +* `NSM_ACL_CONFIG_PATH` - Path to ACL config file (default: "/etc/firewall/config.yaml") +* `NSM_ACL_CONFIG` - configured acl rules +* `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 +89,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 d53e9ec..7117ede 100644 --- a/main.go +++ b/main.go @@ -91,9 +91,9 @@ type Config struct { ServiceName string `default:"" desc:"Name of providing service" split_words:"true"` Labels map[string]string `default:"" desc:"Endpoint labels"` ACLConfigPath string `default:"/etc/firewall/config.yaml" desc:"Path to ACL config file" split_words:"true"` - ACLConfig []acl_types.ACLRule `default:"" desc:"configured acl rules"` + ACLConfig []acl_types.ACLRule `default:"" desc:"configured acl rules" 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 e04b134b4cb3d3779c688912fa2bf97ca7b90a80 Mon Sep 17 00:00:00 2001 From: Arpad Kiss Date: Wed, 24 Apr 2024 16:33:54 +0200 Subject: [PATCH 2/2] Update license Signed-off-by: Arpad Kiss --- main.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/main.go b/main.go index 7117ede..f21dce3 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");