Works by default

1. You are here:
2. Handbook
3. Product Handbook
4. Works by default

Maintained by:

David DeSanto

@david

Works by default

Working by default is an important Product Principle, but we haven't always been successful in making sure features are both enabled by default and setup by default. This page is meant to help us measure and track out progress improving the product so that more features do work by default.

Legend

• ✅ Works by default (enabled by default, and setup by default)
• ⚙️ Setup required (feature must be setup by a user)
  • In application setup is required by a user before the feature can be used. Example: URL or API keys needed for integration with an external tool like Jira.
• 🔌 Installation required (feature must be enabled by an administrator on self-managed instances)
  • Installation of extra components on a host machine, or feature flags are off by default. Example: Changes to gitlab.rb are required to enable the feature.
• 📦 Setup and Installation required (feature must be enabled by an administrator, and setup by a user)
  • Both in application setup is required, and installation is required. Example: Gitaly Cluster requires Omnibus to be installed on additional machines, and in application storage settings to be modified.
• ❌ Not supported
• N/A Not applicable

It helps to consider these states using the following 2x2 table:

Manage

Authentication and Authorization

Import and Integrate

Foundations

Plan

Project Management

Product Planning

Knowledge

Optimize

Create

Source Code

Code Review

IDE

Verify

Pipeline Execution

Pipeline Authoring

Runner

Runner SaaS

Pipeline Security

Package

Package Registry

Container Registry

Deploy

Environments

Monitor

Respond

Observability

Secure

Static Analysis

Dynamic Analysis

Composition Analysis

Vulnerability Research

Govern

Security Policies

Threat Insights

Compliance

Anti-Abuse

Anti-Abuse

ModelOps

AI Assisted

MLOps

DataOps

Analytics

Analytics Instrumentation

Product Analytics

Growth

Acquisition

Activation

Fulfillment

Purchase

Provision

Utilization

Fulfillment Platform

Billing and Subscription Management

Systems

Distribution::Build

Distribution::Deploy

Gitaly::Cluster

Gitaly::Git

Geo

Data Stores

Application Performance

Global Search

Database

Tenant Scale

SaaS Platforms

Delivery

Scalability

GitLab Dedicated

Switchboard

US Public Sector Services

Mobile

Mobile DevOps

Deploy

Five Minute Production App

Low-Code/No-Code

No-code Automation

How it works

This page is generated from data/features.yml.

Any feature containing a valid works_by_default hash will be included in the table above.

# Example
  - title: "Fancy feature"
    description: |
      Just incredible. Miraculous some have said.
    works_by_default:
      gitlab_com: true
      omnibus: setup_required
      chart: install_required
      source: install_required
      gdk: false
      note: X, Y, and Z will make it work by default everywhere.

The works_by_default field supports the following attributes:

• gitlab_com, omnibus, chart, source, gdk, all
  • all is for convenience if they are all the same.
  • all can be set combination with other fields. The more specific field takes priority.
• note is a string with any comments or explanation

Supported statuses for these fields are:

• true - ✅ Works by default (enabled by default, and setup by default)
• setup_required - ⚙️ Setup required (feature must be setup by a user)
• install_required - 🔌 Installation required (feature must be enabled by an administrator)
• setup_and_install_required - 📦 Setup and Installation required (feature must be enabled by an administrator, and setup by a user)
• false - ❌ Not supported
• not_applicable - N/A

The features.schema.json schema provides basic validation and can be used with the YAML Language Server.