https://github.com/globocom/globomap-api
API abstract used to mapping of infrastructure, services and processes of Globo.com
https://github.com/globocom/globomap-api
api-restful flask globo globomap python36
Last synced: 5 months ago
JSON representation
API abstract used to mapping of infrastructure, services and processes of Globo.com
- Host: GitHub
- URL: https://github.com/globocom/globomap-api
- Owner: globocom
- License: apache-2.0
- Created: 2017-07-15T00:29:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-10-17T16:20:25.000Z (over 3 years ago)
- Last Synced: 2025-04-06T08:36:37.350Z (10 months ago)
- Topics: api-restful, flask, globo, globomap, python36
- Language: Python
- Homepage:
- Size: 522 KB
- Stars: 15
- Watchers: 13
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Globo Map API
Application responsible for reading and writing in ARANGODB. This application has a RESTFul API.
## Starting Project:
` make dynamic_ports`
` make containers_build ` (Build images.)
` make containers_start ` (Up containers)
## Running local with docker:
` make dynamic_ports`
` make containers_build ` (When project not started yet.)
` make containers_start ` (When project not started yet.)
## Running Tests:
` make containers_build ` (When project not started yet.)
` make containers_start ` (When project not started yet.)
` make tests `
## Plugin environment variables configuration
All of the environment variables below must be set for the api to work properly.
| Variable | Description | Example |
|------------------------------------|-----------------------------------------------------------------------------|----------------------------|
| ARANGO_DB | Database name | globomap |
| ARANGO_USERNAME | Database user | user |
| ARANGO_PASSWORD | Database password | password |
| ARANGO_PROTOCOL | Database protocol | https |
| ARANGO_PORT | Database port | 8529 |
| ARANGO_HOST | Database host | arangodb.domain.com |
| VARIABLES of globomap-auth-manager | [globomap-auth-manager](https://github.com/globocom/globomap-auth-manager) | -- |
Environment variables needed for the Zabbix plugin to work properly
| Variable | Description | Example |
|-----------------------------|-------------------------|----------------------------|
| ZABBIX_API_URL | Zabbix API endpoint | https://ro.api.zabbix.com |
| ZABBIX_API_USER | Zabbix username | username |
| ZABBIX_API_PASSWORD | Zabbix password | xyz |
| ZABBIX_UI_URL | Zabbix endpoint | https://zabbix.com |
### Environment variables configuration from external libs
All of the environment variables below must be set for the application to work properly.
[globomap-auth-manager](https://github.com/globocom/globomap-auth-manager)
### Requirements:
#### Collections in ArangoDB:
meta_collection
meta_graph
meta_query
internal_metadata
#### Roles in Keystone:
globomap_admin
globomap_read
globomap_write
## Simple Example
Complete flow with [python](https://github.com/edersonbrilhante/globomap-hands-on)
## Licensing
Globo Map API is under [Apache 2 License](./LICENSE)