Skip to content

Commit

Permalink
Merge branch 'main' into eula
Browse files Browse the repository at this point in the history
  • Loading branch information
@bortok
bortok authored Dec 11, 2023
2 parents 431546a + e1e6c0a commit 512d89c
Show file tree
Hide file tree
Showing 6 changed files with 252 additions and 25 deletions.
2 changes: 1 addition & 1 deletion conformance
Submodule conformance updated 13 files
+10 −43 .github/workflows/cicd.yml
+15 −15 deployments/ixia-c-config.yaml
+6 −6 deployments/k8s/manifests/ixia-c-b2b-eth0.yaml
+49 −62 do.sh
+0 −92 examples/quickstart_config.json
+0 −9 examples/quickstart_control.json
+0 −6 examples/quickstart_metrics.json
+16 −10 examples/quickstart_test.go
+27 −21 examples/test_quickstart.py
+8 −8 go.mod
+13 −276 go.sum
+1 −1 requirements.txt
+10 −10 versions.yaml
52 changes: 35 additions & 17 deletions docs/licensing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ The following License Editions are available for Keysight Elastic Network Genera

| Capability | Community | Developer | Team | System |
|-------------------------------------|----------------------|----------------------|--------------------------------|-------------------------------------|
| Ixia-c Traffic Port Capacity | 4 x 1/10GE | 50GE | 400GE | 800GE |
| Test Concurrency | 1 Seat | 1 Seat | 8 Seats | 16 Seats |
| Protocol Scale | Restricted | Limited | Limited | Unlimited |
| Ixia-c Traffic Port Capacity | 4 x 1/10GE | 50GE | 400GE | 800GE |
| Test Concurrency | 1 Seat | 1 Seat | 8 Seats | 16 Seats |
| Protocol Scale | Restricted | Limited | Limited | Unlimited |
| Requires a valid license | N | Y | Y | Y |
| Includes Ixia-c Software Test Ports | Y | Y | Y | Y |
| Works with UHD400T Hardware | N | N | Y | Y |
| Works with IxOS Hardware | N | N | N | Y |

The **Ixia-c Traffic Port Capacity** is determined as a sum of the configured Ixia-c test port speeds with the possible values of: 100GE, 50GE, 40GE, 25GE, 10GE, and 1GE. The Maximum data plane performance of an Ixia-c port may be less than the configured port speed, depending on the capabilities of the underlying hardware and software drivers.
The **Ixia-c Traffic Port Capacity** is determined as a sum of the configured Ixia-c software test port speeds with the possible values of: 100GE, 50GE, 40GE, 25GE, 10GE, and 1GE. The Maximum data plane performance of an Ixia-c port may be less than the configured port speed, depending on the capabilities of the underlying hardware and software drivers. Doesn't apply to the UHD400T and IxOS hardware.

The **Test seat concurrency** applies to a number of controller instances that are running with a configuration that exceeds the capabilities of the Community Edition.

Expand All @@ -28,49 +28,67 @@ The following License Editions are available for Keysight Elastic Network Genera

## License Server

Keysight uses a license server to manage floating or network shared licenses for its software products. The license server enables licenses to float and not be tied to a specific Elastic Network Generator instance. The Elastic Network Generator controllers must be able to reach the License server.
In order to use capabilities of Elastic Network Generator that require a valid license, you need to deploy a Keysight License Server. Keysight uses the license server to manage floating or network shared licenses for its software products. The license server enables licenses to float and not be tied to a specific Elastic Network Generator instance. The Elastic Network Generator controllers must be able to reach the License server.

In order to use capabilities of Elastic Network Generator that require a valid license, you need to deploy a Keysight License Server. The License Server is a virtual machine and it is distributed as OVA and QCOW2 images (you only need one of them depending on your hypervisor).
### Deployment

