Skip to content

Commit 54bb372

Browse files
update links and text description (#1029)
fixes #1027 Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
1 parent 1e00a2d commit 54bb372

File tree

4 files changed

+22
-25
lines changed

4 files changed

+22
-25
lines changed

docs/Tutorials/Kubernetes/Deploy-Charts.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ description: Deploying Besu Helm Charts for a Kubernetes cluster
1313
## Provision with Helm charts
1414

1515
Helm allows you to package a collection of objects into a chart which can be deployed to the cluster. For the
16-
rest of this tutorial we use the **[Dev](https://github.com/ConsenSys/quorum-kubernetes/tree/master/dev)** Helm charts.
16+
rest of this tutorial we use the [**Helm charts**](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm).
1717
After cloning the [Quorum-Kubernetes](https://github.com/ConsenSys/quorum-kubernetes) repository, change
1818
to the `dev` directory for the rest of this tutorial.
1919

2020
```bash
21-
cd dev/helm
21+
cd helm
2222
```
2323

2424
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
7575
prometheus.io/path: "/metrics"
7676
```
7777

78-
Update the admin `username` and `password` in the [monitoring values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/monitoring.yml).
78+
Update the admin `username` and `password` in the [monitoring values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/monitoring.yml).
7979
Configure alerts to the receiver of your choice (for example, email or Slack), then deploy the chart using:
8080

8181
```bash
@@ -103,7 +103,7 @@ helm install filebeat elastic/filebeat --namespace quorum --values ./values/fil
103103
If you install `filebeat`, please create a `filebeat-*` index pattern in `kibana`. All the logs from the nodes are sent to the `filebeat` index.
104104

105105
You can optionally deploy BlockScout to aid with monitoring the network. To do this, update the
106-
[BlockScout values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/blockscout-besu.yml)
106+
[BlockScout values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/blockscout-besu.yml)
107107
and set the `database` and `secret_key_base` values.
108108

109109
!!! important
@@ -128,7 +128,7 @@ The genesis chart creates the genesis file and keys for the validators and bootn
128128
pool can be named to anything you like.
129129

130130
Update the number of validators, accounts, chain ID, and any parameters for the genesis file in the
131-
[`genesis-besu` values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/genesis-besu.yml), then
131+
[`genesis-besu` values file](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/genesis-besu.yml), then
132132
deploy the chart using:
133133

134134
```bash
@@ -204,7 +204,7 @@ first validator was spun up, before the logs display blocks being created.
204204
![k8s-validator-logs](../../images/kubernetes-validator-logs.png)
205205

206206
**To add a validator into the network**, deploy a normal RPC node (step 7) and then
207-
[vote](../../HowTo/Configure/Consensus-Protocols/IBFT.md#adding-and-removing-validators) it into the validator pool.
207+
[vote](../../HowTo/Configure/Consensus-Protocols/IBFT.md#add-and-remove-validators) it into the validator pool.
208208

209209
### 7. Deploy RPC or transaction nodes
210210

docs/Tutorials/Kubernetes/Maintenance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Production charts for Azure use Azure Files, and on AWS use EBS Block Store whic
1919

2020
To update the volume size, you must update the override values file.
2121
For example, to increase the size on the transaction nodes volumes, add the following snippet to the
22-
[`txnode values.yml`](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/txnode.yml) file, with
22+
[`txnode values.yml`](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/txnode.yml) file, with
2323
the new size limit (the following example uses 50Gi).
2424

2525
```bash

docs/Tutorials/Kubernetes/Overview.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Deploying Hyperledger Besu with Kubernetes
88
Use the [reference implementations](https://github.com/ConsenSys/besu-kubernetes) to install
99
private networks using Kubernetes (K8s). Reference implementations are available using:
1010

11-
* [Helm](https://github.com/ConsenSys/quorum-kubernetes/tree/master/dev).
11+
* [Helm](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm).
1212
* [Helmfile](https://github.com/roboll/helmfile).
1313
* [`kubectl`](https://github.com/ConsenSys/besu-kubernetes/tree/master/playground/kubectl).
1414

@@ -23,22 +23,20 @@ Helm charts that you can customize and deploy on a local cluster or in the cloud
2323

2424
We recommend starting with the [playground](https://github.com/ConsenSys/quorum-kubernetes/tree/master/playground)
2525
directory and working through the example setups before moving to the
26-
[`dev`](https://github.com/ConsenSys/quorum-kubernetes/tree/master/dev) directory, and finally to the
27-
[`prod`](https://github.com/ConsenSys/quorum-kubernetes/tree/master/prod) directory.
26+
[`Helm charts`](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm/) directory.
2827

29-
The `dev` and `prod` directories are identical in terms of what gets deployed, but differ in that the `prod` folder uses
30-
best practices to manage identity (Managed Identities in Azure and IAM in AWS), vaults (KeyVault in Azure and Secrets
31-
Manager in AWS), and CSI drivers.
28+
The Helm charts follow best practices to manage identity (Managed Identities in Azure and IAM in AWS),
29+
vaults (KeyVault in Azure and Secrets Manager in AWS), and CSI drivers.
3230

33-
All setups use monitoring and we recommend deploying the monitoring manifests or charts to get an overview of the
34-
network, nodes, and volumes, and you can create alerts accordingly.
35-
In addition, there's an example configuration for ingress and routes that you can customize to suit your requirements.
31+
Provided Helm charts use monitoring, and we recommend deploying the monitoring manifests or charts
32+
to get an overview of the network, nodes, and volumes, and you can create alerts accordingly.
33+
34+
An example configuration is available for ingress and routes that you can customize to suit your requirements.
3635

3736
### Cloud support
3837

39-
The repository's `dev` charts support on premise and cloud providers like AWS, Azure, GCP, IBM etc. The `prod` charts
40-
currently only supports AWS EKS and Azure AKS natively. You can configure the provider in
41-
the [values.yml](https://github.com/ConsenSys/quorum-kubernetes/blob/master/dev/helm/values/genesis-goquorum.yml)
38+
The charts support on premise AWS EKS and Azure AKS cloud providers natively. You can configure the provider in
39+
the [values.yml](https://github.com/ConsenSys/quorum-kubernetes/blob/master/helm/values/genesis-goquorum.yml)
4240
file by setting `provider` to `local`, `aws`, or `azure`.
4341
You can also pass in extra configuration such as a KeyVault name (Azure only).
4442

docs/Tutorials/Kubernetes/Production.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,16 @@ Server Version: version.Info{Major:"1", Minor:"22", GitVersion:"v1.22.3", GitCom
4444

4545
### Deploy the network
4646

47-
For the rest of this tutorial we use the **[Prod](https://github.com/ConsenSys/quorum-kubernetes/tree/master/prod)**
48-
Helm charts. After you have cloned the [Quorum-Kubernetes](https://github.com/ConsenSys/quorum-kubernetes) repository,
47+
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,
4948
change the directory to `prod` for the rest of this tutorial.
5049

5150
```bash
52-
cd prod/helm
51+
cd helm
5352
```
5453

5554
!!!attention
5655

57-
Please update all the [values files](https://github.com/ConsenSys/quorum-kubernetes/tree/master/prod/helm/values)
56+
Please update all the [values files](https://github.com/ConsenSys/quorum-kubernetes/tree/master/helm/values)
5857
with your choice of cloud provider (AWS or Azure) and set `provider: aws` or `provider: azure` as required.
5958
Depending on the provider, you may also need to update the `azure:` or `aws:` dictionaries with specifics of your
6059
cluster and account.
@@ -78,9 +77,9 @@ Please check the [limitations](./Overview.md#limitations) and use CNI where poss
7877
To connect an external node to your cluster, the easiest way is to use a VPN as seen in the
7978
following [multi-cluster](#multi-cluster-support) setup.
8079

81-
Finally, we recommend setting up monitoring and alerting from the beginning so you can get early warnings of issues
80+
Finally, we recommend setting up monitoring and alerting from the beginning, so you can get early warnings of issues
8281
rather than after failure.
83-
We have a monitoring chart which uses Grafana and you can use it in conjunction with Alertmanager to create alerts or
82+
We have a monitoring chart which uses Grafana and you can use it with Alertmanager to create alerts or
8483
alternatively alert via Cloudwatch or Azure Monitoring.
8584

8685
## Multi-cluster support

0 commit comments

Comments
 (0)