Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

code structure reference updated with new changes #147

Merged
merged 2 commits into from
Oct 1, 2023
Merged

code structure reference updated with new changes #147

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
710c754
code structure reference updated with new changes
Madhura-saw Oct 1, 2023
b611264
new changes made and large differences removed
Madhura-saw Oct 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 35 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,20 +239,27 @@ Reference Code Structure

```bash

├── CONTRIBUTING.md <-- How to contribute to Trapheus
├── LICENSE.md <-- The MIT license.
├── README.md <-- The Readme file.
├── events
│   └── event.json <-- JSON event file to be used for local SAM testing
├── docs <-- The Readme files
│   ├── README.fr.md
│   └── README.zh-CN.md
├── install.py
├── labs
namitad marked this conversation as resolved.
Show resolved Hide resolved
├── presentation
│   └── Trapheus.pptx
├── requirements.txt
├── screenshots <-- Folder for screenshots of teh state machine.
│   ├── Trapheus-logo.png
│   ├── Trapheus.gif
│   ├── Trapheus.png
│   ├── cluster_restore.png
│   ├── cluster_snapshot_branch.png
│   ├── failure_handling.png
│   ├── instance_restore.png
│   ├── instance_snapshot_branch.png
│   ├── isCluster_branching.png
│   └── restore_state_machine.png
├── setup.py
├── src
│   ├── checkstatus
│   │   ├── DBClusterStatusWaiter.py <-- Python Waiter(https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters) for checking the status of the cluster
Expand Down Expand Up @@ -282,24 +289,30 @@ Reference Code Structure
│   ├── cluster_snapshot_function.py <-- Python Lambda code for creating a snapshot of a clusterised database.
│   └── snapshot_function.py <-- Python Lambda code for creating a snapshot of a non-clusterised RDS instance.
├── template.yaml <-- SAM template definition for the entire state machine.
└── tests <-- Test folder.
└── tests
└── unit
├── mock_constants.py
├── mock_custom_exceptions.py
├── mock_import.py
├── mock_utility.py
├── test_cluster_delete_function.py
├── test_cluster_rename_function.py
├── test_cluster_restore_function.py
├── test_cluster_snapshot_function.py
├── test_delete_function.py
├── test_email_function.py
├── test_get_dbcluster_status_function.py
├── test_get_dbstatus_function.py
├── test_rename_function.py
├── test_restore_function.py
├── test_slack_notification.py
└── test_snapshot_function.py
├── checkstatus
│   ├── test_get_dbcluster_status_function.py
│   └── test_get_dbstatus_function.py
├── delete
│   ├── test_cluster_delete_function.py
│   └── test_delete_function.py
├── emailalert
│   └── test_email_function.py
├── export
│   ├── test_export_cluster_snapshot_s3_function.py
│   └── test_export_snapshot_s3_function.py
├── rename
│   ├── test_cluster_rename_function.py
│   └── test_rename_function.py
├── restore
│   ├── test_cluster_restore_function.py
│   └── test_restore_function.py
├── slackNotification
│   └── test_slack_notification.py
└── snapshot
├── test_cluster_snapshot_function.py
└── test_snapshot_function.py

```

Expand Down Expand Up @@ -362,6 +375,4 @@ Prepare your environment. Install tools as needed.

<a href="https://github.com/intuit/Trapheus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=intuit/Trapheus" />
</a>


</a>