Run an Operator

You must complete all steps found on the Prerequisites page before continuing.

Register and Run

Continue using the same path you’ve selected on the Prerequisites page to register and run your operator.

Pull the Docker Image

Install and run the docker daemon if you haven’t already then, pull the latest image from the GitHub Container Registry.

docker pull ghcr.io/predicatelabs/operator:<version>

export ENV_FILE=Path_to_your_env_file
docker run --network host --env-file ${ENV_FILE} \
-v "${REGISTRATION_PRIVATE_KEY_STORE_PATH}:/app/registrationkey.json" \
-v "${PREDICATE_SIGNING_PRIVATE_KEY_STORE_PATH}:/app/signingkey.json" \
ghcr.io/predicatelabs/operator:<version> register \
--registration-private-key-store-path /app/registrationkey.json \
--predicate-signing-private-key-store-path /app/signingkey.json

Remove Registration Key

While we do not load registration keys in the following step, we suggest removing it from your config file before running the operator.

Run the Operator

export ENV_FILE=Path_to_your_env_file
docker run --network host --env-file ${ENV_FILE} -v "${DB_PATH}:/app/data/" \
-v "${PREDICATE_SIGNING_PRIVATE_KEY_STORE_PATH}:/app/signingkey.json" \
ghcr.io/predicatelabs/operator:<version> start \
--db-path /app/data/ \
--predicate-signing-private-key-store-path /app/signingkey.json

Confirm you have registered with the aggregator

Upon successfully starting up, the Predicate Operator should produce logs similar to the following:

    INF Received health check from aggregator namespace=operator
    INF operator registration successful

To view additional configuration options: docker run ghcr.io/predicatelabs/operator:latest --help

Pull the Docker Image

Install and run the docker daemon if you haven’t already then, pull the latest image from the GitHub Container Registry.

docker pull ghcr.io/predicatelabs/operator:<version>

export ENV_FILE=Path_to_your_env_file
docker run --network host --env-file ${ENV_FILE} \
-v "${REGISTRATION_PRIVATE_KEY_STORE_PATH}:/app/registrationkey.json" \
-v "${PREDICATE_SIGNING_PRIVATE_KEY_STORE_PATH}:/app/signingkey.json" \
ghcr.io/predicatelabs/operator:<version> register \
--registration-private-key-store-path /app/registrationkey.json \
--predicate-signing-private-key-store-path /app/signingkey.json

Remove Registration Key

While we do not load registration keys in the following step, we suggest removing it from your config file before running the operator.

Run the Operator

export ENV_FILE=Path_to_your_env_file
docker run --network host --env-file ${ENV_FILE} -v "${DB_PATH}:/app/data/" \
-v "${PREDICATE_SIGNING_PRIVATE_KEY_STORE_PATH}:/app/signingkey.json" \
ghcr.io/predicatelabs/operator:<version> start \
--db-path /app/data/ \
--predicate-signing-private-key-store-path /app/signingkey.json

Confirm you have registered with the aggregator

Upon successfully starting up, the Predicate Operator should produce logs similar to the following:

    INF Received health check from aggregator namespace=operator
    INF operator registration successful

To view additional configuration options: docker run ghcr.io/predicatelabs/operator:latest --help

Determine your system architecture

Example: darwin/arm64 for macOS on ARM, linux/amd64 for Linux on AMD64.

Navigate to the './predicate-operator/binaries' Directory

This directory contains binaries for supported architectures.

You should have two keys; registration and signing. In this step use your signing key We will register your operator to the address of the signing key you created for Predicate. Note: this should be a different key from your registration key.

export CONFIG_PATH="your_path_to_config_file"
./operator-{RELEASE_VERSION}-{ARCH} register \
--config ${CONFIG_PATH} \

Remove Registration Key

While we do not load registration keys in the following step, we suggest removing it from your config file before running the operator.

Run the Operator

Start via signing key string:

export CONFIG_PATH="your_path_to_config_file"
./operator-{RELEASE_VERSION}-{ARCH} start \
--config ${CONFIG_PATH} \

Confirm you have registered with the aggregator

Upon successfully starting up, the Predicate Operator should produce logs similar to the following:

    INF Received health check from aggregator namespace=operator
    INF operator registration successful

Review Help Documentation Execute the following command, replacing {RELEASE_VERSION} with the latest release version and {ARCH} with your actual architecture: ./operator-{RELEASE_VERSION}-{ARCH} --help

Essentials

For Developers

For Operators

Register and Run

Essentials

For Developers

For Operators

​Register and Run

Register and Run