https://github.com/asecurityteam/ipam-facade
<What does this project do?> <What does this project not do?> <Why did we make this project?>
This service collects a single email address from each "Customer" object of the /api/1.0/customers IPAM endpoint
to use as the designated resource owner when the customer is associated with the ip addresses and subnets.
The default behavior in this service is to just use the contact_info field from the "customer" object in
the response from the /api/1.0/customers endpoint.
Your use of IPAM may be such that you've assigned Contacts for each Customer, each with a "type". If you
want to prioritize the use of one of the Contact email addresses over the contact_info value, you should
set the CONTACT_TYPESEARCHORDER environment variable. The value of the variable is a comma-delimited
priority list of "type"s you've defined in your use of IPAM. For example, if you've designated a "Technical"
and "SRE" contact, and you want to prioritize the use of "SRE" over "Technical", always with a fallback to
contact_info, set the environment variable as such:
CONTACT_TYPESEARCHORDER="SRE,Technical"
This project is in incubation which means we are not yet operating this tool in production and the interfaces are subject to change.
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.
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.
This project is licensed under Apache 2.0. See LICENSE.txt for details.
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.