Skip to content

Commit bb73364

Browse files
authored
Update README.md
1 parent 94cdc97 commit bb73364

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,22 @@ Simple to use, packaged, continuously deployed solution to start 3 monitored eth
44
## Pre-requisite
55
1.Nix version 2.18.2 or higher. Follow the [installation instructions](https://nix.dev/install-nix.html) for your operating system.
66
2. Github personal access token. Follow the [official documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) or take a look at the detailed application specific documentation in this repository.
7+
3. Direnv. Follow the [installation instructions](https://direnv.net/docs/installation.html)
78

89
## `.env` file
910
Create a `.env` file in the repository root, adding your github access token
1011
```
1112
export GITHUB_TOKEN=<your-github-access-token>
1213
```
1314

15+
## Devshell
16+
If you would like to use the development shell provided by the nix flake, run:
17+
```
18+
direnv allow
19+
```
20+
21+
In the shell you can use tools such as `kind` `flux` `kubectl` and `kubectx`
22+
1423
## Usage
1524
### Bootstrap cluster
1625
To start a kubernetes cluster and deploy 3 ethereum [full nodes](https://ethereum.org/en/developers/docs/nodes-and-clients/#what-are-nodes-and-clients) (two clients each), grafana and prometheus in the *ethereum-node-automation* namespace, run:
@@ -37,6 +46,8 @@ To see the status of the deployment, run:
3746
flux get kustomizations
3847
```
3948

49+
50+
4051
## Monitoring
4152
After deploying the applications, there will be a Grafana and a Prometheus deployment in the namespace. To access the Grafan UI, you should port-forward the HTTP port of Grafana:
4253
```

0 commit comments

Comments
 (0)