csye7125-fall2023-group05/architecture

Diagram as code to create version controlled infrastructure architecture diagrams with audit trails.

Architecture

To create version controlled infrastructure architecture diagrams, and have proper audit trails, we make use of a new concept called Diagram as Code or DaC.

This is still a work in progress, for implementation details, visit Diagrams, which lets us create diagrams programmatically using Python.

Setup

The only pre-requisite is you need to have python installed on your workstation. To setup the python environment for development, we need to install a few tools. Let's set them up:

• Install Poetry:

  # This is only for MacOS users, for other distros, refer the documentation
  brew install poetry

• Run init to initialize the project, similar to npm init as in the case of npm:

  # This command will guide you through creating your `pyproject.toml` config.
  poetry init

• Add the Diagrams library to the poetry pyproject.toml file:

  # This command will create a virtualenv at $HOME/Library/Caches/pypoetry/virtualenvs/
  poetry add diagrams

• To view the python environment path and executable location for your python project's virtualenv, use the env info command:

  poetry env info

• To run the python file with the DaC definition, we need to set the python interpreter path in VSCode. Use cmd + shift + p to open up the command palette, and then type: Python: Select Interpreter -> click on Enter interpreter path... and then copy and paste the virtualenv executable path here by running the command in the previous step, i.e, poetry env info. This will help setup the default interpreter to use the exact virtualenv for your specified project.

Architecture Diagram

LICENSE

This project is open-sourced under the MIT License. Please read the LICENSE for further details.

Authors

Siddharth Rawat

Rishab Agarwal

Karan Wadhwa

architecture's Issues

🧯 GH_TOKEN for semantic release should be a PAT

Use the PAT (Personal Access Token) created for the organization GitHub app, to be used as a GH_TOKEN when performing semantic release to GitHub releases.

This should prevent the sematic-release action from failing.

Important

Create a repository secret GH_PAT_TOKEN to be used as the github_token in the actions manifest file.

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Missing name property in package.json.

The package.json's name property is required in order to publish a package to the npm registry.

Please make sure to add a valid name for your package in your package.json.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

🏅 Architecture Diagram

Include basic overview of Kubernetes resources used to showcase a better understanding of the product.