* [QCOW2 image](https://storage.googleapis.com/kt-nas-images-cloud-ist/slum-4.2.0-208.2.qcow2), ~6GB
The license server is a virtual machine and it is distributed as OVA and QCOW2 images (you only need one of them depending on your hypervisor).

* [OVA image](https://storage.googleapis.com/kt-nas-images-cloud-ist/slum-4.2.0-208.ova), 5.8GB
* [QCOW2 image](https://storage.googleapis.com/kt-nas-images-cloud-ist/slum-4.2.0-208.2.qcow2), 6GB

To make a decision where to deploy the License Server VM, take into the account the following requirements:

* For VMware ESXi, use the OVA image
* For Linux-based QEMU or KVM, use the QCOW2 image
* 2 vCPU cores
* 4GB of RAM
* 8GB RAM for ESXi, 4GB RAM for QEMU/KVM
* 100GB storage
* 1 vNIC for network connectivity. Note that DHCP is the preferred option, and this is also how the VM is configured to obtain its IP address.

Network connectivity requirements for the License Server VM

1. Internet access from the VM over HTTPS is desirable for online license activation, but not strictly required. Offline activation method is available as well.
2. Access from a user over SSH (TCP/22) for license operations (activation, deactivation, reservation, sync)
3. Access from any `keng-controller` that needs a license during a test run over gRPC (TCP/7443) for license checkout and check-in
2. Access from a user over HTTPS (TCP/443) for license operations (activation, deactivation, reservation, sync).
3. Access from any `keng-controller` that needs a license during a test run over gRPC (TCP/7443) for license checkout and check-in.

Here is an example of how different components communicate with the License Server:

![License Server Connectivity](./res/license-server.drawio.svg)

## Configuring a static IP address
### Configuration

If your network doesn't provide DHCP, you can configure a static IP address for the License Server VM. Access the VM console and go through two-step login process:
* first prompt: `console` (no password)
* second promt: `admin`/`admin`. Run the following commands to configure a static IP address, where `x.x.x.x` is the IP address, `yy` is the prefix length, `z.z.z.z` is the default gateway, `a.a.a.a` and `b.b.b.b` are DNS servers:

* First prompt: `console` (no password)
* Second promt: `admin`/`admin`
* Run the following commands to configure a static IP address, where `x.x.x.x` is the IP address, `yy` is the prefix length, `z.z.z.z` is the default gateway, `a.a.a.a` and `b.b.b.b` are DNS servers:

```Shell
kcos networking ip set mgmt0 x.x.x.x/yy z.z.z.z
kcos networking dns-servers add a.a.a.a b.b.b.b
```

## License Activation
### Activation

You will now be able to activate licenses and use the License Server on your Elastic Network Generator setup. Go to `https://your-license-server-hostname` to access the application. Enter credentials: `admin`/`admin` to login.
Now you shall be able to activate licenses and use the License Server with your Elastic Network Generator environments. Go to `https://your-license-server-hostname` to access the application. Enter credentials: `admin`/`admin` to login.

If you have an activation code, to perform an online activation, click "Activate Licenses", enter the code and click "Activate". For offline mode, choose "Offline Operations" instead.

You can also use a command-line session, via console or SSH, to perform license operations. Run `kcos licensing --help` to see the list of available commands.

## Connecting Elastic Network Generator to the License Server
## Using Licenses

To use the licenses with the Elastic Network Generator, provide the location of the license servers to the controller instances using

```
--license-servers="server1 server2 server3 server4"
```

argument when launching the controller. The argument accepts a space-separated list of hostnames or IP addresses of the License Servers, up to four. The controller will try to connect to the License Servers in the order they are specified in the list. If the first License Server is not available, or doesn't have enough available licenses to run the test, the controller will try to connect to the next one in the list.

An alternative way is to use an environment variable `LICENSE_SERVERS`.

## Additional Information

To connect the Elastic Network Generator controller instance to the License Server, use `--license-servers="server1 server2 server3 server4"` argument when launching the controller. An alternative way is to use an environment variable `LICENSE_SERVERS`. The argument accepts a space-separated list of hostnames or IP addresses of the License Servers, up to four. The controller will try to connect to the License Servers in the order they are specified in the list. If the first License Server is not available, or doesn't have enough available licenses to run the test, the controller will try to connect to the next one in the list.
Please refer to the [Reference Guide](reference/licensing.md) for more information on the license operations.
Loading

0 comments on commit 512d89c

Please sign in to comment.