README
¶
ipam-facade - A facade for the IPAM functionality in the Device42 CMDB
https://github.com/asecurityteam/ipam-facade
Overview
<What does this project do?> <What does this project not do?> <Why did we make this project?>
Quick Start
Configuration
Status
This project is in incubation which means we are not yet operating this tool in production and the interfaces are subject to change.
Contributing
Building And Testing
We publish a docker image called SDCLI that bundles all of our build dependencies. It is used by the included Makefile to help make building and testing a bit easier. The following actions are available through the Makefile:
-
make dep
Install the project dependencies into a vendor directory
-
make lint
Run our static analysis suite
-
make test
Run unit tests and generate a coverage artifact
-
make integration
Run integration tests and generate a coverage artifact
-
make coverage
Report the combined coverage for unit and integration tests
-
make build
Generate a local build of the project (if applicable)
-
make run
Run a local instance of the project (if applicable)
-
make doc
Generate the project code documentation and make it viewable locally.
Quality Gates
Our build process will run the following checks before going green:
- make lint
- make test
- make integration
- make coverage (combined result must be 85% or above for the project)
Running these locally, will give early indicators of pass/fail.
License
This project is licensed under Apache 2.0. See LICENSE.txt for details.
Contributing Agreement
Atlassian requires signing a contributor's agreement before we can accept a patch. If you are an individual you can fill out the individual CLA. If you are contributing on behalf of your company then please fill out the corporate CLA.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
domain
Package domain is a container of all of the domain types and interfaces that are used across multiple packages within the service.
|
Package domain is a container of all of the domain types and interfaces that are used across multiple packages within the service. |
|
handlers
Package handlers contains all top level functionality.
|
Package handlers contains all top level functionality. |
|
handlers/v1
Package v1 is a container for endpoints that are used to power the v1 of the service.
|
Package v1 is a container for endpoints that are used to power the v1 of the service. |
|
logs
Package logs contains all structured log events for the service.
|
Package logs contains all structured log events for the service. |