Merge pull request #231 from MinaFoundation/PM-1901-refactor-mina-sta…

…king-ledgers-exporter-to-make-s-3-or-api-optional

PM-1901 - Update enable to enabled in mina-staking-ledgers-exporter for constancy

mina-staking-ledgers-exporter/README.md

@@ -49,13 +49,13 @@ helmfile status
 | imagePullSecrets | list | `[]` | The secrets used to pull the image |
 | minaStakingLedgersExporter.logLevel | string | `"info"` | The log level |
 | minaStakingLedgersExporter.minaNodeLabel | string | `nil` | The Mina node label used to query the ledger |
-| minaStakingLedgersExporter.minaPayoutsDataProvider.enable | bool | `true` | Enable upload to Mina payouts data provider |
+| minaStakingLedgersExporter.minaPayoutsDataProvider.enabled | bool | `true` | Enable upload to Mina payouts data provider |
 | minaStakingLedgersExporter.minaPayoutsDataProvider.password | string | `nil` | The Mina payouts data provider password |
 | minaStakingLedgersExporter.minaPayoutsDataProvider.url | string | `nil` | The Mina payouts data provider URL |
 | minaStakingLedgersExporter.minaPayoutsDataProvider.username | string | `nil` | The Mina payouts data provider username |
 | minaStakingLedgersExporter.network | string | `nil` | The network (mainnet | devnet) |
 | minaStakingLedgersExporter.s3.bucket | string | `nil` | The S3 bucket |
-| minaStakingLedgersExporter.s3.enable | bool | `true` | Enable upload to S3 |
+| minaStakingLedgersExporter.s3.enabled | bool | `true` | Enable upload to S3 |
 | minaStakingLedgersExporter.s3.subpath | string | `nil` | The S3 subpath |
 | minaStakingLedgersExporter.slackWebhookInfoUrl | string | `nil` | The Slack webhook URL for info messages |
 | minaStakingLedgersExporter.slackWebhookWarnUrl | string | `nil` | The Slack webhook URL for warn messages |

mina-staking-ledgers-exporter/scripts/mina-staking-ledgers-exporter.py

@@ -15,13 +15,13 @@
 
 
 class config:
-    api_enable = os.environ.get("APP_MINA_PAYOUTS_DATA_PROVIDER_ENABLE", False).lower() == "true"
+    api_enabled = os.environ.get("APP_MINA_PAYOUTS_DATA_PROVIDER_ENABLED", False).lower() == "true"
     api_password = os.environ["APP_MINA_PAYOUTS_DATA_PROVIDER_PASSWORD"]
     api_url = os.environ["APP_MINA_PAYOUTS_DATA_PROVIDER_URL"]
     api_username = os.environ["APP_MINA_PAYOUTS_DATA_PROVIDER_USERNAME"]
     mina_node_label = os.environ["APP_MINA_NODE_LABEL"]
     network = os.environ["APP_NETWORK"]
-    s3_enable = os.environ.get("APP_S3_ENABLE", False).lower() == "true"
+    s3_enabled = os.environ.get("APP_S3_ENABLED", False).lower() == "true"
     s3_bucket = os.environ["APP_S3_BUCKET"]
     s3_subpath = os.environ.get("APP_S3_SUBPATH", "")
     slack_webhook_info_url = os.environ["APP_SLACK_WEBHOOK_INFO_URL"]
@@ -80,7 +80,7 @@ def process_staking_ledger(synced_pod, epoch, staking_ledger):
         tar.extractall(path="./")
     validate_json_file(staking_ledger_name)
 
-    if config.s3_enable:
+    if config.s3_enabled:
       logger.info("Uploading to S3")
       uploaded_to_s3 = upload_file_to_s3(
           staking_ledger_archive_name,
@@ -92,7 +92,7 @@ def process_staking_ledger(synced_pod, epoch, staking_ledger):
       logger.info("S3 upload is disabled, skip")
       uploaded_to_s3 = False
 
-    if config.api_enable:
+    if config.api_enabled:
       logger.info("Uploading to Payout API")
       uploaded_to_api = submit_mina_payout_data(staking_ledger_name, staking_ledger_hash, epoch)
     else:

mina-staking-ledgers-exporter/values.yaml

@@ -29,7 +29,7 @@ minaStakingLedgersExporter:
   network:
   s3:
     # -- Enable upload to S3
-    enable: true
+    enabled: true
     # -- The S3 bucket
     bucket:
     # -- The S3 subpath
@@ -42,7 +42,7 @@ minaStakingLedgersExporter:
   slackWebhookWarnUrl:
   minaPayoutsDataProvider:
     # -- Enable upload to Mina payouts data provider
-    enable: true
+    enabled: true
     # -- The Mina payouts data provider URL
     url:
     # -- The Mina payouts data provider username