Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align env vars #223

Merged
merged 1 commit into from
May 14, 2024
Merged

Align env vars #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@ This repo contains 'nse-remote-vlan' an NSE application for Network Service Mesh

`nse-remote-vlan` accept following environment variables:

* NSM_NAME Name of the endpoint
* NSM_CONNECT_TO An URL of registry service to connect to
* NSM_MAX_TOKEN_LIFETIME Maximum lifetime of tokens
* NSM_CIDR_PREFIX CIDR Prefix to assign IPs from
* NSM_IPV6_PREFIX Ipv6 Prefix for dual-stack
* NSM_REGISTER_SERVICE if true then registers network service on startup
* NSM_LISTEN_ON tcp:// url to be listen on. It will be used as public to register NSM
* NSM_SERVICES List of supported services
* `NSM_NAME` - Name of the endpoint (default: "vlan-server")
* `NSM_CONNECT_TO` - url of registry service to connect to (default: "nsm-registry-svc:5002")
* `NSM_MAX_TOKEN_LIFETIME` - maximum lifetime of tokens (default: "24h")
* `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_CIDR_PREFIX` - CIDR Prefix to assign IPs (IPv4 and/or IPv6) from (default: "169.254.0.0/16")
* `NSM_REGISTER_SERVICE` - if true then registers network service on startup (default: "true")
* `NSM_LISTEN_ON` - tcp:// url to be listen on. It will be used as public to register NSM (default: "tcp://:5003")
* `NSM_OPEN_TELEMETRY_ENDPOINT` - OpenTelemetry Collector Endpoint (default: "otel-collector.observability.svc.cluster.local:4317")
* `NSM_METRICS_EXPORT_INTERVAL` - interval between metrics exports (default: "10s")
* `NSM_LOG_LEVEL` - Log level (default: "INFO")
* `NSM_SERVICES` - list of supported services

## Build

Expand Down Expand Up @@ -94,4 +97,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.
4 changes: 2 additions & 2 deletions internal/pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ type Config struct {
CidrPrefix cidr.Groups `default:"169.254.0.0/16" desc:"CIDR Prefix to assign IPs (IPv4 and/or IPv6) from" split_words:"true"`
RegisterService bool `default:"true" desc:"if true then registers network service on startup" split_words:"true"`
ListenOn url.URL `default:"tcp://:5003" desc:"tcp:// url to be listen on. It will be used as public to register NSM" split_words:"true"`
OpenTelemetryEndpoint string `default:"otel-collector.observability.svc.cluster.local:4317" desc:"OpenTelemetry Collector Endpoint"`
MetricsExportInterval time.Duration `default:"10s" desc:"interval between mertics exports" split_words:"true"`
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 metrics exports" split_words:"true"`
LogLevel string `default:"INFO" desc:"Log level" split_words:"true"`
Services []ServiceConfig `default:"" desc:"list of supported services"`
}
Expand Down
Loading