Installation

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

Binary

Binary Installation

Download

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

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

Optional

The use of flags is optional.

Install Script (Linux and macOS)

To install the latest release, run:

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

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

export PATH=$PATH:~/bin

To install a specific version to a custom location:

curl -sSfL https://raw.githubusercontent.com/stakewise/v3-operator/master/scripts/install.sh | sh -s -- -b <custom_location> vX.X.X

Run commands with:

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

Docker Image

Docker Installation

Pull Official Image

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

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:v4.0.0 .

Run Commands

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

Optional

The use of flags is optional.

Source Files

Source Installation

Requirements

• Python 3.10+ ↗
• Poetry ↗

Setup

git clone https://github.com/stakewise/v3-operator.git
cd v3-operator
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

Optional

The use of flags is optional.

Next Steps

Once installed, continue with Validator Keys ↗.