ipam/README.md

5.3 KiB

Azure IPAM

Azure IPAM is a lightweight solution developed on top of the Azure platform designed to help Azure customers manage their IP Address space easily and effectively.

Repo Contents

File/folder Description
.github/ Bug Report, Issue Templates and GitHub Actions
.vscode/ VSCode Configuration
deploy/ Deployment Bicep Templates & PowerShell Deployment Scripts
docs/ Documentation Folder
engine/ Engine Application Code
examples/ Example Templates, Scripts and Code Snippets for Azure IPAM
lb/ Load Balancer (NGINX) Configs
tests/ Engine and UI Testing Scripts
ui/ UI Application Code
.dockerignore Untracked Docker Files to Ignore
.env.example Example ENV File to be Used with Docker Compose
.gitattributes Git File and Path Attributes
.gitignore Untracked Git Files to Ignore
CODE_OF_CONDUCT.md Microsoft Code of Conduct
docker-compose.prod.yml Production Docker Compose File
docker-compose.yml Development Docker Compose File
Dockerfile Single Container Dockerfile
init.sh Single Container Init Script
LICENSE Microsoft MIT License
README.md This README File
SECURITY.md Microsoft Open Source Security Information & Details
sshd_config Container SSH Config File
SUPPORT.md Support Contact Information

Documentation

IPAM uses both Docsify and GitHub Pages to present the project documentation, which can be found here

Questions or Comments for the team?

The IPAM team welcomes questions and contributions from the community. We have set up a GitHub Discussions page here to make it easy to engage with the IPAM team without opening an issue.

FAQ

Why should I use IPAM? You realize that you do not have a clear picture as to what is deployed into your Azure environment and connected to your private IP address space. Or, you would like a way to easily manage, assign, and track your private IP addess space usage!

What does the roadmap for IPAM look like?

  • We are assessing leveraging Azure Container Apps for hosting the two containers that make up the IPAM application
  • We are assessing support for multiple Tenants, as today the tool is designed with a single Tenant in mind
  • We are working on capturing IP address infromation for resources that support hybrid connectivity (ie Gateways)

Who are the awesome people that built this solution?? Matt and Harvey are Architects at Microsoft! We are always on the look out for interesting ways to help our customers overcome their challenges!

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.