Create Feature Flag

How to create a feature flag.

Description

Create a new feature flag within the specified namespace (or the "default" namespace if unspecified). A feature flag is a group of one or more feature subgraphs. Each feature subgraph represents a replacement of a specific base subgraph that composes a federated graph.

Minimum Requirements

PackageMinimum version

Usage

A feature flag is disabled when created by default. To create and immediately enable a feature flag, include the --enabled flag. To enable after creation, see wgc ff enable.

wgc feature-flag create my-flag --feature-subgraphs my-graph-one my-graph-two

The alias for feature-flag is ff.

Note that unless specified by the --namespace parameter, the namespace will be automatically passed as "default".

If either the base composition (the Federated Graph with the original Subgraphs) or the Feature Flag composition fail, the Router Config will not be updated with the Feature Flag configuration.

Parameters

  • <name>: The name of the Feature Flag to create. Must be unique among all feature flags in the specified (otherwise "default") namespace.

Required Options

--fs, --feature-subgraphs: A list of names of the feature subgraphs that compose the feature flag. At least one feature subgraph name must be included, and multiple names are space delimited. Including a non-feature subgraph or a feature subgraph that does not exist in the specified (otherwise "default") namespace will produce an error.

Options

  • -n, --namespace : The namespace of the feature flag (defaults to "default"). Returns an error if the feature flag does not exist in that namespace.

  • -e --enabled: Activates the feature flag immediately upon creation. A new feature flag is disabled by default to prevent accidental compositions.

  • --label [labels...]:The labels to apply to the feature flag. The labels are passed in the format key=value, and multiple values are space delimited.

Example

Create the feature flag "my-flag" in the namespace "prod" with multiple feature subgraphs and the labels team=A and team=B:

wgc feature-flag create my-flag \
    --feature-subgraphs my-graph my-other-graph \
    -n prod
    --label team=A team=B

Last updated