Breakwater / Docs
Request early access

Products

Products represent your software offerings in Breakwater. Each product can be licensed to customers, giving them access to pull images from the associated repositories.

What is a Product?

A product is a logical grouping that represents something you sell. It could be:

  • A single application (e.g., "Enterprise Dashboard")
  • A suite of related tools (e.g., "Analytics Platform")
  • Different editions of the same software (e.g., "Pro Edition", "Enterprise Edition")

Products are linked to repositories, which contain the actual Docker images. When you license a product to a customer, they gain access to pull images from all repositories associated with that product.

Creating a Product

  1. Navigate to Products in the vendor portal
  2. Click New Product
  3. Fill in the product details:
    • Name (required): A descriptive name for your product
    • Slug: Auto-generated from the name, used in API references
    • Description: Optional details about the product
  4. Click Create Product

Product Fields

Name

The display name for your product. Choose something clear and recognizable to your customers, as they'll see this name on their licenses.

Slug

A URL-safe identifier auto-generated from the product name. For example, "Enterprise Dashboard" becomes enterprise-dashboard. The slug is used in:

  • API references
  • Internal identifiers

Slugs must be unique within your vendor account.

Description

An optional field for internal notes about the product. This is only visible to you and your team in the vendor portal.

Linking Repositories

Products must be linked to at least one repository before customers can pull images. You can link repositories in two ways:

  1. From the repository: When creating or editing a repository, select which products it belongs to
  2. View connections: On the product detail page, you'll see all linked repositories

A single repository can belong to multiple products, and a product can have multiple repositories. For example:

  • myapp repository linked to both "Standard Edition" and "Enterprise Edition" products
  • "Enterprise Edition" product linked to both myapp and myapp-addons repositories

Managing Products

Viewing Products

The Products page shows all your products with:

  • Product name
  • Number of active licenses
  • Associated repositories

Click on a product to see its details and license history.

Editing Products

  1. Click on the product to view details
  2. Click Edit
  3. Update the name or description
  4. Click Update Product

Note: Changing the product name does not affect existing licenses.

Deleting Products

  1. Click on the product to view details
  2. Click Delete
  3. Confirm the deletion

Deleting a product will also delete all associated licenses. This action cannot be undone.

Best Practices

Product Organization

  • One product per offering: Create separate products for each distinct thing you sell
  • Edition-based products: If you have multiple editions (Standard, Pro, Enterprise), create a product for each
  • Version-based products: For major version licensing (v1, v2), consider separate products combined with tag patterns

Naming Conventions

Use clear, consistent names that your customers will recognize:

  • Include edition names if applicable (e.g., "MyApp Enterprise")
  • Avoid version numbers in product names unless licensing by major version
  • Use descriptive names rather than internal code names