Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 2.52 KB

deploy.md

File metadata and controls

105 lines (72 loc) · 2.52 KB

Deploying Provenance ABCI Listener Plugin

Overview

This document outlines steps to deploy release distributions of the plugin.

Deploy Plugin

Follow the steps below to download, configure and deploy the plugin.

  1. Specify release

    TAG={{ RELEASE_TAG }}

    Release versions can be found here.

  2. Download

    2.1 - Create directories

    mkdir -p $PIO_HOME/plugins

    2.2 - Download plugin

     curl -s https://raw.githubusercontent.com/provenance-io/provenance-abci-listener/main/scripts/deploy.sh | bash -s $TAG

    2.3 - Export plugin

    export COSMOS_SDK_ABCI_V1=$PIO_HOME/plugins/provenance-abci-listener-$TAG/bin/provenance-abci-listener
  3. Configure

    3.1 - Self-managed Kafka and Confluent Schema Registry

    curl -o $PIO_HOME/plugins/application.conf \
      https://raw.githubusercontent.com/provenance-io/provenance-abci-listener/$TAG/src/main/resources/application.conf

    3.1.1 - Edit configuration and SET the following properties

    bootstrap.servers
    schema.registry.url

    3.2 - Confluent Cloud

    curl -o $PIO_HOME/plugins/application.conf \
      https://raw.githubusercontent.com/provenance-io/provenance-abci-listener/$TAG/src/main/resources/ccloud.conf

    3.2.2 - Edit configuration and REPLACE with your ccloud values

    {{ BOOTSTRAP_SERVER }}
    {{ CLOUD_API_KEY }}
    {{ CLOUD_API_SECRET }}
    {{ SR_ENDPOINT }}
    {{ SR_API_KEY }}
    {{ SR_API_SECRET }}

    3.3 Export application config

    export PROVENANCE_ABCI_LISTENER_OPTS="-Dconfig.file=$PIO_HOME/plugins/application.conf"

Configure Node

  1. Enable plugin

    provenanced config set streaming.abci.plugin abci_v1
  2. Enable state change listening

    provenanced config set streaming.abci.keys '["*"]'
    • '["*"]' - captures state changes for all module stores
    • '["metadata", "attribute", "bank", "gov"[,"..."]]' - captures state changes for specific module stores
  3. Start Node

    provenanced start --x-crisis-skip-assert-invariants --log_level=info
    • trace|debug|info|warn|error|fatal|panic - log level options (default is info)