Installation

The Operator Service can be installed in several ways: as a binary, via Docker, or built from source. Choose your preferred method and follow the instructions below.

Binary

Download

1. Go to the releases page ↗
2. Select the binary file for your node's hardware
3. Download and decompress the file
4. Run commands from withing the v3-operator folder.

Install Script (Linux and macOS)

To install a specific version to a custom location:

curl -sSfL https://raw.githubusercontent.com/stakewise/v3-operator/v3.1.10/scripts/install.sh | sh -s

The binary will be placed in ~/bin. Add it to your PATH:

export PATH=$PATH:~/bin

Run commands with:

operator COMMAND --flagA=123 --flagB=xyz

Note

The use of flags is optional.

Docker Image

Pull Official Image

docker pull europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v3.1.10

Build From Source

Alternatively, build the Docker image locally:

git clone https://github.com/stakewise/v3-operator.git
cd v3-operator
docker build --pull -t europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v3.1.10 .

Run Commands

docker run --rm -ti \
-u $(id -u):$(id -g) \
-v ~/.stakewise/:/data \
europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v3.1.10 \
src/main.py COMMAND \
--flagA=123 \
--flagB=xyz

Note

The use of flags is optional.

Configuration

When operating within Docker, it's necessary to specify the --data-dir variable, such as --data-dir=/data. Ensure the data-dir is mapped to a directory on the host.

The database-dir should also be mapped to a host directory or Docker volume, with write permissions enabled for the directory linked to database-dir. Setting up permissions is not required if using volumes.

Source Files

Requirements

• Python 3.10+ ↗
• Poetry ↗

Setup

git clone https://github.com/stakewise/v3-operator.git
cd v3-operator
git checkout v3.1.10
poetry install --only main

Run Commands

Run commands from within the v3-operator folder using the below format:

PYTHONPATH=. poetry run python src/main.py COMMAND --flagA=123 --flagB=xyz

Note

The use of flags is optional.

Next Steps

Once installed, continue with Prepare Operator →.