Env Setup

These instructions are only for those that wish to work on the OPS codebase itself otherwise you should consult getting_started.

Supported Operating Systems

Currently Ops support various forms of linux operating systems.

  • MacOS

  • Debian

  • Ubuntu

  • Fedora

  • Centos

  • Windows

Install Prerequisites

If you plan on installing Ops using the install script vs source code, you only need to install QEMU. All other prerequisite installs can be skipped on this page.

Install QEMU

Ensure that you install a version of QEMU that is equal to or greater than version 7. NanoVMs will support older versions of qemu for organizations with support contracts, however, most developers will want to use newer versions of qemu to take advantage of the latest features.

MacOS (homebrew)

If you're running on a Mac, you do need to install QEMU. The easiest way to install QEMU is via homebrew.

$ brew install qemu

For alternate ways of installing QEMU, see their website.

Debian / Ubuntu (apt-get)

  1. To install QEMU, run the following command...

$ sudo apt-get install qemu-kvm qemu-utils

Fedora (dnf/yum)

  1. To install qemu, run the following command...

$ sudo dnf update
$ sudo dnf install qemu-kvm qemu-img

Or...

$ sudo yum update
$ sudo yum install qemu-kvm qemu-img

Install Make

You'll also need to install the make command line tool. Various Linux distributions have different methods for doing so.

MacOS

  1. To install make, run the following command line command...

$ xcode-select --install

Debian / Ubuntu (apt-get)

  1. To install make, run the following command...

$ sudo apt-get install build-essential

  1. Check that make is properly installed by running the following command...

$ make --version

Fedora (dnf/yum)

  1. To install make, run the following command...

$ sudo dnf update
$ sudo dnf groupinstall "Development Tools"

Or...

$ sudo yum update
$ sudo yum groupinstall "Development Tools"

  1. Check that make is properly installed by running the following command...

$ make --version

Install Git

First we need to make sure you have git installed. You can find the official git installation instructions here.

MacOS (homebrew)

  1. To install git, run the following command. Make sure you have homebrew installed first.

$ brew install git

Debian / Ubuntu (apt-get)

  1. To install git on a Debian or Ubuntu instance, run the following command...

$ sudo apt-get update
$ sudo apt-get install git

  1. Next verify that git is installed by running the following command...

$ git --version
git version 2.18.0

  1. Configure your git username and email address. These details will be associated with any commit that may be made.

$ git config --global user.name "Emma Paris"
$ git config --global user.email "eparis@atlassian.com"

Fedora (dnf/yum)

  1. To install git on a Fedora instance, run the following command...

$ sudo dnf install git

Or...

$ sudo yum install git

  1. Next verify that git is installed by running the following command...

$ git --version
git version 2.18.0

  1. Configure your git username and email address. These details will be associated with any commit that may be made.

$ git config --global user.name "Emma Paris"
$ git config --global user.email "eparis@atlassian.com"

Build from Source

Debian / Ubuntu

  1. There are a few dependencies that are needed to build git from source on Debian / Ubuntu. You can install them with the following command...

$ sudo apt-get update
$ sudo apt-get install libcurl4-gnutls-dev libexpat1-dev gettext libz-dev libssl-dev asciidoc xmlto docbook2x

  1. To get the git source code, download and extract it.

  2. Use the make command to build and install git.

$ make all doc info prefix=/usr
$ sudo make install install-doc install-html install-info install-man prefix=/usr

Fedora

  1. There are a few dependencies that are needed to build git from source on Fedora. You can install them with the following command...

$ sudo dnf install curl-devel expat-devel gettext-devel openssl-devel perl-devel zlib-devel asciidoc xmlto docbook2X

For installing via yum, you need to install the Extra Packages for Enterprise Linux (EPEL) repository first:

$ sudo yum install epel-release
$ sudo yum install curl-devel expat-devel gettext-devel openssl-devel perl-devel zlib-devel asciidoc xmlto docbook2X

  1. Symlink docbook2X to the filename that git build expects...

$ sudo ln -s /usr/bin/db2x_docbook2texi /usr/bin/docbook2x-texi

  1. To get the git source code, download and extract it.

  2. Use the make command to build and install git.

$ make all doc info prefix=/usr
$ sudo make install install-doc install-html install-man prefix=/usr

Install Go

It is a requirement to have go installed on your system. To do so, follow the documentation below. ops requires that the minimum version of go that you install is v1.19.

Build from Source

  1. First pull the source and extract it.

$ curl -O https://storage.googleapis.com/golang/go1.11.2.linux-amd64.tar.gz
$ tar -xvf go1.11.2.linux-amd64.tar.gz
$ sudo mv go /usr/local

  1. Next, we need to setup your Go path. Open up the following file with your editor of choice.

$ nano ~/.profile
Add the following lines...
export GOPATH=$HOME/go
export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin
Once the file is edited, source it to load the new environment variables.
$ source ~/.profile

  1. Now that go is installed, let's check and make sure it is working properly.

$ go version

It is important to note that building ops can require more than 0.5 gig of ram. OPS can currently run applications under this limit but building ops requires at least this much.

Next Steps

Now that we have the prerequisites installed, the next step is to install Ops. Go to the installation instructions.

PreviousVisual Studio Code ExtensionNextInstall from Source

Last updated