ARO-RP/docs/prepare-your-dev-environment.md

Prepare Your Development Environment

This document goes through the development dependencies one requires in order to build the RP code.

Software Required

1. Install Go 1.17 or later, if you haven't already.

2. Configure GOPATH as an OS environment variable in your shell (a requirement of some dependencies for make generate). If you want to keep the default path, you can add something like GOPATH=$(go env GOPATH) to your shell's profile/RC file.

3. Install Python 3.6+, if you haven't already. You will also need python-setuptools installed, if you don't have it installed already.

4. Install the az client, if you haven't already.

5. Install OpenVPN if it is not already installed

6. Install the relevant packages required for your OS defined below.

7. Install Podman and podman-docker if you haven't already, used for building container images.

8. Run for az acr login compatability

   sudo touch /etc/containers/nodocker
   

9. Install golangci-lint and yamllint (optional but your code is required to comply to pass the CI)

Fedora Packages

1. Install the gpgme-devel, libassuan-devel, and openssl packages.

   sudo dnf install -y gpgme-devel libassuan-devel openssl

2. Install Docker 17.05+ or later, used as an alternative to podman.

Debian Packages

Install the libgpgme-dev package.

MacOS Packages

1. We are open to developers on MacOS working on this repository. We are asking MacOS users to setup GNU utils on their machines.

   We are aiming to limit the amount of shell scripting, etc. in the repository, installing the GNU utils on MacOS will minimise the chances of unexpected differences in command line flags, usages, etc., and make it easier for everyone to ensure compatibility down the line.

   Install the following packages on MacOS:

   # GNU Utils
   brew install coreutils findutils gnu-tar grep
   
   # Install envsubst (provided with gettext)
   brew install gettext
   brew link gettext
   
   # Install gpgme
   brew install gpgme
   

2. Modify your ~/.zshrc (or ~/.bashrc for Bash): this prepends PATH with GNU Utils paths;

   echo "export PATH=$(find $(brew --prefix)/opt -type d -follow -name gnubin -print | paste -s -d ':' -):\$PATH" >> ~/.zshrc
   

3. Add the following into your ~/.zshrc/~/.bashrc file:

   export LDFLAGS="-L$(brew --prefix)/lib"
   export CFLAGS="-I$(brew --prefix)/include"
   export CGO_LDFLAGS=$LDFLAGS
   export CGO_CFLAGS=$CFLAGS
   

Getting Started

1. Login to Azure:

   az login
   

2. Clone the repository to your local machine:

   go get -u github.com/Azure/ARO-RP/...
   

   Alternatively you can also use:

   git clone https://github.com/Azure/ARO-RP.git $GOPATH/src/github.com/Azure/ARO-RP
   

3. Go to project:

   cd ${GOPATH:-$HOME/go}/src/github.com/Azure/ARO-RP