Skip to content

gomin0/Openstack-cloud-api

BranchesTags

Repository files navigation

OpenStack 기반 클라우드 서비스 제공 API 개발

📑 목차

1. 프로젝트 개요

2. 협업

3. 시스템 아키텍쳐 다이어그램

4. 사용 기술

4. 프로젝트 구조

5. ERD

6. 기능 목록

7. 기능 요구사항 & Sequence Diagram

8. 트러블 슈팅

📝 프로젝트 개요

본 프로젝트는 OpenStack API를 활용하여, 클라우드 인프라 자원을 생성, 관리할 수 있는 백엔드 서비스를 구축하는 것을 목표로 합니다.
사용자는 OpenStack의 복잡한 내부 구조를 직접 이해하거나 CLI를 다루지 않고도, 본 서비스를 통해 필요한 클라우드 자원을 손쉽게 조작할 수 있습니다.

  • FastAPI 기반의 RESTful API 서버를 개발하여, 외부 시스템 또는 사용자 인터페이스와의 통합이 용이하도록 설계하였습니다.
  • 내부적으로는 OpenStack의 Nova, Neutron, Cinder, Keystone 등의 API를 활용하여, 실제 자원 생성 및 상태 관리를 자동화합니다.
  • 사용자는 본 프로젝트의 API를 통해 가상 서버 생성, 볼륨 연결, 보안 그룹 설정, Floating IP 할당 등 주요 작업을 통합된 방식으로 수행할 수 있습니다.

🤝 협업

이름 GitHub
Ted(고민영) @gomin0
Woody(정재욱) @Wo-ogie

협업

Git Convention

  • Issue
    • 기능 단위 작업 세분화
  • Branch
    • Git-flow 전략
    • 모든 기능 branch 는 'develop' branch 에서 분기하여 작업
    • ex) feature/#{Issue 번호}
  • Merge Request
    • Issue 단위 작업 후 MR
    • Code Review 후 'develop' branch 로 merge

🏗 시스템 아키텍쳐 다이어그램

시스템 아키텍쳐

🛠 사용 기술

  • GitLab
  • python3
  • poetry
  • fastapi
  • mysql8
  • pytest / unittest, testcontainers
  • OpenStack

📁 프로젝트 구조

이 프로젝트는 계층형 구조(Layered Architecture)를 기반으로 설계되었으며, 구조를 크게 세 부분으로 나누어 책임을 분리하였습니다.

  1. api_server: 사용자의 요청을 받는 API 레이어
  2. batch_server: 배치 작업 레이어
  3. common: 핵심 도메인 로직 및 인프라 연결 레이어
openstack-cloud-api/
├── api_server/
│   ├── router/
│   ├── exception_handler.py
│   └── main.py
│ 
├── batch_server/
│ 
├── common/
│   ├── application/
│   ├── domain/
│   ├── exception/
│   ├── infrastructure/
│   └── util/
│ 
├── docs/
│ 
└── test/
    ├── end_to_end/
    ├── unit/
    └── util/

🗃 ERD

erDiagram
    project }o--|| domain: ""
    user }o--o| domain: ""
    project_user }o--|| project: ""
    project_user }o--|| user: ""
    network_interface }o--|| project: ""
    network_interface }o--|| server: ""
    security_group }o--|| project: ""
    network_interface_security_group }o--|| network_interface: ""
    network_interface_security_group }o--|| security_group: ""
    floating_ip |o--o| network_interface: ""
    floating_ip }o--|| project: ""
    server }o--|| project: ""
    volume }o--|| project: ""
    volume }o--o| server: ""

    domain {
        id BIGINT PK
        openstack_id CHAR(32)
        name VARCHAR(255)
        created_at DATETIME
        updated_at DATETIME
        deleted_at DATETIME "Nullable"
    }

    project {
        id BIGINT PK
        openstack_id CHAR(32)
        domain_id BIGINT FK
        name VARCHAR(255)
        created_at DATETIME
        updated_at DATETIME
        deleted_at DATETIME "Nullable"
        version INT
    }

    user {
        id BIGINT PK
        openstack_id CHAR(32)
        domain_id BIGINT FK
        account_id VARCHAR(20)
        name VARCHAR(15)
        password VARCHAR(255)
        created_at DATETIME
        updated_at DATETIME
        deleted_at DATETIME "Nullable"
    }

    project_user {
        id BIGINT PK
        user_id BIGINT FK
        project_id BIGINT FK
        created_at DATETIME
        updated_at DATETIME
    }

    server {
        id BIGINT PK
        openstack_id CHAR(36)
        project_id BIGINT FK
        flavor_openstack_id CHAR(36)
        name VARCHAR(255)
        description VARCHAR(255)
        status VARCHAR(30)
        created_at DATETIME
        updated_at DATETIME
        deleted_at DATETIME "Nullable"
    }

    network_interface {
        id BIGINT PK
        openstack_id CHAR(36)
        project_id BIGINT FK
        server_id BIGINT FK "Nullable"
        fixed_ip_address VARCHAR(15)
        created_at DATETIME
        updated_at DATETIME
        deleted_at DATETIME "Nullable"
    }

    volume {
        id BIGINT PK
        openstack_id CHAR(36)
        project_id BIGINT FK
        server_id BIGINT FK "Nullable"
        image_id BIGINT FK "Nullable"
        volume_type_openstack_id CHAR(36)
        name VARCHAR(255)
        description VARCHAR(255)
        status VARCHAR(30)
        size INT
        is_root_volume TINYINT(1)
        created_at DATETIME
        updated_at DATETIME
        deleted_at DATETIME "Nullable"
    }

    security_group {
        id BIGINT PK
        openstack_id CHAR(36)
        project_id BIGINT FK
        name VARCHAR(255)
        description VARCHAR(255)
        created_at DATETIME
        updated_at DATETIME
        deleted_at DATETIME "Nullable"
        version INT
    }

    network_interface_security_group {
        id BIGINT PK
        network_interface_id BIGINT FK
        security_group_id BIGINT FK
        created_at DATETIME
        updated_at DATETIME
    }

    floating_ip {
        id BIGINT PK
        openstack_id CHAR(36)
        project_id BIGINT FK
        network_interface_id BIGINT FK "Nullable"
        status VARCHAR(30)
        address VARCHAR(15)
        created_at DATETIME
        updated_at DATETIME
        deleted_at DATETIME "Nullable"
    }
