diff --git a/README.md b/README.md index 80fa61b..5493d87 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,22 @@ You can build the docker container by running: docker build . ``` +# Usage + +## Environment config + +* `NSM_LISTEN_ON` - url to listen on. (default: "unix:///listen.on.socket") +* `NSM_NAME` - Name of Network service manager proxy (default: "nsmgr-proxy") +* `NSM_MAX_TOKEN_LIFETIME` - maximum lifetime of tokens (default: "10m") +* `NSM_REGISTRY_SERVER_POLICIES` - paths to files and directories that contain registry server policies (default: "etc/nsm/opa/common/.*.rego,etc/nsm/opa/registry/.*.rego,etc/nsm/opa/server/.*.rego") +* `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_MAP_IP_FILE_PATH` - Path to file that contains map of internal to external IPs (default: "map-ip.yaml") +* `NSM_REGISTRY_PROXY_URL` - URL to registry proxy. All incoming interdomain registry requests will be proxying by the URL +* `NSM_REGISTRY_URL` - URL to registry. All incoming local registry requests will be proxying by the URL +* `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 +88,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 64726be..5bd1c62 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"); @@ -67,7 +69,7 @@ type Config struct { RegistryProxyURL *url.URL `desc:"URL to registry proxy. All incoming interdomain registry requests will be proxying by the URL" split_words:"true"` RegistryURL *url.URL `desc:"URL to registry. All incoming local registry requests will be proxying by the URL" 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"` }