Links

FAQ

Frequently Asked Questions about the NATS Execution Engine

General

Running Workloads

Technical Details

General

What is Nex?

Nex is an open source, lightweight execution engine that runs alongside NATS. Nex nodes are run to form a universal pool in which you can deploy services and functions in JavaScript, WebAssembly, and any language that compiles to native 64-bit Linux binaries.

Where Can I Find Nex?

The code for Nex can be found in the appropriate Synadia repository. It is an open source project that is supported by Synadia, the creators of NATS.

Who Maintains Nex?

The primary maintainers of the Nex code are employees of Synadia, though more maintainers are always welcome.

Is Nex Free?

Yes, all of the code in the Nex repository is free and licensed under the Apache-2.0 license.

Running Workloads

What workload types can I run?

Nex supports two categories of workloads: services and functions. Services are long-lived while functions are short-lived and triggered on demand by some stimulus.
Services can be any statically compiled 64-bit Linux binary and functions can be either a WebAssembly module or a JavaScript exported function. We are exploring possible support for running OCI images as services.

What is a root file system?

Nex uses Firecracker to launch small, very fast and very light weight virtual machines. These machines each run an agent that manages the workload in that machine as well as communications with the Nex node.
The root file system is essentially a snapshot of the operating system disk image that will be used when bringing up the virtual machine. It's like a Docker layer, but much more efficient.

Technical Details

What are namespaces?

A namespace is a unit of multi-tenancy. All workloads are scoped to a namespace. If you deploy the echoservice workload within the default namespace and also deploy it within the sample namespace, they will not be treated the same by Nex. Namespaces are logical groupings and Nex doesn't enforce a hard network boundary between them.

Are my workload configurations secure?

Absolutely! Every request to run a workload is sent to a specific Nex node. This Nex node has a public Xkey that is used to encrypt data, such as environment variables and other sensitive data, sent to that node. Only that node can decrypt data meant for it.
Further, the only entity that is allowed to terminate a workload is the one that started it.

What is the difference between run and devrun?

In short, nex run is meant for production and real deployments while nex devrun is meant for developer iteration loops and testing environments. A regular request to run a workload must contain all of the following:
  • An issuer nkey that counts as the entity certifying the request
  • A publisher xkey that is used as the source of encrypted data
  • A URL indicating the location of the workload that is stored in an object store, in the form of nats://{BUCKET}/{key}.
  • A set of environment variables to be passed to the workload when it is run
  • A fixed and properly formatted workload name
  • A namespace (logical grouping) in which the workload is to be run.
Manually supplying all this information when you're just trying to develop and test on your local machine is cumbersome, so using devrun all you need do is supply a path to the workload binary file (.wasm, .js, ELF binary) and the environment variables, and the nex CLI will take care of managing the rest for you, including uploading your file to an object store automatically.

How does Nex Compare to Kubernetes?

At the most abstract level, both Kubernetes and Nex are workload schedulers. In Kubernetes, there is a kubelet process that runs on each node in your cluster. It handles requests to start and stop pods, which are groups of Docker images. In Nex, there is a nex node process that runs on each node in your cluster. It handles requests to deploy and undeploy workloads, which can be native binaries, JavaScript functions, or WebAssembly modules. While most users interact with a declarative layer in Kubernetes that is managed via autonomous control loops, Nex is a purely imperative system.

Do I run Nex inside Firecracker?

In a word, no. The Nex node process is responsible for spawning Firecracker VMs that contain the Nex agent. As a supervisor of Firecracker processes, the Nex node itself can't be run inside a Firecracker VM. Most of that complexity should be hidden from end users.