https://github.com/kubeslice/cmd-nsc

https://github.com/kubeslice/cmd-nsc

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kubeslice/cmd-nsc
• Owner: kubeslice
• License: apache-2.0
• Created: 2022-11-21T11:17:35.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T13:55:22.000Z (3 months ago)
• Last Synced: 2024-09-17T12:23:05.161Z (3 months ago)
• Language: Go
• Size: 7.53 MB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# Intro

This repo contains 'cmd-nsc' a client application for Network Service Mesh.

This README will provide directions for building, testing, and debugging that container.

# Usage

`cmd-nsc` accept following environment variables:

* NSM_NAME - A string value of network service client name (default "nsc")

* NSM_CONNECT_TO - A Network service Manager connectTo URL (default "unix:///var/lib/networkservicemesh/nsm.io.sock")

* NSM_DIAL_TIMEOUT - A timeout to dial Network Service Manager (default 5s)

* NSM_REQUEST_TIMEOUT - A timeout to request Network Service Endpoint (default 15s)

* 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 

    - \[kernel://]nsName\[@domainName]/interfaceName?\[label1=value1\*(&labelN=valueN)]

    - \[vfio://]nsName\[@domainName]?\[label1=value1\*(&labelN=valueN)]

        - nsName - a Network service name requested

        - domainName - an interdomain service name

        - interfaceName - a kernel interface name, for kernel mechanism

        - labelN=valueN - pairs of labels will be passed as a part of the request:

            - sriovToken=service.domain/capability - required label for SR-IOV mechanisms

    - Examples:

        - vpn/if-vpn

            - default mechanism

            - **vpn** network service

            - **if-vpn** kernel interface

        - kernel://[email protected]/if-proxy?username=jdoe&password=123456

            - **kernel** mechanism

            - **secure-proxy** network service at **cloud2.com**

            - **if-proxy** kernel interface

            - **{ username: "jdoe", password: "123456" }** request parameters

        - vfio://l2-controller?sriovToken=l2.domain/1G

            - **vfio** mechanism

            - **l2-controller** network service

            - **{ sriovToken: "l2.domain/1G" }** request parameters

        

# Build

## Build nsmgr binary locally

You can build the locally by executing

```bash

go build ./...

```

## Build Docker container

You can build the docker container by running:

```bash

docker build .

```

# Testing

## Testing Docker container

Testing is run via a Docker container.  To run testing run:

```bash

docker run --rm $(docker build -q --target test .)

```

# Debugging

## Debugging the tests

If you wish to debug the test code itself, that can be acheived by running:

```bash

docker run --rm -p 40000:40000 $(docker build -q --target debug .)

```

This will result in the tests running under dlv.  Connecting your debugger to localhost:40000 will allow you to debug.

```bash

-p 40000:40000

```

forwards port 40000 in the container to localhost:40000 where you can attach with your debugger.

```bash

--target debug

```

Runs the debug target, which is just like the test target, but starts tests with dlv listening on port 40000 inside the container.

## Debugging

When you run 'nsc' you will see an early line of output that tells you:

```Setting env variable DLV_LISTEN_FORWARDER to a valid dlv '--listen' value will cause the dlv debugger to execute this binary and listen as directed.```

If you follow those instructions when running the Docker container:

```bash

docker run -e DLV_LISTEN_NSMGR=:50000 -p 50000:50000 --rm $(docker build -q --target test .)

```

```-e DLV_LISTEN_NSMGR=:50000``` tells docker to set the environment variable DLV_LISTEN_NSMGR to :50000 telling

dlv to listen on port 50000.

```-p 50000:50000``` tells docker to forward port 50000 in the container to port 50000 in the host.  From there, you can

just connect dlv using your favorite IDE and debug nsc.

## Debugging the tests and the nsc

```bash

docker run --rm -p 40000:40000 $(docker build -q --target debug .)

```

Please note, the tests **start** the nsmgr, so until you connect to port 40000 with your debugger and walk the tests

through to the point of running nsmgr, you will not be able to attach a debugger on port 50000 to the nsmgr.