GloboNetworkAPI

KO | EN

gitlite — search

#dotfiles #ruby #javascript #java #shell #vim #game #hacktoberfest #c-plus-plus #php #nodejs #unmaintained

GloboNetworkAPI

★ 88 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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.
You can use the user `testeapi` awith password `testeapi`

## 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
Go to the migration folder:

```bash
cd dbmigrate
```

Check the current migration state:

```bash
db-migrate --show-sql-only
```

Create a new migration file:

```bash
db-migrate --new=allow_null_envs_for_portchannel
```

Edit the generated migration file, for example:

```bash
vi 20260520125452_allow_null_envs_for_portchannel.migration
# Add SQLs for upgrade and downgrade.
```

Apply pending migrations:

```bash
db-migrate
```

### Downgrade

Preview the downgrade to a previous version:

```bash
db-migrate --migration=20240715173246 --force-files --show-sql-only
```

Apply the downgrade:

```bash
db-migrate --migration=20240715173246 --force-files
```

## How to contribute
Check this out at
[Contributing](https://github.com/globocom/GloboNetworkAPI/blob/master/CONTRIBUTING.md) file.

## Authors
[Authors](./AUTHORS.md)

GloboNetworkAPI

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README