From bb73364c01dba15e828c06dabaad9068eff062d5 Mon Sep 17 00:00:00 2001 From: Szekely-Schnedarek Marton <43480627+Smorci@users.noreply.github.com> Date: Fri, 6 Sep 2024 19:26:00 +0200 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 23aa066..b07fb5b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ Simple to use, packaged, continuously deployed solution to start 3 monitored eth ## Pre-requisite 1.Nix version 2.18.2 or higher. Follow the [installation instructions](https://nix.dev/install-nix.html) for your operating system. 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. +3. Direnv. Follow the [installation instructions](https://direnv.net/docs/installation.html) ## `.env` file Create a `.env` file in the repository root, adding your github access token @@ -11,6 +12,14 @@ Create a `.env` file in the repository root, adding your github access token export GITHUB_TOKEN= ``` +## Devshell +If you would like to use the development shell provided by the nix flake, run: +``` +direnv allow +``` + +In the shell you can use tools such as `kind` `flux` `kubectl` and `kubectx` + ## Usage ### Bootstrap cluster 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: flux get kustomizations ``` + + ## Monitoring 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: ```