=================
Deployment Groups
=================

A **deployment group** (DG) organizes deployments of the same *type* under a
project. For example, you might have one DG for your Postgres databases and
another for your Odoo application servers.

Group Types
===========

Each deployment group has a **type** that determines which Deployment Books and
configuration options are available:

- **pgo** — PostgreSQL Operator (Crunchy PGO) clusters.
- **odoo** — Odoo application deployments.
- **pxc** — Percona XtraDB Cluster (MySQL).
- **none** — generic / uncategorized.

Creating a Deployment Group
===========================

1. Open your project at ``/_eyrie/p/<slug>``.
2. Click **New Deployment Group**.
3. Enter a **name** and select a **type**.
4. Link one or more **clusters** that this group can deploy to.
5. Click **Create**.

The new group is automatically added to your favorites.

.. image:: /static/img/dg_list.png
   :alt: TODO — screenshot of the deployment group list

.. image:: /static/img/create_dg_dialog.png
   :alt: TODO — screenshot of the create deployment group dialog

Group-Level Settings
====================

On the DG detail page (``/_eyrie/p/<slug>/dg/<group>``), configure:

- **Repository** — a default code repository for deployments in this group.
- **Image Repository / Image** — the container image source.
- **Deployment Book** — the group-level book executed during cluster-wide
  operations.
- **Scopes** — see :doc:`scopes`.

Group State Lifecycle
=====================

A deployment group shares the same state model as individual deployments:

- **Draft** → **Initializing** → **Deployment** → **Paused**

.. image:: /static/img/dg_detail.png
   :alt: TODO — screenshot of the deployment group detail page