/eCloudDay1

This repository is meant to create a visualization network diagram service for AWS

Primary LanguagePythonMIT LicenseMIT

eCloudDay1 🌥️

Steps on how to use:

  1. Clone your repository:

    git clone https://github.com/B10715018/eCloudDay1.git

  2. Create virtual environment and activate it:

    python3 -m venv ./venv && source venv/bin/activate

  3. Install the dependencies:

    pip3 install -r requirements.txt

  4. Don't forget to configure your account:

    aws configure --profile

  5. To use some functionality, for example scan dynamodb:

    python dynamodb-scan.py

  6. Results data can be obtained in the data folder

  7. Please create a folder name data at the eCloudDay1 repositories it is where we could store all metadata in form of JSON

New Version (OOP Version)

  1. The design of class diagram can be find in docs folder in Diagram

Extra tool to clear all JSON file in data folder:

  1. make sure you have jobClearJSON.sh file in your directory

  2. execute this command in your terminal

chmod u+x ./tools/shell/jobClearJSON.sh
  1. run it using this command in your terminal
./tools/shell/jobClearJSON.sh

Github Action Workflow

  1. This is to automate checking test on every python file made.

  2. If there is error it will return failed test and will send email of failed test to the contributor who pushed or pull the request

  3. If all checks are passed, you may continue to create a pull request or else you need to fix your code first

Documentation on how to publish new Python Package to PYPI

Link to learn how to publish new Python package to PYPI

Documentation for migrating local to AWS Environment

Link to deploy to AWS from local

Documentation for automation ton upload to PYPI repositories

Link to deploy to PYPI repositories

Documentation for Docker Container and ECS could be found here

Link to Docker and ECS Documentation

Documentation on how to update the PYPI package

Link to Tutorial to update PYPI Package

Documentation on how to create CI/CD from local to EC2

Link to Tutorial to create CI/CD

Documentation to Fix Gateway Timeout Error

Link to Fix Gateway Timeout Error

Reference

THANK YOU ❤️