This document goes through the development dependencies one requires in order to build the RP code.
-
Install Go 1.18 or later, if you haven't already.
- After downloading follow the Install instructions, replacing the tar archive with your download.
- Append
export PATH="${PATH}:/usr/local/go/bin"
to your shell's profile file.
-
Configure
GOPATH
as an OS environment variable in your shell (a requirement of some dependencies formake generate
). If you want to keep the default path, you can add something likeGOPATH=$(go env GOPATH)
to your shell's profile/RC file. -
Install Python 3.6-3.10, if you haven't already. You will also need
python-setuptools
installed, if you don't have it installed already. Python versions earlier than 3.6 or later than 3.10 are not supported as of now. -
Install the az client, if you haven't already.
Depending on the default version of Python available on your system, it may be convenient to set up the above within a virtual env. You can do so by running the
make pyenv
Makefile target within this repository. Ensure that yourpython3
command points to a valid version of Python in the above range, e.g. 3.10, when running the command. You can then install the Azure CLI via Pip:pip install azure-cli
. -
Install OpenVPN if it is not already installed
-
Install the relevant packages required for your OS defined below.
-
Install Podman and podman-docker if you haven't already. Podman is used for building container images and running the installer.
-
Podman needs to be running in daemon mode when running the RP locally.
On Linux, you can set this up to automatically start via socket activation with::
```bash systemctl --user enable podman.socket ```
If you're using podman-machine, you will need to export the socket, for example::
```bash export ARO_PODMAN_SOCKET=unix:///$HOME/.local/share/containers/podman/machine/qemu/podman.sock ```
-
-
Run for
az acr login
compatabilitysudo touch /etc/containers/nodocker
-
Install golangci-lint and yamllint (optional but your code is required to comply to pass the CI)
- Install the
gpgme-devel
,libassuan-devel
, andopenssl
packages.sudo dnf install -y gpgme-devel libassuan-devel openssl podman
NOTE:: If using RHEL, register the system with
subscription-manager register
, and then enable the CodeReady Linux Builder repository to install *-devel packages. For other packages not in the base repositories, such as OpenVPN, you can enable the EPEL repository to install them.
Install the libgpgme-dev
package.
-
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 # Install diffutils to avoid errors during test runs brew install diffutils
-
Modify your
~/.zshrc
(or~/.bashrc
for Bash): this prependsPATH
with GNU Utils paths;echo "export PATH=$(find $(brew --prefix)/opt -type d -follow -name gnubin -print | paste -s -d ':' -):\$PATH" >> ~/.zshrc
-
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
-
Login to Azure:
az login
-
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
-
Go to project:
cd ${GOPATH:-$HOME/go}/src/github.com/Azure/ARO-RP