Development Guide

Introduction to development processes, service component structures, code frameworks and other technical details

📄️ Setting Up Development Environment

Introduction to how to set up a development environment, compile and deploy related components.

📄️ Contributing Code

Introduction to the process of creating pull requests and submitting code from GitHub.

📄️ Git Commit Content Standards

To facilitate viewing commit records and future statistics, we have established the following standards for writing Git commit content. Please follow the following format when submitting code.

📄️ GitHub Issues Usage Guide

Introduction to cloudpods issues processing logic and usage methods.

📄️ Service Component Introduction

Introduction to the architecture and functions of platform core components.

📄️ Manual Deployment of Development Cluster

This article introduces the steps for manually deploying a service cluster for development and testing purposes.

📄️ Add Option Support for External Table Queries

For sorting functionality within tables, it can be achieved through orderby&&order, but for external table association query functionality, orderby&&order is no longer sufficient. Therefore, additional fields need to be added to implement association query functionality. This example uses disk association with guest sorted by total guest count as an example.

📄️ Backend Service Framework

Introduction to the framework and related libraries used by cloud platform backend services. It is recommended to first read Development Guide/Service Component Introduction to understand the general functions of each service.

📄️ Resource Model

Cloud platform resources are roughly divided into "virtual resources" and "infrastructure" two types. Only with infrastructure-type resources can virtualized resources be built on top of them. Specific classifications are as follows:

📄️ Code Structure

Backend Code Structure

📄️ Troubleshooting Tools

This section introduces tools and APIs that help debug service programs.

📄️ Operator Introduction

When services all run in K8s clusters, there's a deployment called cloudpods-operator, used to deploy and control K8S resources needed by other services. Here we introduce the operations of this operator component.

📄️ Ceph Integration

Introduction to integrating non-standard ceph rbd storage (Venustech, SandStone and other storage vendors).

📄️ Locate Backend Code

Introduction to how to locate backend code from frontend API requests.

📄️ Process of Adding an API

This article uses DNS record export to Zone format file as an example to introduce how to add an API.

🗃️ Multi-Cloud Resource Integration

4 items

📄️ Webhook

Introduces the platform event callback mechanism.

📄️ host-image Service Compilation

The host-image service is a component of cloudpods for remotely mounting disks. It depends on the libqemuio library compiled based on qemu. This article introduces how to compile host-image.

🗃️ Monitoring

1 item

🗃️ CHANGELOG

8 items