# mohankumarpaluru/oracle-freetier-instance-creation architecture

> Architecture diagram of the GitHub repository mohankumarpaluru/oracle-freetier-instance-creation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mohankumarpaluru/oracle-freetier-instance-creation
- Repository: https://github.com/mohankumarpaluru/oracle-freetier-instance-creation

## Overview

This is a compact OCI instance-creation automation script. Its main workflow loads configuration, checks for an existing instance, discovers eligible OCI resources, prepares SSH access, and retries instance launch until successful; it then records instance details and can notify the operator. The README documents configuration generation and OS/shape selection, while sampled code confirms OCI client setup, resource lookup, launch, error handling, and notification helpers. The graph groups logical responsibilities within main.py; unsampled internals are represented only where the README documents them.

Main entry points: [`main.py`](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py) (Creation Script), [`setup_env.sh`](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/setup_env.sh) (Config Generator), [`oci.env`](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/oci.env) (Environment Settings)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Configuration"]
  node_config_generator["Config Generator<br/>[setup_env.sh]"]
  node_settings["Environment Settings<br/>[oci.env]"]
end

subgraph group_workflow["Creation Workflow"]
  node_runner["Creation Script<br/>[main.py]"]
  node_instance_check["Existing Instance Check<br/>[main.py]"]
  node_ssh_access["SSH Key Preparation<br/>[main.py]"]
  node_retry_handler["Retry and Errors<br/>[main.py]"]
end

subgraph group_oci["OCI Operations"]
  node_resource_lookup["Resource Discovery<br/>[main.py]"]
  node_instance_launch["Instance Launch<br/>[main.py]"]
end

subgraph group_notify["Results and Alerts"]
  node_instance_record["Creation Record<br/>[main.py]"]
  node_email_notice["Email Notification<br/>[main.py]"]
  node_discord_notice["Discord Notification<br/>[main.py]"]
end

node_operator(("Operator"))
node_oci_cloud["Oracle Cloud"]
node_gmail["Gmail SMTP"]
node_discord["Discord Webhook"]

node_operator -->|"configures"| node_config_generator
node_config_generator -->|"writes settings"| node_settings
node_operator -->|"starts"| node_runner
node_settings -->|"loads settings"| node_runner
node_runner -->|"checks instance"| node_instance_check
node_instance_check -->|"records existing"| node_instance_record
node_instance_check -->|"prepares keys"| node_ssh_access
node_ssh_access -->|"continues setup"| node_resource_lookup
node_resource_lookup -->|"queries resources"| node_oci_cloud
node_runner -->|"requests launch"| node_instance_launch
node_instance_launch -->|"launches instance"| node_oci_cloud
node_runner -->|"handles errors"| node_retry_handler
node_retry_handler -->|"retries launch"| node_instance_launch
node_instance_launch -->|"records success"| node_instance_record
node_instance_record -->|"notifies success"| node_email_notice
node_email_notice -.->|"sends email"| node_gmail
node_runner -->|"posts alert"| node_discord_notice
node_discord_notice -->|"posts webhook"| node_discord

click node_config_generator "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/setup_env.sh"
click node_settings "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/oci.env"
click node_runner "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"
click node_instance_check "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"
click node_ssh_access "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"
click node_resource_lookup "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"
click node_instance_launch "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"
click node_retry_handler "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"
click node_instance_record "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"
click node_email_notice "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"
click node_discord_notice "https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_config_generator,node_settings toneBlue
class node_runner,node_instance_check,node_ssh_access,node_retry_handler toneAmber
class node_resource_lookup,node_instance_launch,node_discord toneMint
class node_instance_record,node_email_notice,node_discord_notice toneRose
class node_operator,node_oci_cloud,node_gmail toneIndigo
```

## Components

### Configuration

- [Config Generator](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/setup_env.sh): `setup_env.sh`
- [Environment Settings](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/oci.env): `oci.env`

### Creation Workflow

- [Creation Script](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`
- [Existing Instance Check](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`
- [SSH Key Preparation](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`
- [Retry and Errors](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`

### OCI Operations

- [Resource Discovery](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`
- [Instance Launch](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`

### Results and Alerts

- [Creation Record](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`
- [Email Notification](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`
- [Discord Notification](https://github.com/mohankumarpaluru/oracle-freetier-instance-creation/blob/main/main.py): `main.py`

### Other components

- **Operator**
- **Oracle Cloud**
- **Gmail SMTP**
- **Discord Webhook**

## Connections

- Operator → Config Generator: configures (evidence: `README.md`)
- Config Generator → Environment Settings: writes settings (evidence: `README.md`)
- Operator → Creation Script: starts (evidence: `README.md`)
- Environment Settings → Creation Script: loads settings (evidence: `main.py`)
- Creation Script → Existing Instance Check: checks instance (evidence: `README.md`)
- Existing Instance Check → Creation Record: records existing (evidence: `README.md`)
- Existing Instance Check → SSH Key Preparation: prepares keys (evidence: `README.md`)
- SSH Key Preparation → Resource Discovery: continues setup (evidence: `README.md`)
- Resource Discovery → Oracle Cloud: queries resources (evidence: `main.py`)
- Creation Script → Instance Launch: requests launch (evidence: `main.py`)
- Instance Launch → Oracle Cloud: launches instance (evidence: `main.py`)
- Creation Script → Retry and Errors: handles errors (evidence: `README.md`)
- Retry and Errors → Instance Launch: retries launch (evidence: `README.md`)
- Instance Launch → Creation Record: records success (evidence: `main.py`)
- Creation Record → Email Notification: notifies success (evidence: `main.py`)
- Email Notification → Gmail SMTP: sends email (evidence: `README.md`)
- Creation Script → Discord Notification: posts alert (evidence: `main.py`)
- Discord Notification → Discord Webhook: posts webhook (evidence: `main.py`)