Loading

📮 기능 목록

Project API

API 명 HTTP method Endpoint 응답 상태 코드
프로젝트 목록 조회 GET /projects 200
프로젝트 단일 조회 GET /projects/{project_id} 200
프로젝트 변경 PUT /projects/{project_id} 200
프로젝트에 유저 소속 POST /projects/{project_id}/users/{user_id} 204
프로젝트에 유저 제외 DELETE /projects/{project_id}/users/{user_id} 204

User API

API 명 HTTP method Endpoint 응답 상태 코드
유저 목록 조회 GET /users 200
유저 단일 조회 GET /users/{user_id} 200
회원 가입 POST /users 201
유저 삭제 DELETE /users/{user_id} 204
유저 정보 변경 PUT /users/{user_id}/info 200

Auth API

API 명 HTTP method Endpoint 응답 상태 코드
로그인 POST /auth/login 200

Server API

API 명 HTTP method Endpoint 응답 상태 코드
서버 목록 조회 GET /servers 200
서버 생성 POST /servers 202
서버 단일 조회 GET /servers/{server_id} 200
서버 삭제 DELETE /servers/{server_id} 202
서버 정보 변경 PUT /servers/{server_id}/info 200
서버 상태 변경 PUT /servers/{server_id}/status 202
서버 VNC 접속 기능 GET /servers/{server_id}/vnc-url 200

Volume API

API 명 HTTP method Endpoint 응답 상태 코드
볼륨 목록 조회 GET /volumes 200
볼륨 단일 조회 GET /volumes/{volume_id} 200
볼륨 생성 POST /volumes 202
볼륨 삭제 DELETE /volumes/{volume_id} 204
볼륨 정보 변경 PUT /volumes/{volume_id}/info 200
볼륨 용량 변경 PUT /volumes/{volume_id}/size 200
서버에 볼륨 연결 POST /servers/{server_id}/volumes/{volume_id} 200
서버에 볼륨 연결 해제 DELETE /servers/{server_id}/volumes/{volume_id} 200

NIC API

API 명 HTTP method Endpoint 응답 상태 코드
NIC에 플로팅 IP 연결 POST /network-interfaces/{network_interface_id}/floating-ips/{floating_ip_id} 204
NIC에 플로팅 IP 연결 해제 DELETE /network-interfaces/{network_interface_id}/floating-ips/{floating_ip_id} 204

Floating IP API

API 명 HTTP method Endpoint 응답 상태 코드
플로팅 IP 목록 조회 GET /floating-ips 200
플로팅 IP 할당 POST /floating-ips 201
플로팅 IP 단일 조회 GET /floating-ips/{floating_ip_id} 200
플로팅 IP 할당 해제 DELETE /floating-ips/{floating_ip_id} 204

Security Group API

API 명 HTTP method Endpoint 응답 상태 코드
보안그룹 목록 조회 GET /security-groups 200
보안그룹 생성 POST /security-groups 201
보안그룹 단일 조회 GET /security-groups/{security_group_id} 200
보안그룹 변경 PUT /security-groups/{security_group_id} 200
보안그룹 삭제 DELETE /security-groups/{security_group_id} 204

🎯 기능 요구사항 & Sequence Diagram

계정 관리

자원 관리

🐛 트러블 슈팅

About

OpenStack API를 활용하여, 클라우드 인프라 자원을 생성, 관리할 수 있는 백엔드 서비스 구축

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages