For the complete documentation index, see llms.txt. This page is also available as Markdown.

Managing Collections

List, enable, disable, and delete collections using the Bluebricks app or the Bricks CLI

Overview

Manage the lifecycle of your collections through the Bluebricks app or the bricks collection CLI commands. You can list all collections, check their status, and enable, disable, or delete them as your infrastructure needs change.

book

To create a new collection, see Creating Collections. For the conceptual overview, see Collections.

How to list collections

Open the Collections page in the Bluebricks app. The table shows all active collections with their cloud provider, cloud account, and latest deployment status. Use the filters to narrow results by status or provider.

# List active collections
bricks collection ls

# Include inactive and deleted collections
bricks collection ls --all

The command outputs a table with the following fields:

GUID                                NAME           CLOUD PROVIDER   CLOUD ACCOUNT   SLUG              STATUS
----------------------------------- -------------- ---------------- --------------- ----------------- -------------------------
env-uuid-123                        production    AWS              aws-prod        production        DEFAULT, web-app (running)
env-uuid-456                        development   AWS              aws-dev         development       api-service (completed)
env-uuid-789                        staging       GCP              gcp-staging     staging           INACTIVE
Field
Description

GUID

Unique identifier, used in API calls and some CLI commands (--id)

NAME

Display name set during creation

CLOUD PROVIDER

Connected provider (AWS, GCP, Azure). Shows - if no cloud account is connected

CLOUD ACCOUNT

Connected cloud account name. Shows - if none

SLUG

Short identifier used in CLI commands (--slug, --collection)

STATUS

Flags and latest deployment info (see below)

Status indicators

Indicator
Meaning

DEFAULT

Collection is the default target when --collection is omitted

INACTIVE

Collection is disabled

deployment-name (stage)

Most recent deployment and its current stage (running, completed, failed)

-

No deployments in this collection

Collection states

State
Description

Active

Collection is enabled and ready for deployments

Inactive

Collection is disabled; enable it before deploying

Default

Collection is the default target for bricks install when no --collection flag is specified

How to enable a collection

Reactivate a disabled (locked) collection so it can receive deployments again.

  1. Open the Collections page

  2. Click the three-dot menu on the inactive collection

  3. Click Unlock

  4. Confirm in the dialog

How to disable a collection

Disable (lock) a collection to prevent new deployments. Existing infrastructure is not affected.

  • Open the Collections page

  • Click the three-dot menu on the collection

  • Click Lock

  • Confirm in the dialog

How to delete a collection

Before deleting, destroy or archive all active environments in the collection. Bluebricks blocks deletion if any non-archived environments remain.

  1. Open the Collections page

  2. Click the three-dot menu on the collection

  3. Click Delete

  4. Review the list of associated deployments and confirm

The cloud account is not affected by the deletion. It remains available in your organization and can be added to a new collection at any time.

How to set a default collection

The default collection is used when you run bricks install without specifying --collection.

  1. Open the Collections page

  2. Click the three-dot menu on the collection

  3. Click Set as Default

  4. Confirm in the dialog

You can set a collection as the default during creation:

How to clone a collection

Duplicate an existing collection with its configuration.

Using the app

  1. Open the Collections page

  2. Click the three-dot menu on the collection

  3. Click Clone

  4. Confirm in the dialog

Last updated