https://github.com/globocom/globonetworkapi

API to automate IP Networking management, resource allocation and provisioning.
https://github.com/globocom/globonetworkapi

automation cloud datacenter dcim ipam network-programming network-topology provisioning

Last synced: about 1 month ago
JSON representation

API to automate IP Networking management, resource allocation and provisioning.

• Host: GitHub
• URL: https://github.com/globocom/globonetworkapi
• Owner: globocom
• License: apache-2.0
• Created: 2014-08-07T19:47:43.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2025-06-27T18:30:17.000Z (3 months ago)
• Last Synced: 2025-06-27T19:36:45.648Z (3 months ago)
• Topics: automation, cloud, datacenter, dcim, ipam, network-programming, network-topology, provisioning
• Language: Python
• Homepage: http://globonetworkapi.readthedocs.org/
• Size: 8.01 MB
• Stars: 84
• Watchers: 50
• Forks: 65
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

          
GloboNetworkAPI

===============

[![Build Status](https://travis-ci.org/globocom/GloboNetworkAPI.svg)](https://travis-ci.org/globocom/GloboNetworkAPI)

[![Documentation Status](https://readthedocs.org/projects/globonetworkapi/badge/?version=latest)](https://globonetworkapi.readthedocs.io/en/latest/?badge=latest)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Globo NetworkAPI is a REST API that manages IP networking resources. It is supposed to be not just an IPAM, but a centralized point of network control, allowing documentation from physical and logical network and starting configuration requests to equipments.

Globo NetworkAPI is made to support a Web User Interface features, exposing its functionality to be used with any other client.

This web tool helps network administrator manage and automate networking resources (routers, switches and load balancers) and document logical and physical networking.

They were created to be vendor agnostic and to support different orchestrators and environments without loosing the centralized view of all network resources allocated.

It was not created to be and inventory database, so it does not have CMDB functionalities.

## Features

* LDAP authentication

* Supports cabling documentation (including patch-panels/DIO’s)

* Separated Layer 2 and Layer 3 documentation (vlan/network)

* IPv4 and IPv6 support

* Automatic allocation of Vlans, Networks and IP’s

* ACL (access control list) automation (documentation/versioning/applying)

* Load-Balancer support

* Automated deploy of allocated resources on switches, routers and load balancers

* Load balancers management

* Expandable plugins for automating configuration

## Documentation

[Documentation](http://globonetworkapi.readthedocs.org/)

## Run API

Run `make build_img && make start` and visit `http://localhost:8000/healthcheck` if running locally.

## Run Unit Tests

Run `make test_ci`. This command will run all the unit tests specified in the `networkapi/tests/__init__.py` file.

## Create and run migrations

To create a new migration, just run into app container `cd dbmigrate; db-migrate --new=`. This step will create a enpty migration file, you must write the SQL statement.

To run a migration, just run into app container `cd dbmigrate; db-migrate`. This command will execute all migrations files not executed until now.

## How to contribute

Check this out at

[Contributing](https://github.com/globocom/GloboNetworkAPI/blob/master/CONTRIBUTING.md) file.

## Authors

[Authors](./AUTHORS.md)