# openstack/devstack architecture

> Architecture diagram of the GitHub repository openstack/devstack, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/openstack/devstack
- Repository: https://github.com/openstack/devstack

## Overview

##### Main Components

a) Core Infrastructure Layer:
- Stack Management Scripts (stack.sh, unstack.sh)
- Configuration Management (local.conf, stackrc)
- User Management System (stack user, tempest user)

b) Service Components:
- OpenStack Core Services:
- Nova (Compute)
- Neutron (Networking)
- Keystone (Identity)
- Glance (Image)
- Cinder (Block Storage)
- Horizon (Dashboard)
- Swift (Object Storage)
- Placement

c) Plugin Architecture:
- Neutron Plugins
- Nova Plugins
- Cinder Plugins/Backends

d) Support Systems:
- Database Layer (MySQL/PostgreSQL)
- Message Queue
- Apache Server
- Authentication (LDAP support)

**┌─ DevStack Orchestration Layer ─────────────────────┐**
- ┌─ Configuration ─┐ ┌─ Deployment Scripts ──────┐ │
- local.conf    │ │ - stack.sh               │ │
- stackrc       │ │ - unstack.sh             │ │
- ┘ └────────────────────────────┘ │
- Infrastructure Services ────────────────────────┐ │
- ┌─ Database ─┐ ┌─ Message Queue ┐ ┌─ Apache ──┐ │ │
- MySQL      │ │ RabbitMQ      │ │ Web Server│ │ │
- ┘ └───────────────┘ └───────────┘ │ │
- OpenStack Core Services ────────────────────────┤ │
- ┌─ Control Plane ─────────────────────────────┐ │ │
- Keystone │ Glance │ Nova API │ Neutron API │ │ │
- ┘ │ │
- ┌─ Storage Services ──────────────────────────┐ │ │
- Cinder │ Swift │ Block Storage Backends    │ │ │
- ┘ │ │
- ┘

##### Key Elements to Highlight

- Blue: Core OpenStack services
- Green: Infrastructure services
- Orange: DevStack management components
- Purple: Plugin systems

- Configuration flow from local.conf to services
- API communications between services
- Storage access patterns

##### Important Relationships

- How stack.sh orchestrates the entire deployment
- Plugin architecture and extension points
- Demonstrate the relationship between core services
- How authentication flows through the system

##### Implementation Details

- Use standardized symbols for databases, APIs, and services
- Clear labels for each component
- Configuration file locations and relationships
- Required vs optional components

##### Deployment Flow

A separate section showing the deployment sequence:

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph DevStack["DevStack Orchestration Layer"]
        Config["Configuration Management"]:::config
        Scripts["Deployment Scripts"]:::scripts
        
        subgraph Infrastructure["Infrastructure Services"]
            DB[(Database Layer)]:::infra
            MQ[Message Queue]:::infra
            Apache[Apache Server]:::infra
            LDAP[LDAP Support]:::infra
        end
        
        subgraph CoreServices["OpenStack Core Services"]
            subgraph ControlPlane["Control Plane"]
                Keystone[Keystone]:::core
                Glance[Glance]:::core
                Nova[Nova]:::core
                Neutron[Neutron]:::core
                Placement[Placement]:::core
            end
            
            subgraph Storage["Storage Services"]
                Cinder[Cinder]:::core
                Swift[Swift]:::core
                Horizon[Horizon]:::core
            end
        end
        
        subgraph Plugins["Plugin Architecture"]
            NeutronPlugins[Neutron Plugins]:::plugin
            NovaPlugins[Nova Plugins]:::plugin
            CinderPlugins[Cinder Plugins]:::plugin
        end
    end
    
    Config --> Scripts
    Scripts --> Infrastructure
    Infrastructure --> CoreServices
    CoreServices --> Plugins
    
    %% Component relationships
    DB --> CoreServices
    MQ --> CoreServices
    Apache --> CoreServices
    LDAP --> Keystone
    
    %% Plugin relationships
    NeutronPlugins --> Neutron
    NovaPlugins --> Nova
    CinderPlugins --> Cinder
    
    %% Style definitions
    classDef config fill:#ff9900,stroke:#333,stroke-width:2px
    classDef scripts fill:#ff9900,stroke:#333,stroke-width:2px
    classDef infra fill:#90EE90,stroke:#333,stroke-width:2px
    classDef core fill:#87CEEB,stroke:#333,stroke-width:2px
    classDef plugin fill:#DDA0DD,stroke:#333,stroke-width:2px
    
    %% Click events
    click Config "https://github.com/openstack/devstack/tree/master//stackrc"
    click Scripts "https://github.com/openstack/devstack/blob/master//stack.sh"
    click DB "https://github.com/openstack/devstack/tree/master//lib/databases"
    click Apache "https://github.com/openstack/devstack/tree/master//lib/apache"
    click LDAP "https://github.com/openstack/devstack/tree/master//lib/ldap"
    click MQ "https://github.com/openstack/devstack/tree/master//lib/rpc_backend"
    click Keystone "https://github.com/openstack/devstack/tree/master//lib/keystone"
    click Glance "https://github.com/openstack/devstack/tree/master//lib/glance"
    click Nova "https://github.com/openstack/devstack/tree/master//lib/nova"
    click Neutron "https://github.com/openstack/devstack/tree/master//lib/neutron"
    click Placement "https://github.com/openstack/devstack/tree/master//lib/placement"
    click Cinder "https://github.com/openstack/devstack/tree/master//lib/cinder"
    click Swift "https://github.com/openstack/devstack/tree/master//lib/swift"
    click Horizon "https://github.com/openstack/devstack/tree/master//lib/horizon"
    click NeutronPlugins "https://github.com/openstack/devstack/tree/master//lib/neutron_plugins"
    click NovaPlugins "https://github.com/openstack/devstack/tree/master//lib/nova_plugins"
    click CinderPlugins "https://github.com/openstack/devstack/tree/master//lib/cinder_plugins"
```
