Skip to content

Commit

Permalink
Merge pull request #514 from Nordix/arpest_update_envs
Browse files Browse the repository at this point in the history
Align env vars
  • Loading branch information
denis-tingaikin authored May 14, 2024
2 parents f2b2ae4 + 503bccf commit 23e84ca
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ This README will provide directions for building, testing, and debugging that co

`cmd-nse-vfio` accept following environment variables:

* NSE_NAME - A string value of network service endpoint name (default "vfio-server")
* NSE_BASE_DIR - A base directory to create a unix socker for listening incoming requests (default "./")
* NSE_CONNECT_TO - A Network service Manager connectTo URL (default "unix:///var/lib/networkservicemesh/nsm.io.sock")
* NSE_MAX_TOKEN_LIFETIME - A token lifetime duration (default 24h)
* NSE_SERVICES - A list of supported Network Services in inner format:
* `NSM_NAME` - A string value of network service endpoint name (default "vfio-server")
* `NSM_BASE_DIR` - A base directory to create a unix socker for listening incoming requests (default "./")
* `NSM_CONNECT_TO` - A Network service Manager connectTo URL (default "unix:///var/lib/networkservicemesh/nsm.io.sock")
* `NSM_MAX_TOKEN_LIFETIME` - A token lifetime duration (default 24h)
* `NSM_SERVICE_NAMES` - A list of supported Network Services in inner format:
Name@Domain: { addr: MACAddr; vlan: VLANTag; labels: Labels; }
MACAddr = xx:xx:xx:xx:xx:xx
Labels = label_1=value_1&label_2=value_2
Expand All @@ -27,6 +27,15 @@ This README will provide directions for building, testing, and debugging that co
- **pingpong** Network Service
- **worker.domain** Network Service domain
- **0a:55:44:33:22:11** MAC address
* `NSM_CIDR_PREFIX` - List of CIDR Prefix to assign IPv4 and IPv6 addresses from (default: "169.254.0.0/16")
* `NSM_LABELS` - Endpoint labels
* `NSM_LOG_LEVEL` - Log level (default: "INFO")
* `NSM_METRICS_EXPORT_INTERVAL` - interval between mertics exports (default: "10s")
* `NSM_OPEN_TELEMETRY_ENDPOINT` - OpenTelemetry Collector Endpoint (default: "otel-collector.observability.svc.cluster.local:4317")
* `NSM_PAYLOAD` - Name of provided service payload (default: "ETHERNET")
* `NSM_REGISTER_SERVICE` - if true then registers network service on startup (default: "true")
* `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")


# Build

Expand Down Expand Up @@ -102,4 +111,4 @@ docker run -e DLV_LISTEN_FORWARDER=:50000 -p 40000:40000 -p 50000:50000 --rm $(d
```

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.
through to the point of running cmd, you will not be able to attach a debugger on port 50000 to the cmd.
4 changes: 3 additions & 1 deletion internal/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down Expand Up @@ -45,7 +47,7 @@ type Config struct {
MaxTokenLifetime time.Duration `default:"10m" desc:"maximum lifetime of tokens" split_words:"true"`
RegistryClientPolicies []string `default:"etc/nsm/opa/common/.*.rego,etc/nsm/opa/registry/.*.rego,etc/nsm/opa/client/.*.rego" desc:"paths to files and directories that contain registry client policies" 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"`
CidrPrefix cidr.Groups `default:"169.254.0.0/16" desc:"List of CIDR Prefix to assign IPv4 and IPv6 addresses from" split_words:"true"`
Labels map[string]string `default:"" desc:"Endpoint labels"`
Expand Down

0 comments on commit 23e84ca

Please sign in to comment.