From 54bb3723619cf8d74eb627c42b8b7222df9978ba Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Mon, 2 May 2022 15:44:06 +0200 Subject: [PATCH] update links and text description (#1029) fixes #1027 Signed-off-by: Nicolas MASSART --- docs/Tutorials/Kubernetes/Deploy-Charts.md | 12 ++++++------ docs/Tutorials/Kubernetes/Maintenance.md | 2 +- docs/Tutorials/Kubernetes/Overview.md | 22 ++++++++++------------ docs/Tutorials/Kubernetes/Production.md | 11 +++++------ 4 files changed, 22 insertions(+), 25 deletions(-) diff --git a/docs/Tutorials/Kubernetes/Deploy-Charts.md b/docs/Tutorials/Kubernetes/Deploy-Charts.md index 2184d527d9..e54f6daf8a 100644 --- a/docs/Tutorials/Kubernetes/Deploy-Charts.md +++ b/docs/Tutorials/Kubernetes/Deploy-Charts.md @@ -13,12 +13,12 @@ description: Deploying Besu Helm Charts for a Kubernetes cluster ## Provision with Helm charts Helm allows you to package a collection of objects into a chart which can be deployed to the cluster. For the -rest of this tutorial we use the **[Dev](https://github.com/ConsenSys/quorum-kubernetes/tree/master/dev)** Helm charts. +rest of this tutorial we use the [**Helm charts**](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm). After cloning the [Quorum-Kubernetes](https://github.com/ConsenSys/quorum-kubernetes) repository, change to the `dev` directory for the rest of this tutorial. ```bash -cd dev/helm +cd helm ``` If you're running the cluster on AWS or Azure, update the `values.yml` with `provider: aws` or @@ -75,7 +75,7 @@ which allow Prometheus to scrape metrics from the pod at a specified port and pa prometheus.io/path: "/metrics" ``` -Update the admin `username` and `password` in the [monitoring values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/monitoring.yml). +Update the admin `username` and `password` in the [monitoring values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/monitoring.yml). Configure alerts to the receiver of your choice (for example, email or Slack), then deploy the chart using: ```bash @@ -103,7 +103,7 @@ helm install filebeat elastic/filebeat --namespace quorum --values ./values/fil If you install `filebeat`, please create a `filebeat-*` index pattern in `kibana`. All the logs from the nodes are sent to the `filebeat` index. You can optionally deploy BlockScout to aid with monitoring the network. To do this, update the -[BlockScout values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/blockscout-besu.yml) +[BlockScout values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/blockscout-besu.yml) and set the `database` and `secret_key_base` values. !!! important @@ -128,7 +128,7 @@ The genesis chart creates the genesis file and keys for the validators and bootn pool can be named to anything you like. Update the number of validators, accounts, chain ID, and any parameters for the genesis file in the -[`genesis-besu` values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/genesis-besu.yml), then +[`genesis-besu` values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/genesis-besu.yml), then deploy the chart using: ```bash @@ -204,7 +204,7 @@ first validator was spun up, before the logs display blocks being created. ![k8s-validator-logs](../../images/kubernetes-validator-logs.png) **To add a validator into the network**, deploy a normal RPC node (step 7) and then -[vote](../../HowTo/Configure/Consensus-Protocols/IBFT.md#adding-and-removing-validators) it into the validator pool. +[vote](../../HowTo/Configure/Consensus-Protocols/IBFT.md#add-and-remove-validators) it into the validator pool. ### 7. Deploy RPC or transaction nodes diff --git a/docs/Tutorials/Kubernetes/Maintenance.md b/docs/Tutorials/Kubernetes/Maintenance.md index 1e3f56f866..0688115261 100644 --- a/docs/Tutorials/Kubernetes/Maintenance.md +++ b/docs/Tutorials/Kubernetes/Maintenance.md @@ -19,7 +19,7 @@ Production charts for Azure use Azure Files, and on AWS use EBS Block Store whic To update the volume size, you must update the override values file. For example, to increase the size on the transaction nodes volumes, add the following snippet to the -[`txnode values.yml`](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/txnode.yml) file, with +[`txnode values.yml`](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/txnode.yml) file, with the new size limit (the following example uses 50Gi). ```bash diff --git a/docs/Tutorials/Kubernetes/Overview.md b/docs/Tutorials/Kubernetes/Overview.md index 7b6b580143..63c5bd6745 100644 --- a/docs/Tutorials/Kubernetes/Overview.md +++ b/docs/Tutorials/Kubernetes/Overview.md @@ -8,7 +8,7 @@ description: Deploying Hyperledger Besu with Kubernetes Use the [reference implementations](https://github.com/ConsenSys/besu-kubernetes) to install private networks using Kubernetes (K8s). Reference implementations are available using: -* [Helm](https://github.com/ConsenSys/quorum-kubernetes/tree/master/dev). +* [Helm](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm). * [Helmfile](https://github.com/roboll/helmfile). * [`kubectl`](https://github.com/ConsenSys/besu-kubernetes/tree/master/playground/kubectl). @@ -23,22 +23,20 @@ Helm charts that you can customize and deploy on a local cluster or in the cloud We recommend starting with the [playground](https://github.com/ConsenSys/quorum-kubernetes/tree/master/playground) directory and working through the example setups before moving to the - [`dev`](https://github.com/ConsenSys/quorum-kubernetes/tree/master/dev) directory, and finally to the - [`prod`](https://github.com/ConsenSys/quorum-kubernetes/tree/master/prod) directory. + [`Helm charts`](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm/) directory. -The `dev` and `prod` directories are identical in terms of what gets deployed, but differ in that the `prod` folder uses -best practices to manage identity (Managed Identities in Azure and IAM in AWS), vaults (KeyVault in Azure and Secrets -Manager in AWS), and CSI drivers. +The Helm charts follow best practices to manage identity (Managed Identities in Azure and IAM in AWS), +vaults (KeyVault in Azure and Secrets Manager in AWS), and CSI drivers. -All setups use monitoring and we recommend deploying the monitoring manifests or charts to get an overview of the -network, nodes, and volumes, and you can create alerts accordingly. -In addition, there's an example configuration for ingress and routes that you can customize to suit your requirements. +Provided Helm charts use monitoring, and we recommend deploying the monitoring manifests or charts +to get an overview of the network, nodes, and volumes, and you can create alerts accordingly. + +An example configuration is available for ingress and routes that you can customize to suit your requirements. ### Cloud support -The repository's `dev` charts support on premise and cloud providers like AWS, Azure, GCP, IBM etc. The `prod` charts -currently only supports AWS EKS and Azure AKS natively. You can configure the provider in -the [values.yml](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/genesis-goquorum.yml) +The charts support on premise AWS EKS and Azure AKS cloud providers natively. You can configure the provider in +the [values.yml](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/genesis-goquorum.yml) file by setting `provider` to `local`, `aws`, or `azure`. You can also pass in extra configuration such as a KeyVault name (Azure only). diff --git a/docs/Tutorials/Kubernetes/Production.md b/docs/Tutorials/Kubernetes/Production.md index 5b6b7ec4d0..3dc1ddd169 100644 --- a/docs/Tutorials/Kubernetes/Production.md +++ b/docs/Tutorials/Kubernetes/Production.md @@ -44,17 +44,16 @@ Server Version: version.Info{Major:"1", Minor:"22", GitVersion:"v1.22.3", GitCom ### Deploy the network -For the rest of this tutorial we use the **[Prod](https://github.com/ConsenSys/quorum-kubernetes/tree/master/prod)** -Helm charts. After you have cloned the [Quorum-Kubernetes](https://github.com/ConsenSys/quorum-kubernetes) repository, +For the rest of this tutorial we use the [**Helm charts**](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm). After you have cloned the [Quorum-Kubernetes](https://github.com/ConsenSys/quorum-kubernetes) repository, change the directory to `prod` for the rest of this tutorial. ```bash -cd prod/helm +cd helm ``` !!!attention - Please update all the [values files](https://github.com/ConsenSys/quorum-kubernetes/tree/master/prod/helm/values) + Please update all the [values files](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm/values) with your choice of cloud provider (AWS or Azure) and set `provider: aws` or `provider: azure` as required. Depending on the provider, you may also need to update the `azure:` or `aws:` dictionaries with specifics of your cluster and account. @@ -78,9 +77,9 @@ Please check the [limitations](./Overview.md#limitations) and use CNI where poss To connect an external node to your cluster, the easiest way is to use a VPN as seen in the following [multi-cluster](#multi-cluster-support) setup. -Finally, we recommend setting up monitoring and alerting from the beginning so you can get early warnings of issues +Finally, we recommend setting up monitoring and alerting from the beginning, so you can get early warnings of issues rather than after failure. -We have a monitoring chart which uses Grafana and you can use it in conjunction with Alertmanager to create alerts or +We have a monitoring chart which uses Grafana and you can use it with Alertmanager to create alerts or alternatively alert via Cloudwatch or Azure Monitoring. ## Multi-cluster support