https://github.com/eclipse-thingweb/infrastructure

Main infrastructure configuration of the server to manage the deployment of vserver.
https://github.com/eclipse-thingweb/infrastructure

iot organization web web-of-things wot

Last synced: 27 days ago
JSON representation

Main infrastructure configuration of the server to manage the deployment of vserver.

• Host: GitHub
• URL: https://github.com/eclipse-thingweb/infrastructure
• Owner: eclipse-thingweb
• Created: 2024-10-01T13:03:25.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-11-19T13:36:14.000Z (about 2 months ago)
• Last Synced: 2024-11-19T14:43:21.827Z (about 2 months ago)
• Topics: iot, organization, web, web-of-things, wot
• Homepage: https://thingweb.io
• Size: 33.2 KB
• Stars: 1
• Watchers: 8
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Infrastructure

Main infrastructure configuration of the server to manage the deployment of the Eclipse Server.

This repository consists of docker compose files to run Portainer and other infrastructural services such as Traefik proxy, cAdvisor, Prometheus, Grafana and Grafana Loki.

For the list of open ports, see [ports.md](./ports.md)

## Portainer

Portainer is used to manage running Docker containers.

## Infrastructural Services

[docker-compose-services.yml](./docker-compose-services.yml) contains the configuration for the deployment of the infrastructural services.

To be able to access the services, the user must login through GitHub. For GitHub authentication to work, environment variables `OAUTH_SECRET` and, `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` must be set with the configuration of GitHub OAuth application. Only whitelisted emails can access some of the services. Whitelisted emails can be set using the environment variable `WHITELISTED_EMAILS`. These services are accessible at:

- Traefik dashboard -> traefik.localhost

- cAdvisor -> cadvisor.localhost

- Prometheus -> prometheus.localhost

Grafana and Portainer UIs are public access but they run their own authentication and authorization. These services are accessible at:

- Grafana -> grafana.localhost

Hostname and ports can be changed from `.env` file in the root directory.

## Saving Grafana Dashboards

Grafana dashboard json files are stored in [./conf/grafana/dashboards](./conf/grafana/dashboards/).

To save your newly created dashboard locally and push it into the remote repository:

- Export the dashboard as JSON file using Share > Export.

- Save the exported JSON file to [./conf/grafana/dashboards](./conf/grafana/dashboards/).

If your dashboard uses another datasource than our default `prometheus-datasource`, new datasource also must be provisioned in [./conf/grafana/datasources](./conf/grafana/provisioning/datasources/).

For more information check Grafana's provisioning [documentation](https://grafana.com/docs/grafana/latest/administration/provisioning/).

## Instructions

1. After deploying Grafana, configure GitHub OAuth2 through developer settings

2. Add emails for admin rights via role attributes: `[email==] && 'Admin' || 'Viewer'`