Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stage to main after docs update #1975

Merged
merged 5 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -149,12 +149,6 @@ start-boot-node:
@echo "Running start-boot-node"
${BUILD_PATH} start-boot-node ${BOOTNODE_COMMAND}

MONITOR_NODES=prometheus grafana
.PHONY: docker-monitor
docker-monitor:
@echo $(MONITOR_NODES)
@docker-compose up --build $(MONITOR_NODES)

.PHONY: mock
mock:
go generate ./...
Expand Down
33 changes: 0 additions & 33 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -150,40 +150,7 @@ services:
DEBUG_PORT: 40009
CONFIG_PATH: ./config/config.exporter.yaml

# monitoring services

prometheus:
container_name: prometheus
image: prom/prometheus:v2.24.0
volumes:
- ./monitoring/prometheus/:/etc/prometheus/
- data_prometheus:/prometheus
command:
- "--config.file=/etc/prometheus/prometheus.yaml"
- "--storage.tsdb.path=/prometheus"
- "--web.console.libraries=/usr/share/prometheus/console_libraries"
- "--web.console.templates=/usr/share/prometheus/consoles"
ports:
- 9090:9090
restart: always
networks:
- blox-docker

grafana:
image: grafana/grafana:latest
container_name: grafana
networks:
- blox-docker
ports:
- "3000:3000"
volumes:
- data_grafana:/var/lib/grafana

networks:
blox-docker:
driver: bridge
name: blox-docker

volumes:
data_prometheus:
data_grafana:
21 changes: 5 additions & 16 deletions docs/DEV_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
- [Run](#run)
- [Local network with 4 nodes with Docker Compose](#local-network-with-4-nodes-with-docker-compose)
- [Local network with 4 nodes for debugging with Docker Compose](#local-network-with-4-nodes-for-debugging-with-docker-compose)
- [Prometheus and Grafana for local network](#prometheus-and-grafana-for-local-network)
- [Coding Standards](#coding-standards)

## Usage
Expand Down Expand Up @@ -183,7 +182,8 @@ By using this script, developers can simulate a real SSV environment, run multip
The script simplifies configuration by automatically generating YAML files for each operator and an 'events.yaml' file. The 'events.yaml' emulates a 'happy flow' scenario, which includes the registration of four operators and one validator

1. Download the executable version 1.0.1 from [ssv-keys](https://github.com/ssvlabs/ssv-keys/releases/tag/v1.0.1).
- After downloading, follow these [steps](https://github.com/ssvlabs/ssv-keys#option-1-running-an-executable-recommended-route) to provide the necessary permissions to the executable.

- After downloading, follow these [steps](https://github.com/ssvlabs/ssv-keys#option-1-running-an-executable-recommended-route) to provide the necessary permissions to the executable.

2. Generate a local configuration using the provided [script](../scripts/generate_local_config.sh).

Expand Down Expand Up @@ -254,9 +254,9 @@ These steps offer a detailed manual alternative to the script. They provide a st
```

9. Finally, build and run 4 local nodes with the following command:
```bash
docker-compose up --build ssv-node-1 ssv-node-2 ssv-node-3 ssv-node-4
```
```bash
docker-compose up --build ssv-node-1 ssv-node-2 ssv-node-3 ssv-node-4
```

### Run

Expand All @@ -274,17 +274,6 @@ $ make docker-all
$ make docker-debug
```

#### Prometheus and Grafana for local network

In order to spin up local prometheus and grafana use:

```shell
$ make docker-monitor
```

For a grafana dashboard, use the [SSV Operator dashboard](../monitoring/grafana/dashboard_ssv_operator.json) as
explained in [monitoring/README.md#grafana](../monitoring/README.md#grafana)

## Coding Standards

Please make sure your contributions adhere to our coding guidelines:
Expand Down
40 changes: 0 additions & 40 deletions docs/OPERATOR_GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,43 +172,3 @@ $ docker rm -f ssv_node && docker pull ssvlabs/ssv-node:latest
```

Now run the container again as specified above in step 6.

### 8. Setup Monitoring

Follow the next steps to setup a local monitoring environment (prometheus and grafana containers):

1. Prometheus:

```shell
# download prometheus config
$ mkdir prometheus && wget -O ./prometheus/prometheus.yaml https://raw.githubusercontent.com/ssvlabs/ssv/stage/monitoring/prometheus/prometheus.yaml
# start a container
$ docker run --user root -p 9390:9090 -dit --name=prometheus -v $(pwd)/prometheus/:/data/prometheus -v $(pwd)/prometheus/prometheus.yaml:/etc/prometheus/prometheus.yml 'prom/prometheus:v2.24.0' --config.file="/etc/prometheus/prometheus.yml" --storage.tsdb.path="/data/prometheus"
```

2. Grafana:

```shell
# create a data dir
$ mkdir grafana
# start a container
$ docker run -p 3000:3000 -dti -v $(pwd)/grafana/:/var/lib/grafana --name=grafana 'grafana/grafana:8.0.0'
```

3. Create a local network for connectivity of all containers:

```shell
$ docker network create --driver bridge ssv-net
$ docker network connect --alias ssv-node-1 ssv-net ssv_node
$ docker network connect --alias prometheus ssv-net prometheus
$ docker network connect --alias grafana ssv-net grafana
```

4. Expose grafana externally by adding inbound rule to open port 3000 or by some proxy such as Nginx.

5. Follow grafana instructions in [monitoring > grafana](../monitoring/README.md#grafana)

**Notes:**

- change the values of `instance` variable in Grafana (`Settings > Variables`) to `ssv-node-1`
- `Process Health` panels are showing K8S metrics which are not used in this setup, and therefore won't be available
125 changes: 0 additions & 125 deletions monitoring/README.md

This file was deleted.

67 changes: 0 additions & 67 deletions monitoring/grafana/NODE.md

This file was deleted.

Loading
Loading