Skip to content

Commit

Permalink
Align env vars
Browse files Browse the repository at this point in the history
Signed-off-by: Arpad Kiss <arpad.a.kiss@est.tech>
  • Loading branch information
arp-est committed Apr 22, 2024
1 parent c5384a4 commit 5199f54
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,24 @@ You can build the docker container by running:
docker build .
```

# Usage

## Environment config

* `NSM_NAME` - Name of Endpoint
* `NSM_DIAL_TIMEOUT` - timeout to dial NSMgr
* `NSM_REQUEST_TIMEOUT` - timeout to request NSE
* `NSM_CONNECT_TO` - url to connect to
* `NSM_MAX_TOKEN_LIFETIME` - maximum lifetime of tokens
* `NSM_NETWORK_SERVICES` - A list of Network Service Requests
* `NSM_LOG_LEVEL` - Log level
* `NSM_OPEN_TELEMETRY_ENDPOINT` - OpenTelemetry Collector Endpoint
* `NSM_METRICS_EXPORT_INTERVAL` - interval between mertics exports
* `NSM_PORT` - TCP/UDP service port
* `NSM_TARGET_PORT` - TCP/UDP target port
* `NSM_PROTOCOL` - TCP or UDP protocol
* `NSM_SELECTOR` - labels for the load balancer selector labels

# Testing

## Testing Docker container
Expand Down Expand Up @@ -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.
through to the point of running cmd, you will not be able to attach a debugger on port 50000 to the cmd.
2 changes: 1 addition & 1 deletion internal/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ type Config struct {
MaxTokenLifetime time.Duration `default:"10m" desc:"maximum lifetime of tokens" split_words:"true"`
NetworkServices []url.URL `default:"" desc:"A list of Network Service Requests" 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"`

Port uint16 `default:"" desc:"TCP/UDP service port" split_words:"true"`
Expand Down

0 comments on commit 5199f54

Please sign in to comment.