ops
ops copied to clipboard
ops - build and run nanos unikernels
OPS
Ops is a tool for creating and running a Nanos unikernel. It is used to package, create, and run your application as a nanos unikernel instance.
- Installation
- Hello World
- Cloud
- Support
Check out the DOCS.
Installation
Most users should just download the binary from the website:
Binary install
curl https://ops.city/get.sh -sSfL | sh
If you don't like this option you can also download pre-made packages for various systems here and you can also build from source.
Build and Install from source
Building from source is easy if you have used Go before.
This program requires GO Version 1.13.x or greater.
Installing from source follows these general steps:
Install dependencies:
make deps
Build:
make build
macOS notes:
GO111MODULE=on go build -ldflags "-w"
For detailed instructions, please consult the documentation.
Hello World
Before learning more about ops
it is a good idea to see some basic usage
examples. Below are links to simple examples using various programming platforms:
Let's run your first unikernel right now.
Throw this into hi.js:
const http = require('http');
http.createServer((req, res) => {
res.writeHead(200, { 'Content-Type': 'text/plain' });
res.end('Hello World\n');
}).listen(8083, "0.0.0.0");
console.log('Server running at http://127.0.0.1:8083/');
Then you can run it like so:
ops pkg load eyberg/node:v16.5.0 -p 8083 -n -a hi.js
Note: Since the node package is inside the unikernel you do not need to install node locally to use it.
Cloud
Want to push your app out to the cloud? No complex orchestration like K8S is necessary. OPS pushes all the orchestration onto the cloud provider of choice so you don't need to manage anything. Be sure to try this out as the next step after running a hello world locally as it will answer many questions you might have.
You can find many more pre-made packages at the public repo:
Or via the shell:
ops pkg list
You can also upload your own with a free account.
Languages:
Various langauge examples can be found at https://github.com/nanovms/ops-examples. In general https://nanos.org supports any languages and is not language specific.
You can find more examples and tutorial on youtube as well:
https://www.youtube.com/channel/UC3mqDqCVu3moVKzmP2YNmlg
Apple M1/M2 Users
The Apple M1 and M2 are ARM based. OPS is built for users primarily deploying to x86 based servers. While you can certainly run ARM builds with Nanos and OPS be aware that if you are trying to run x86 builds (the default) on ARM based M1s you won't be able to use hardware acceleration for x86.
Build a bootable image
ops build <app>
Package and run
ops run <app>
# or
ops run -p <port> <app>
Using a config file
ops run -p <port> -c <file> <app>
Example config file
OPS config files are plain JSON, below is an example.
{
"Args":["one","two"],
"Dirs":["myapp/static"]
}
Setup networking
New users wishing to play around in a dev environment are encouraged to use the default user-mode networking. Other production users are encouraged to utilize native cloud builds such as Google Cloud which handle networking for you.
Only advanced/power users should use the bridge networking option.
Reporting Bugs
Feel free to open up a pull request. It's helpful to have your OPS version and the release channel you are using.
Also, if it doesn't work on the main release, then you can try the nightly. The main release can tail the nightly by many weeks sometimes.
ops version
If you are using a package, get the package hash:
jq '."gnatsd_1.4.1"' ~/.ops/packages/manifest.json
Pull Requests
If you have an idea for a new feature and it might take longer than a few hours or days to complete, then it's worth opening a feature request ticket to ideate it first before jumping into code. There might be someone already working on the feature or plans to do something entirely different.
Security
Feel free to email security[at]nanovms[dot]com.
Support
If you are having trouble running a particular application please feel free to open an issue and we can take a look. In general we'll only want to support the latest release from a given application/project, however, if you really want/need support for something older there are paid support plans available - contact the folks at https://nanovms.com.