globomap-api
globomap-api copied to clipboard
globocom
API abstract used to mapping of infrastructure, services and processes of Globo.com
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 | -- |
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.
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
Licensing
Globo Map API is under Apache 2 License
globocom