Core Frappe Cloud DocTypes
Frappe Cloud uses several core DocTypes to manage sites, infrastructure, billing, deployments, and background operations. These DocTypes store important platform information and help administrators monitor and manage their cloud resources.
Overview
Each DocType represents a specific aspect of the Frappe Cloud platform, such as sites, benches, servers, subscriptions, invoices, backups, and deployment jobs.
Core DocTypes
| DocType | Purpose |
|---|---|
| Site | Stores information about an individual site, including its associated team, bench, server, subscription details, trial period, and current status. |
| Bench | Contains details about a bench, including deployment status, Docker build information, deployed applications, release version, and deployment candidates. |
| Release Group | Represents a logical grouping of benches that share the same application versions and release configuration. It serves as the parent entity for benches. |
| Agent Job | Tracks every automated operation performed by Frappe Cloud agents, including deployments, backups, restores, updates, and maintenance tasks along with their execution status. |
| Team | Stores information about an organization or team, including members, permissions, subscriptions, billing ownership, and managed resources. |
| Invoice | Records monthly billing information generated for sites, servers, marketplace applications, and other billable resources. |
| Subscription | Maintains details of the active plans, marketplace applications, and other recurring services subscribed to by a team. |
| Site Backup | Stores information about backup operations for a site, including backup status, timestamps, and associated backup agent jobs. |
Why These DocTypes Matter
These DocTypes form the foundation of Frappe Cloud’s management system. They enable administrators to monitor deployments, manage infrastructure, track billing, schedule backups, oversee subscriptions, and maintain the overall lifecycle of sites and servers from a unified platform.
Note
Most day-to-day actions performed through the Frappe Cloud dashboard such as creating sites, deploying benches, provisioning servers, generating invoices, or restoring backups are backed by these core DocTypes and their related background jobs.
