{"id":13582006,"url":"https://github.com/sapcc/atlas","last_synced_at":"2025-07-26T12:07:53.011Z","repository":{"id":41954539,"uuid":"140730674","full_name":"sapcc/atlas","owner":"sapcc","description":"Custom Prometheus service discovery","archived":false,"fork":false,"pushed_at":"2023-12-15T08:23:46.000Z","size":12108,"stargazers_count":10,"open_issues_count":5,"forks_count":1,"subscribers_count":52,"default_branch":"master","last_synced_at":"2025-03-30T16:46:46.925Z","etag":null,"topics":["atlas","discovery-service","ironic","kubernetes","netbox","openstack","prometheus","prometheus-service-discovery"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sapcc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-12T15:19:00.000Z","updated_at":"2024-01-24T18:02:15.000Z","dependencies_parsed_at":"2023-12-15T09:41:00.275Z","dependency_job_id":null,"html_url":"https://github.com/sapcc/atlas","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fatlas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fatlas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fatlas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapcc%2Fatlas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sapcc","download_url":"https://codeload.github.com/sapcc/atlas/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249514413,"owners_count":21284537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atlas","discovery-service","ironic","kubernetes","netbox","openstack","prometheus","prometheus-service-discovery"],"created_at":"2024-08-01T15:02:22.826Z","updated_at":"2025-04-18T15:33:40.135Z","avatar_url":"https://github.com/sapcc.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# atlas\n\nAtlas, brother of Prometheus.\n\nThis is a standalone custom Prometheus service discovery application. It consists of a growing number of discoveries which can be enabled/disabled and configured via a yaml file. The discovered targets are then written into a configmap file, which is consumed by Prometheus.\n\n## Architecture overview\n\n![](https://github.com/sapcc/ipmi_sd/blob/master/documentation/ipmi_sd_arch.png)\n\n\nAvailable Discoveries:\n1. Ironic Nodes\n```\ndiscoveries:\n      ironic:\n        refresh_interval: 600 #How often the discovery should check for new/updated nodes.\n        targets_file_name: \"ironic.json\" #Name of the file to write the nodes to.\n        os_auth: # Openstack auth\n          auth_url: openstack auth url\n          user: openstack user\n          password: os user pw\n          user_domain_name: openstack user_domain_name\n          project_name: openstack project_name\n          domain_name: openstack domain_name\n```\n2. Netbox API\n  - DCIM-Devices\n    ```\n    netbox:\n        refresh_interval: 600 # How often the discovery should check for new/updated devices.\n        targets_file_name: \"netbox.json\"  #Name of the file to write the devices to.\n        netbox_host: \"netbox_host_url\"\n        netbox_api_token: \"netbox_api_token\"\n        dcim:\n          devices: #Array of device queries\n            - custom_labels: #Use to add custom labels to the target\n                anyLabel: \"anyValue\"\n                job: \"job_name\"\n              target: 1 #Query Parameters: Any parameters the netbox api ([netbox_url]/api/dcim/devices/) accepts.\n              role: \"role_name\"\n              manufacturer: \"cisco\"\n              region: \"de1\"\n              status: \"1\"\n            - custom_labels: ....\n    ```\n  - Virtualization-VMs\n    ```\n    netbox:\n        refresh_interval: 600 # How often the discovery should check for new/updated devices.\n        targets_file_name: \"netbox.json\"  #Name of the file to write the devices to.\n        netbox_host: \"netbox_host_url\"\n        netbox_api_token: \"netbox_api_token\"\n        virtualization:\n          vm: #Array of vms queries\n            - custom_labels: #Use to add custom labels to the target\n                anyLabel: \"anyValue\"\n                job: \"job_name\"\n              target: 1 #Query Parameters: Any parameters the netbox api ([netbox_url]/api/virtualization/virtual-machines/\",) accepts.\n              manufacturer: \"cisco\"\n              region: \"de1\"\n              tag: \"tag_name\"\n            - custom_labels: ....\n    ```\n\n## Install\nA Dockerfile is provided to run it on Kubernetes. All necessary ENV VARs/flags can be figured out running `ipmi_sd --help`:\n\n```\nNAME:\n   atlas - discovers custom services, enriches them with metadata labels and writes them to a file or Kubernetes configmap\n USAGE:\n   atlas [global options]\n VERSION:\n   0.1.7\n COMMANDS:\n     help, h  Shows a list of commands or help for one command\n GLOBAL OPTIONS:\n  - OS_PROM_CONFIGMAP_NAME: name of the configmap, where the discovered nodes should be written to.\n  - K8S_NAMESPACE: name of the K8s namespace atlas is running in.\n  - K8S_REGION: name of the k8s region atlas is running in\n  - LOG_LEVEL: log level atlas should use:\n    - \"debug\"\n    - \"error\"\n    - \"warn\"\n    - \"info\"\n```\n\nTo figure these out you can also just run it locally.\nEither by building via docker using `docker build .` and then `docker run CONTAINER --help` or directly on bare metal if you have a working go\nenvironment with `go run cmd/atlas/main.go --help`.\n\nPrometheus server configuration:\nA sample prometheus job to read those configmap targets is shown [here](https://github.com/sapcc/ipmi_sd/blob/master/prometheus.yml)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsapcc%2Fatlas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsapcc%2Fatlas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsapcc%2Fatlas/lists"}