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.

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

Test envcheck. #625

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ jobs:
shellcheck:
uses: networkservicemesh/.github/.github/workflows/shellcheck.yaml@main

check-env:
uses: networkservicemesh/.github/.github/workflows/env-check.yaml@main
with:
prefix: "NSM_"

golangci-lint:
uses: networkservicemesh/.github/.github/workflows/golangci-lint.yaml@main

Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This README will provide directions for building, testing, and debugging that co
* NSM_MAX_TOKEN_LIFETIME - A token lifetime duration (default 24h)
* NSM_LABELS - A list of client labels with format key1=val1,key2=val2, will be used a primary list for network services
* NSM_MECHANISM - Default Mechanism to use, supported values "kernel", "vfio"
* NSM_NETWORK_SERVICES - A list of Network Service Requests URLs with inner format
* NSM_NETWORK_SERVICES - A list of Network Service Requests URLs with inner format
- \[kernel://]nsName\[@domainName]/interfaceName?\[label1=value1\*(&labelN=valueN)]
- \[vfio://]nsName\[@domainName]?\[label1=value1\*(&labelN=valueN)]
- nsName - a Network service name requested
Expand All @@ -37,7 +37,15 @@ This README will provide directions for building, testing, and debugging that co
- **vfio** mechanism
- **l2-controller** network service
- **{ sriovToken: "l2.domain/1G" }** request parameters

* NSM_AWARENESS_GROUPS - Awareness groups for mutually aware NSEs
* NSM_LIVENESSCHECKENABLED - Dataplane liveness check enabled/disabled
* NSM_LIVENESSCHECKINTERVAL - Dataplane liveness check interval
* NSM_LIVENESSCHECKTIMEOUT - Dataplane liveness check timeout
* NSM_LOCALDNSSERVERADDRESS - Default address for local DNS server
* NSM_LOCALDNSSERVERENABLED - Local DNS Server enabled/disabled
Comment on lines +41 to +45
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I can see, we also missed split_words:"true" in some environment names. 

I think it can also be improved and updated.

Then, for example, instead of NSM_LIVENESSCHECKENABLED we will use NSM_LIVENESS_CHECK_ENABLED that looks clearer.

* NSM_LOG_LEVEL - Log level
* NSM_METRICS_EXPORT_INTERVAL - Interval between mertics exports
* NSM_OPENTELEMETRYENDPOINT - OpenTelemetry Collector Endpoint

# Build

Expand Down
Loading