Skip to content

Commit

Permalink
Accept Suggestions and update screenshots with hi-res
Browse files Browse the repository at this point in the history
  • Loading branch information
jdpinedac committed Oct 13, 2023
1 parent d61cc56 commit 82a739d
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion source/docs/casper/operators/aws-nodes/1-deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Below is a list of AWS services that the user and profile must access:
| Service | Access Requirements |
| ---------- | ------------------ |
| EC2 | Full access |
| Cloudwatch | Full access |
| CloudWatch | Full access |
| VPC | Full access |
| S3 | Full access |
| Secret manager | Read-only access |
Expand Down
2 changes: 1 addition & 1 deletion source/docs/casper/operators/aws-nodes/2-validating.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,5 @@ http://{Node-IPv4-Public-IP}:3000
You can also see the node status in the AWS CloudWatch service:

<p align="center">
<img src={"/image/operators/cloudwatch-dashboard.png"} alt="Cloudwatch Dashboard"/>
<img src={"/image/operators/cloudwatch-dashboard.png"} alt="CloudWatch Dashboard"/>
</p>
50 changes: 25 additions & 25 deletions source/docs/casper/operators/aws-nodes/4-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This section describes AWS modules helpful for running and monitoring the node.

## Monitoring Modules

All modules pertinent to overseeing the node. AWS offers a suite of services enabling operators to observe both the node and Casper service status. These services allow the establishment of alarms and provide a visual representation on a dashboard, displaying the node's resources and capacity in real time.
Monitoring modules are pertinent to overseeing the node. AWS offers a suite of services enabling operators to observe the node and Casper service status. These services allow the establishment of alarms and provide a visual representation on a dashboard, displaying the node's resources and capacity in real-time.

| AWS Services Used | Description |
| -------------------- | ------------------------------------------------------------------- |
Expand All @@ -22,10 +22,10 @@ All modules pertinent to overseeing the node. AWS offers a suite of services ena

### CloudWatch Dashboard

The IaC establishes a dashboard to oversee all pertinent resources. This dashboard displays connectivity status, blockchain metrics like block height, block time, and era count, along with node metrics including CPU, memory, and disk usage.
The IaC establishes a dashboard to oversee all pertinent resources. This dashboard displays connectivity status, blockchain metrics like block height, block time, and era count, and node metrics including CPU, memory, and disk usage.

<p align="center">
<img src={"/image/operators/cloudwatch-dashboard.png"} alt="Cloudwatch Dashboard"/>
<img src={"/image/operators/cloudwatch-dashboard.png"} alt="CloudWatch Dashboard"/>
</p>

### CloudWatch Alarms
Expand Down Expand Up @@ -70,24 +70,24 @@ A Log Group module for the **synthetic canary service** stores all logs derived

| Name | Description |
| ---------------------- | ------------------------ |
| `casper-node.log` | Casper node daemon and the blockchain logs |
| `casper-node.stderr.log` | Casper node daemon and the blockchain error logs|
| `casper-node.log` | Casper node daemon and the blockchain logs. |
| `casper-node.stderr.log` | Casper node daemon and the blockchain error logs. |

### CloudWatch Agent

A CloudWatch Agent obtains the following metrics every 30 seconds:

| Metrics | Description |
| ---------------------- | ------------------------- |
| casper-node logs | casper service logs |
| casper-node error logs | casper service error logs |
| disk_total | disk total capacity |
| disk_used | disk usage in GB |
| disk_percent | disk usage in percentage |
| mem_used | RAM usage in GB |
| mem_used_percent | RAM usage in percentage |
| casper-node logs | Casper service logs. |
| casper-node error logs | Casper service error logs.|
| disk_total | Disk total capacity. |
| disk_used | Disk usage in GB. |
| disk_percent | Disk usage percentage. |
| mem_used | RAM usage in GB. |
| mem_used_percent | RAM usage percentage. |

### Cloudwatch Logs
### CloudWatch Logs

In CloudWatch, you can locate distinct log groups that hold logs in text format, offering access to pertinent information from different services. Below is a description of the logs available within these log groups:

Expand Down Expand Up @@ -164,14 +164,14 @@ The ZIP template module creates the ZIP file necessary for the [synthetic canary

## Network Modules

Network modules configure diverse network elements necessary for the node to function correctly.
Network modules configure diverse network elements, ensuring optimal node functionality.

| AWS Services Used | Description |
| -------------------- | ------------------------------------------------------------------- |
| Elastic IP Module | Module to define the Elastic IP associated with the node. |
| VPC Module | Module to create the VPC where the node resides. |
| AWS Services Used | Description |
| -------------------- | ------------------------------------------------------------------- |
| Elastic IP Module | Module to define the Elastic IP associated with the node. |
| VPC Module | Module to create the VPC where the node resides. |
| Security Group Rules Module | Module to establish rules allowing network access to the node. |
| OpenVPN Server Module | Module to create and configure the VPN server. |
| OpenVPN Server Module | Module to create and configure the VPN server. |

### Elastic IP Module

Expand All @@ -183,8 +183,8 @@ The VPC module creates the networking layer where the Casper read-only node will

| Services | Description |
| -------------- | ----------- |
| Amazon VPC | A virtual private cloud within the AWS Cloud. |
| Public subnets | Range of IP addresses in 3 availability zones. |
| Amazon VPC | A virtual private cloud within the AWS Cloud. |
| Public subnets | Range of IP addresses in 3 availability zones. |
| Route tables | Tables control the direction of network traffic. |

### Security Group Rules Module
Expand All @@ -193,8 +193,8 @@ The Security Group Rules module detects whether the node operator wants the `Ope

| OpenVPN Status | Ingress Rule |
| -------------- | ------------ |
| Created | SSH is available when connected to the VPN Server. |
| Discarded | SSH will be available to the IPs the operator listed. |
| Created | SSH is available when connected to the VPN Server. |
| Discarded | SSH will be available to the IPs the operator listed. |

### OpenVPN Server Module

Expand All @@ -206,5 +206,5 @@ The following ports are open to run the Casper service:

| Port | Description |
| ---- | -------------------------------- |
| 22 | For SSH connections to the node |
| 80 | For retrieving dashboard metrics |
| 22 | For SSH connections to the node. |
| 80 | For retrieving dashboard metrics.|
2 changes: 1 addition & 1 deletion source/docs/casper/operators/aws-nodes/6-open-vpn.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Follow these steps to configure the VPN Server:

:::note

All default options are secure; you can select the default by pressing enter unless you wish to change any of them. We recommend changing the default setting allowing password alteration for the `openvpn` user. Please use a secure password.
All default options are secure; you can select the default by pressing enter unless you wish to change any of them. We recommend changing the default setting to allow password alteration for the `openvpn` user. Please use a secure password.

:::

Expand Down
Binary file modified static/image/operators/email-notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/image/operators/session-manager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/image/operators/webpage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 82a739d

Please sign in to comment.