Skip to content

Commit

Permalink
fix typos in readme (Consensys#134)
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuafernandes authored Apr 27, 2022
1 parent b43675f commit eac1114
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 17 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ cluster:

```
Setting the `cluster.cloudNativeServices: true` will:
- Keys are stored in KeyVault or Secrets Manager
- We make use of Managed Identities or IAMs for access
- store keys in KeyVault or Secrets Manager
- make use of Managed Identities or IAMs for access

## Concepts:

Expand Down
4 changes: 2 additions & 2 deletions aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ eksctl create iamserviceaccount --name quorum-node-secrets-sa --namespace NAMESP
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |


3. Deploy the charts as per the `helm` folder readme files
6. Deploy the charts as per the `helm` folder readme files

The following is meant to guide you through running Hyperledger Besu or GoQuorum clients in AWS EKS (Kubernetes). As always you are free to customize the charts to suit your requirements. It is highly recommended that you familiarize yourself with EKS (or equivalent Kubernetes infrastructure) before running things in production on Kubernetes.

4. Optionally deploy the kubernetes [dashboard](./templates/k8s-dashboard/README.md)
7. Optionally deploy the kubernetes [dashboard](./templates/k8s-dashboard/README.md)
13 changes: 0 additions & 13 deletions azure/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,7 @@ Use `besu` or `quorum` for AKS_NAMESPACE depending on which blockchain client yo
```bash
./scripts/bootstrap.sh "AKS_RESOURCE_GROUP" "AKS_CLUSTER_NAME" "AKS_MANAGED_IDENTITY" "AKS_NAMESPACE"

./scripts/bootstrap.sh "2204test" "goq-dev-wnyhtoud-cluster" "goq-dev-wnyhtoud-ops-identity" "quorum"

```

3. Deploy the charts as per the `helm` [readme](../helm/README.md) files


## Customizing for production

Once you are familiar with the `playground`, please adjust the configuration ie num of nodes, topology etc to suit your requirements.

Some things are already setup and mereley need your config eg:
- Alerting has been setup via an Action group but requires either an email address or slack webhook to send the alerts to. There are also basic alerts created for you which will utilize the action group. The list is not exhaustive and you should add alerts based on log queries in Azure Monitor to suit your requirements. Please refer to the [Azure Docs](https://docs.microsoft.com/en-us/azure/azure-monitor/alerts/action-groups-create-resource-manager-template) for more information

- Monitoring via Prometheus and Grafana with the Besu and GoQuorum dashboards is enabled, but for production use please configure Grafana with your choice of auth mechanism eg OAuth.

- To extend your nodes and allow other nodes (in a different cluster or outside Azure), you will need to peer your VNet with the other one and ensure that the CIDR blocks don't conflict. Once done the external nodes should be able to communicate with your nodes in AKS

0 comments on commit eac1114

Please sign in to comment.