Tezos. Mount EBS volume, fix CW dashboard for #98

vlasonfa · vlasonfa · commit 3547ce7e05a7 · 2024-07-31T17:33:56.000+10:00
diff --git a/lib/tezos/README.md b/lib/tezos/README.md
@@ -124,7 +124,7 @@ The result should be like this (the actual balance might change):
 ```bash
 pwd
 # Make sure you are in aws-blockchain-node-runners/lib/tezos
-npx cdk deploy snapshot-node --json --outputs-file sync-node-deploy.json
+npx cdk deploy tz-snapshot-node --json --outputs-file sync-node-deploy.json
 ```
 > **NOTE:** *The default VPC must have at least two public subnets in different Availability Zones, and public subnet must set `Auto-assign public IPv4 address` to `YES`.*
 
diff --git a/lib/tezos/app.ts b/lib/tezos/app.ts
@@ -43,7 +43,8 @@ const snapshotNode = new TzSnapshotNodeStack(app, "tz-snapshot-node", {
     historyMode: config.baseNodeConfig.historyMode,
     snapshotsUrl:config.baseNodeConfig.snapshotsUrl,
     octezDownloadUri: config.baseNodeConfig.octezDownloadUri,
-    downloadSnapshot: config.baseNodeConfig.downloadSnapshot == "true"
+    downloadSnapshot: config.baseNodeConfig.downloadSnapshot == "true",
+    dataVolume: config.baseNodeConfig.dataVolume,
 })
 
 const haNodeStack = new TzHANodesStack(app, "tz-ha-nodes", {
diff --git a/lib/tezos/lib/assets/copy-data-to-s3.sh b/lib/tezos/lib/assets/copy-data-to-s3.sh
@@ -5,7 +5,7 @@ systemctl stop node.service
 
 source /etc/environment
 # aws s3 sync ~/.tezos-node/ s3://$S3_SYNC_BUCKET/
-s5cmd sync /home/tezos/.tezos-node/ s3://$S3_SYNC_BUCKET/node/
+s5cmd sync /data/ s3://$S3_SYNC_BUCKET/node/
 
 echo "Synced node to S3"
 
diff --git a/lib/tezos/lib/assets/download-snapshot.sh b/lib/tezos/lib/assets/download-snapshot.sh
@@ -8,10 +8,10 @@ echo "Downloading TZ snapshot from $TZ_SNAPSHOTS_URI."
 
 TZ_SNAPSHOTS_FILE_NAME=snapshot
 
-mkdir ~/tezos-snapshots
-wget -O ~/tezos-snapshots/$TZ_SNAPSHOTS_FILE_NAME $TZ_SNAPSHOTS_URI
-octez-node snapshot import ~/tezos-snapshots/$TZ_SNAPSHOTS_FILE_NAME
-rm ~/tezos-snapshots/$TZ_SNAPSHOTS_FILE_NAME
+mkdir /home/tezos/tezos-snapshots
+wget -O /home/tezos/tezos-snapshots/$TZ_SNAPSHOTS_FILE_NAME $TZ_SNAPSHOTS_URI
+octez-node snapshot import /home/tezos/tezos-snapshots/$TZ_SNAPSHOTS_FILE_NAME --data-dir=/data
+rm /home/tezos/tezos-snapshots/$TZ_SNAPSHOTS_FILE_NAME
 
 
 echo "TZ snapshot is ready !!!"
diff --git a/lib/tezos/lib/assets/node-cw-dashboard.ts b/lib/tezos/lib/assets/node-cw-dashboard.ts
@@ -145,6 +145,25 @@ export const SyncNodeCWDashboardJSON = {
                 "title": "Tezos Client Block Height"
             }
         },
+        {
+            "height": 4,
+            "width": 6,
+            "y": 0,
+            "x": 12,
+            "type": "metric",
+            "properties": {
+                "metrics": [
+                    [ "CWAgent", "tz_minutes_behind", "InstanceId", "${INSTANCE_ID}", { "label": "${INSTANCE_ID}-${INSTANCE_NAME}" } ]
+                ],
+                "sparkline": true,
+                "view": "timeSeries",
+                "stacked": false,
+                "region": "${REGION}",
+                "stat": "Maximum",
+                "period": 60,
+                "title": "Tezos Client Minutes Behind"
+            }
+        },
         {
             "height": 5,
             "width": 6,
diff --git a/lib/tezos/lib/assets/sync-checker/syncchecker-tezos.sh b/lib/tezos/lib/assets/sync-checker/syncchecker-tezos.sh
@@ -10,6 +10,11 @@ else
     TZ_CURRENT_BLOCK=$(octez-client rpc get /chains/test/blocks/head/header/shell | jq -r ".level")
 fi
 
+TZ_CURRENT_BLOCK_TIMESTAMP_ISO=$(octez-client get timestamp)
+TZ_CURRENT_BLOCK_TIMESTAMP_EPOCH=$(date -d"$TZ_CURRENT_BLOCK_TIMESTAMP_ISO" +%s)
+CURRENT_EPOCH=$(date +%s)
+TZ_SECONDS_BEHIND=$(($CURRENT_EPOCH - $TZ_CURRENT_BLOCK_TIMESTAMP_EPOCH))
+TZ_MINUTES_BEHIND=$(($TZ_SECONDS_BEHIND / 60))
 
 # Sending data to CloudWatch
 TOKEN=$(curl -s -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600")
@@ -18,4 +23,4 @@ REGION=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" -s http://169.254.169.254/la
 TIMESTAMP=$(date +"%Y-%m-%dT%H:%M:%S%:z")
 
 aws cloudwatch put-metric-data --metric-name tz_current_block --namespace CWAgent --value $TZ_CURRENT_BLOCK --timestamp $TIMESTAMP --dimensions  InstanceId=$INSTANCE_ID --region $REGION
-#aws cloudwatch put-metric-data --metric-name tz _blocks_behind --namespace CWAgent --value $TZ_HIGHEST_BLOCK_DATE --timestamp $TIMESTAMP --dimensions  InstanceId=$INSTANCE_ID --region $REGION
+aws cloudwatch put-metric-data --metric-name tz_minutes_behind --namespace CWAgent --value $TZ_MINUTES_BEHIND --timestamp $TIMESTAMP --dimensions  InstanceId=$INSTANCE_ID --region $REGION
diff --git a/lib/tezos/lib/assets/user-data/node.sh b/lib/tezos/lib/assets/user-data/node.sh
@@ -15,6 +15,7 @@ echo "LIFECYCLE_HOOK_NAME=${_LIFECYCLE_HOOK_NAME_}" >> /etc/environment
 echo "AUTOSCALING_GROUP_NAME=${_AUTOSCALING_GROUP_NAME_}" >> /etc/environment
 echo "INSTANCE_TYPE=${_INSTANCE_TYPE_}" >> /etc/environment
 echo "S3_SYNC_BUCKET=${_S3_SYNC_BUCKET_}" >> /etc/environment
+echo "TEZOS_NODE_DIR=/data" >> /etc/environment
 source /etc/environment
 
 arch=$(uname -m)
@@ -112,29 +113,54 @@ if [ "$arch" == "x86_64" ]; then
     mv ./octez-arm64/* /usr/local/bin/
 fi
 
-
-
 find /usr/local/bin/ -name "octez-*" -exec chmod +x {} \;
 groupadd tezos
 adduser -g tezos tezos
-#mkdir -p /var/tezos/node
-#chown -R tezos:tezos /var/tezos
+mkdir -p /data
 
 echo "Changing user to tezos"
 
-
 echo "Installing zcash dependency"
 curl -o  /tmp/fetch-params.sh https://raw.githubusercontent.com/zcash/zcash/713fc761dd9cf4c9087c37b078bdeab98697bad2/zcutil/fetch-params.sh
 chmod +x /tmp/fetch-params.sh
 su tezos -c "/tmp/fetch-params.sh"
 
-echo "Configuring node"
-su tezos -c "octez-node config init  --network=$TZ_NETWORK  --history-mode=$TZ_HISTORY_MODE  --net-addr='[::]:9732' --rpc-addr='[::]:8732' --allow-all-rpc [::]:8732"
+echo "Configuring /data volume"
+if [ "$INSTANCE_TYPE" == "SNAPSHOT"  ] || [ "$INSTANCE_TYPE" == "SINGLE" ]; then
+  # Signal completion to CFN
+  echo "Single node. Signaling completion to CloudFormation to make EBS volumes available."
+  cfn-signal --stack $STACK_NAME --resource $RESOURCE_ID --region $AWS_REGION
+
+  echo "Single node. Wait for one minute for the volume to be available"
+  sleep 60
+fi
+
+if $(lsblk | grep -q nvme1n1); then
+  echo "nvme1n1 is found. Configuring attached storage"
+
+  mkfs -t xfs /dev/nvme1n1
 
-# Signal completion to CFN
-echo "Signaling completion to CloudFormation. The node will still sync/import data"
-cfn-signal --stack $STACK_NAME --resource $RESOURCE_ID --region $AWS_REGION
+  sleep 10
+  # Define the line to add to fstab
+  uuid=$(lsblk -n -o UUID /dev/nvme1n1)
+  line="UUID=$uuid /data xfs defaults 0 2"
 
+  # Write the line to fstab
+  echo $line | sudo tee -a /etc/fstab
+
+  mount -a
+
+else
+  echo "nvme1n1 is not found. Not doing anything"
+fi
+
+chown -R tezos:tezos /data
+chmod -R 755 /data
+
+lsblk -d
+
+echo "Configuring node"
+su tezos -c "octez-node config init  --network=$TZ_NETWORK  --history-mode=$TZ_HISTORY_MODE --data-dir /data  --net-addr='[::]:9732' --rpc-addr='[::]:8732' --allow-all-rpc [::]:8732"
 
 # download snapshot if network is mainnet
 if [ "$INSTANCE_TYPE" == "SNAPSHOT"  ] || [ "$INSTANCE_TYPE" == "SINGLE" ]; then
@@ -145,10 +171,9 @@ if [ "$INSTANCE_TYPE" == "SNAPSHOT"  ] || [ "$INSTANCE_TYPE" == "SINGLE" ]; then
   fi
 fi
 
-
 if [[ "$INSTANCE_TYPE" == "HA" ]]; then
   # su tezos -c "aws s3 sync s3://$S3_SYNC_BUCKET/node ~/.tezos-node/node"
-  su tezos -c "s5cmd sync 's3://$S3_SYNC_BUCKET/node/*' /home/tezos/.tezos-node/"
+  su tezos -c "s5cmd sync 's3://$S3_SYNC_BUCKET/node/*' /data/"
 fi
 
 if [[ "$INSTANCE_TYPE" == "SNAPSHOT" ]]; then
@@ -167,7 +192,7 @@ Description="Run the octez-node"
 [Service]
 User=tezos
 Group=tezos
-ExecStart=octez-node run
+ExecStart=octez-node run --data-dir=/data
 
 [Install]
 WantedBy=multi-user.target
diff --git a/lib/tezos/lib/snapshot-node-stack.ts b/lib/tezos/lib/snapshot-node-stack.ts
@@ -2,15 +2,15 @@ import * as cdk from "aws-cdk-lib";
 import * as cdkConstructs from "constructs";
 import * as ec2 from "aws-cdk-lib/aws-ec2";
 import * as iam from "aws-cdk-lib/aws-iam";
-import * as s3 from "aws-cdk-lib/aws-s3";
-import { AmazonLinuxGeneration, AmazonLinuxImage } from "aws-cdk-lib/aws-ec2";
 import * as s3Assets from "aws-cdk-lib/aws-s3-assets";
 import * as configTypes from "./config/tzConfig.interface";
 import { TzNodeSecurityGroupConstructs } from "./constructs/tz-node-security-group";
 import * as fs from "fs";
 import * as path from "path";
 import * as constants from "../../constructs/constants";
-import { HANodesConstruct } from "../../constructs/ha-rpc-nodes-with-alb";
+import * as nodeCwDashboard from "./assets/node-cw-dashboard"
+import * as cw from 'aws-cdk-lib/aws-cloudwatch';
+import { SingleNodeConstruct } from "../../constructs/single-node"
 import * as nag from "cdk-nag";
 import { SnapshotsS3BucketConstruct } from "../../constructs/snapshots-bucket";
 
@@ -23,6 +23,7 @@ export interface TzSnapshotNodeStackProps extends cdk.StackProps {
     downloadSnapshot: boolean;
     snapshotsUrl: string;
     octezDownloadUri: string;
+    dataVolume: configTypes.TzDataVolumeConfig;
 }
 
 export class TzSnapshotNodeStack extends cdk.Stack {
@@ -32,9 +33,9 @@ export class TzSnapshotNodeStack extends cdk.Stack {
         const REGION = cdk.Stack.of(this).region;
         const STACK_NAME = cdk.Stack.of(this).stackName;
         const STACK_ID = cdk.Stack.of(this).stackId;
-        const AWS_ACCOUNT_ID = cdk.Stack.of(this).account
-        const lifecycleHookName = STACK_NAME;
-        const autoScalingGroupName = STACK_NAME;
+        const AWS_ACCOUNT_ID = cdk.Stack.of(this).account;
+        const availabilityZones = cdk.Stack.of(this).availabilityZones;
+        const chosenAvailabilityZone = availabilityZones.slice(0, 1)[0];
 
         const {
             instanceType,
@@ -45,6 +46,7 @@ export class TzSnapshotNodeStack extends cdk.Stack {
             downloadSnapshot,
             snapshotsUrl,
             octezDownloadUri,
+            dataVolume,
         } = props;
 
         // using default vpc
@@ -112,68 +114,62 @@ export class TzSnapshotNodeStack extends cdk.Stack {
                 actions: ["s3:ListBucket", "s3:*Object", "s3:GetBucket*"],
             })
         );
-        const snapshotNodeScript = fs.readFileSync(path.join(__dirname, "assets", "user-data", "node.sh")).toString();
 
-
-        const snapshotNode = new ec2.Instance(this, "tz-snapshot-node", {
-            instanceName: "tz-snapshot-node",
-            instanceType: instanceType,
+        // Setting up the node using generic Sync Node constract
+        const node = new SingleNodeConstruct(this, "sync-node", {
+            instanceName: STACK_NAME,
+            instanceType,
+            dataVolumes: [dataVolume],
             machineImage: new ec2.AmazonLinux2023ImageSsmParameter({
                 kernel: ec2.AmazonLinux2023Kernel.KERNEL_6_1,
                 cpuType: instanceCpuType,
             }),
-            vpc: vpc,
-            blockDevices: [
-                {
-                  // ROOT VOLUME
-                  deviceName: "/dev/xvda",
-                  volume: ec2.BlockDeviceVolume.ebs(46, {
-                      deleteOnTermination: true,
-                      encrypted: true,
-                      iops: 3000,
-                      volumeType: ec2.EbsDeviceVolumeType.GP3,
-                    }),
-                },
-              ],
-            detailedMonitoring: true,
-            propagateTagsToVolumeOnCreation: true,
-            role: snapshotInstanceRole,
+            vpc,
+            availabilityZone: chosenAvailabilityZone,
+            role: instanceRole,
             securityGroup: instanceSG.securityGroup,
-          });
-
-          const modifiedSnapshotNodeScript = cdk.Fn.sub(snapshotNodeScript, {
-              _AWS_REGION_: REGION,
-              _STACK_NAME_: STACK_NAME,
-              _TZ_SNAPSHOTS_URI_: snapshotsUrl,
-              _STACK_ID_: STACK_ID,
-              _TZ_HISTORY_MODE_: historyMode,
-              _TZ_DOWNLOAD_SNAPSHOT_ : String(downloadSnapshot),
-              _TZ_OCTEZ_DOWNLOAD_URI_ : octezDownloadUri,
-              _TZ_NETWORK_: tzNetwork,
-              _S3_SYNC_BUCKET_: snapshotsBucket.bucketName,
-              _NODE_CF_LOGICAL_ID_: snapshotNode.instance.logicalId,
-              _LIFECYCLE_HOOK_NAME_: lifecycleHookName,
-              _AUTOSCALING_GROUP_NAME_: autoScalingGroupName,
-              _ASSETS_S3_PATH_: `s3://${asset.s3BucketName}/${asset.s3ObjectKey}`,
-              _INSTANCE_TYPE_: "SNAPSHOT",
-          });
-
-          snapshotNode.addUserData(modifiedSnapshotNodeScript);
-
-
-        // Getting logical ID of the instance to send ready signal later once the instance is initialized
-        const snapshotNodeCfn = snapshotNode.node.defaultChild as ec2.CfnInstance;
-
-        // CloudFormation Config: wait for 15 min for the node to start
-        const creationPolicy: cdk.CfnCreationPolicy = {
-            resourceSignal: {
-            count: 1,
-            timeout: "PT90M",
+            vpcSubnets: {
+                subnetType: ec2.SubnetType.PUBLIC,
             },
-        };
-
-
-        snapshotNodeCfn.cfnOptions.creationPolicy = creationPolicy;
+        });
+        
+        // Parsing user data script and injecting necessary variables
+        const userData = fs.readFileSync(path.join(__dirname, "assets", "user-data", "node.sh")).toString();
+        const modifiedUserData = cdk.Fn.sub(userData, {
+            _AWS_REGION_: REGION,
+            _ASSETS_S3_PATH_: `s3://${asset.s3BucketName}/${asset.s3ObjectKey}`,
+            _STACK_NAME_: STACK_NAME,
+            _TZ_SNAPSHOTS_URI_: snapshotsUrl,
+            _STACK_ID_: STACK_ID,
+            _NODE_CF_LOGICAL_ID_: node.nodeCFLogicalId,
+            _TZ_HISTORY_MODE_: historyMode,
+            _TZ_DOWNLOAD_SNAPSHOT_ : String(downloadSnapshot),
+            _TZ_OCTEZ_DOWNLOAD_URI_ : octezDownloadUri,
+            _TZ_NETWORK_: tzNetwork,
+            _LIFECYCLE_HOOK_NAME_: constants.NoneValue,
+            _AUTOSCALING_GROUP_NAME_: constants.NoneValue,
+            _INSTANCE_TYPE_: "SNAPSHOT",
+            _S3_SYNC_BUCKET_: snapshotsBucket.bucketName,
+        });
+        
+        // Adding modified userdata script to the instance prepared fro us by Single Node constract
+        node.instance.addUserData(modifiedUserData);
+        
+        // Adding CloudWatch dashboard to the node
+        const dashboardString = cdk.Fn.sub(JSON.stringify(nodeCwDashboard.SyncNodeCWDashboardJSON), {
+            INSTANCE_ID:node.instanceId,
+            INSTANCE_NAME: STACK_NAME,
+            REGION: REGION,
+        })
+        
+        new cw.CfnDashboard(this, 'sync-cw-dashboard', {
+            dashboardName: `${STACK_NAME}-${node.instanceId}`,
+            dashboardBody: dashboardString,
+        });
+        
+        new cdk.CfnOutput(this, "sync-instance-id", {
+            value: node.instanceId,
+        });
 
         new cdk.CfnOutput(this, "TezosSnapshotBucket", {
             value: snapshotsBucket.bucketName,
