This commit is contained in:
Matthew Garrett 2022-06-21 00:22:59 -07:00
Родитель 6c9c37a592
Коммит 3cec3220f4
2 изменённых файлов: 25 добавлений и 66 удалений

Просмотреть файл

@ -13,7 +13,7 @@ description: "IPAM - Azure IP Address Management made easy!"
---
-->
# IPAM
# Azure IPAM
<!--
Guidelines on README format: https://review.docs.microsoft.com/help/onboard/admin/samples/concepts/readme-template?branch=master
@ -23,55 +23,55 @@ Guidance on onboarding samples to docs.microsoft.com/samples: https://review.doc
Taxonomies for products and languages: https://review.docs.microsoft.com/new-hope/information-architecture/metadata/taxonomies?branch=master
-->
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.
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 |
|----------------------|---------------------------------------------------------------|
| `.devcontainer/` | Dev container configuration |
| `.github/` | Bug report & issue templates |
| `.vscode/` | VSCode configuration |
| `deploy/` | Infrastructure Bicep files & PowerShell deployment scripts |
| `docs/` | Docsify Repo |
| `engine/` | Engine application code |
| `ui/` | UI application code |
| `.dockerignore` | Docker related files to ignore |
| `.gitignore` | Untracked Files to Ignore |
| `.github/` | Bug Report & Issue Templates |
| `.vscode/` | VSCode Configuration |
| `deploy/` | Deployment Bicep Templates & PowerShell Deployment Scripts |
| `docs/` | Documentation Folder |
| `engine/` | Engine Application Code |
| `ui/` | UI Application Code |
| `.dockerignore` | Untracked Docker Files to Ignore |
| `.gitignore` | Untracked Git Files to Ignore |
| `CODE_OF_CONDUCT.md` | Microsoft Code of Conduct |
| `default.conf` | ????????????????????????? |
| `default.dev.conf` | ????????????????????????? |
| `docker-compose.prod.yml` | Production Docker Compose file |
| `docker-compose.yml` | Development Docker Compose file |
| `Dockerfile` | Development Docker Compose file |
| `init.sh` | ??????????????????????????????? |
| `LICENSE` | MIT License |
| `default.conf` | NGINX Default Configuration File |
| `default.dev.conf` | NGINX Development Default Configuration File |
| `docker-compose.prod.yml` | Production Docker Compose File |
| `docker-compose.yml` | Development Docker Compose File |
| `Dockerfile` | Development 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` | ??????????????????????????????? |
| `SUPPORT.md` | Support contact information |
| `sshd_config` | Container SSH Config File |
| `SUPPORT.md` | Support Contact Information |
## Documentation
IPAM uses both [Docsify](https://docsify.js.org/) and [GitHub Pages](https://docs.github.com/en/github/working-with-github-pages) to present the project documentation, which can be found [here](https://azure.github.io/ipam/)
## 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](https://NEED_ACTUAL_LINK) to make it easy to engage with the IPAM team without opening an issue.
The IPAM team welcomes questions and contributions from the community. We have set up a GitHub Discussions page [here](https://github.com/Azure/ipam/discussions) 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 ssessing support for multiple Tenants, as today the tool is designed with a single Tenant in mind
- 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, Harvey, Chris and Tyler are all Architects at Microsoft! We are always on the look out for interesting ways to help our customers overcome their challenges!
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.

Просмотреть файл

@ -1,41 +0,0 @@
# Stage 1 - Build IPAM UI Code
FROM node:16-slim as ipam-ui-build
# Set Working Directory
WORKDIR /app
# Add `/app/node_modules/.bin` to $PATH
ENV PATH /app/node_modules/.bin:$PATH
# Copy Node Package Files
COPY package.json ./
COPY package-lock.json ./
# Install Dependencies
RUN npm install
# Copy Application Code
COPY . ./
# Build Application
RUN npm run build
# Stage 2 - Configure Nginx
FROM nginx:alpine
# Copy Nginx Config & IPAM Engine Code
COPY ./default.nginx.conf /etc/nginx/conf.d/default.conf
COPY --from=ipam-ui-build /app/build /usr/share/nginx/html
EXPOSE 80
# Execute Init Script
# CMD ["./init.sh"]
# CMD ["nginx", "-g", "daemon off;"]
CMD echo "window.env = {" >> /usr/share/nginx/html/env.js && \
echo \"REACT_APP_CLIENT_ID\": \"$CLIENT_ID\", >> /usr/share/nginx/html/env.js && \
echo \"REACT_APP_TENANT_ID\": \"$TENANT_ID\" >> /usr/share/nginx/html/env.js && \
echo "}" >> /usr/share/nginx/html/env.js && \
nginx -g "daemon off;"