README.md

IoTeX ETL Dataflow

Apache Beam pipeline for moving IoTeX data from Pub/Sub to BigQuery. Deployed in Google Dataflow.

Setting Up

1. Create a GCS bucket used for staging and temp location:

   gcloud config set project <your_gcp_project>
   PROJECT=$(gcloud config get-value project 2> /dev/null)
   ENVIRONMENT_INDEX=0
   BUCKET=${PROJECT}-dataflow-${ENVIRONMENT_INDEX} && echo "${BUCKET}"
   gsutil mb gs://${BUCKET}/

2. Create the errors table:

   bq mk --table --description "IoTeX ETL Streaming Errors" \
    ${PROJECT}:crypto_iotex.errors \
    src/main/resources/errors-schema.json 

3. Copy exampleChainConfig.json to chainConfig.json and update chainConfig.json with your values.

4. Start the Dataflow job in:

   mvn -e -Pdataflow-runner compile exec:java \
   -Dexec.mainClass=io.blockchainetl.iotex.IotexPubSubToBigQueryPipeline \
   -Dexec.args="--chainConfigFile=chainConfig.json \
   --outputErrorsTable=<errors_table_project>:crypto_iotex.errors \
   --tempLocation=gs://${BUCKET}/temp \
   --project=${PROJECT} \
   --runner=DataflowRunner \
   --jobName=iotex-pubsub-to-bigquery-`date +"%Y%m%d-%H%M%S"` \
   --workerMachineType=n1-standard-1 \
   --maxNumWorkers=1 \
   --diskSizeGb=30 \
   --region=us-central1 \
   --zone=us-central1-a \
   " 

Creating a Cloud Source Repository for Configuration Files

Below are the commands for creating a Cloud Source Repository to hold chainConfig.json:

REPO_NAME=${PROJECT}-dataflow-config-${ENVIRONMENT_INDEX} && echo "Repo name ${REPO_NAME}"
gcloud source repos create ${REPO_NAME}
gcloud source repos clone ${REPO_NAME} && cd ${REPO_NAME}

# Put chainConfig.json to the root of the repo

git add chainConfig.json && git commit -m "Initial commit"
git push

Check a separate file for operations.