Flipt

https://docs.flipt.io/
Admin
Flipt is a Git-native, self-hosted feature management platform that allows developers to manage...
Tokens:66,310
Snippets:752
Trust Score:8.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Flipt CLI Examples

Source: https://docs.flipt.io/v2/cli/overview

Examples demonstrating how to get help, start the server, and start the server with a configuration file.

```bash
$ flipt --help
```

```bash
$ flipt server
```

```bash
$ flipt server --config /path/to/config.yml
```

--------------------------------

### Run Flipt Quickstart Command

Source: https://docs.flipt.io/v2/cli/commands/quickstart

Execute the Flipt quickstart command to launch the interactive setup wizard. Optionally, specify a configuration file path.

```bash
flipt quickstart
```

```bash
flipt quickstart --config /path/to/config.yml
```

--------------------------------

### Setup Flipt in GitHub Actions

Source: https://docs.flipt.io/v2/tooling/github-actions

Use the flipt-setup-action to install Flipt v2 in your GitHub workflow. This allows you to use Flipt CLI commands directly. Specify the version to install.

```yaml
validate:
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@v4

    - uses: flipt-io/setup-action@v0.5.0
      with:
        version: v2 # Installs the latest v2 release
      # Optional, additional arguments to pass to the `flipt` command
      # args:
      # Optional, the directory to run Flipt against, defaults to the repository root
      # working-directory:

    - run: flipt validate
```

--------------------------------

### Install Flipt v2 using Docker

Source: https://docs.flipt.io/v2/installation

Run the Flipt v2 Docker image to start a container. This command maps ports and mounts a volume for persistent data storage.

```console
docker run -d \
    -p 8080:8080 \
    -p 9000:9000 \
    -v $HOME/flipt:/var/opt/flipt \
    docker.flipt.io/flipt/flipt:v2
```

--------------------------------

### Flipt Quickstart Command Options

Source: https://docs.flipt.io/v2/cli/commands/quickstart

Available options for the `flipt quickstart` command include specifying a configuration file path or accessing help.

```bash
      --config string   path to config file
  -h, --help            help for quickstart
```

--------------------------------

### Run Flipt v2 server with Homebrew

Source: https://docs.flipt.io/v2/installation

Start the Flipt v2 server after installation via Homebrew. An optional configuration file path can be provided.

```console
flipt server [--config OPTIONAL_PATH_TO_YOUR_CONFIG]
```

--------------------------------

### Install Flipt v2 using Kubernetes/Helm

Source: https://docs.flipt.io/v2/installation

Add the Flipt Helm repository and install Flipt v2 using Helm.

```console
helm repo add flipt https://helm.flipt.io
helm install my-flipt-v2 flipt/flipt-v2
```

--------------------------------

### Flipt Quickstart Command Synopsis

Source: https://docs.flipt.io/v2/cli/commands/quickstart

The `flipt quickstart` command initiates an interactive, text-based wizard for configuring Flipt v2 with Git storage and SCM integration.

```bash
flipt quickstart [flags]
```

--------------------------------

### Install Flipt v2 with Helm

Source: https://docs.flipt.io/v2/installation

Install Flipt v2 using the Helm chart. You can install with default settings or provide a custom values.yaml file.

```bash
# Install Flipt v2
helm install my-flipt-v2 flipt/flipt-v2

# Or with custom configuration
helm install my-flipt-v2 flipt/flipt-v2 -f values.yaml
```

--------------------------------

### Start Flipt Server

Source: https://docs.flipt.io/v2/guides/operations/environments/git-repository-initialization

Run the Flipt server with the specified configuration file. Ensure you are in the project's root directory.

```bash
cd ..  # Back to my-project directory
flipt server --config config.yml
```

--------------------------------

### Install Flipt v2 CLI

Source: https://docs.flipt.io/v2/cli/overview

Use this command to install the Flipt v2 CLI binary. It's recommended for local development and CI/CD.

```bash
curl -fsSL https://get.flipt.io/v2 | sh
```

--------------------------------

### Flipt v2 Docker Configuration Example

Source: https://docs.flipt.io/v2/installation

Example of a custom configuration file for Flipt v2 when using Docker, specifying the local storage backend and path.

```yaml
storage:
  default:
    backend:
      type: local
      path: /var/opt/flipt
```

--------------------------------

### Install Flipt v2 using Homebrew

Source: https://docs.flipt.io/v2/installation

Install Flipt v2 on macOS and Linux using Homebrew. Ensure Flipt v1 is unlinked if previously installed.

```console
brew install flipt-io/brew/flipt@2
```

--------------------------------

### Run Flipt Server

Source: https://docs.flipt.io/v2/cli/commands/server

Starts the Flipt server. Use the --config flag to specify a custom configuration file path.

```bash
flipt server [flags]
```

```bash
flipt server
```

```bash
flipt server --config /path/to/config.yml
```

--------------------------------

### Example Flipt v2 Pod Status

Source: https://docs.flipt.io/v2/guides/operations/deployment/deploy-to-kubernetes

This is an example output showing a Flipt v2 pod with a 'Running' status and its age.

```console
NAME                         READY   STATUS    RESTARTS   AGE
flipt-v2-6d64f856d7-4l5qn    1/1     Running   0          32m
```

--------------------------------

### Flipt v2 Custom Configuration Example

Source: https://docs.flipt.io/v2/guides/operations/deployment/deploy-to-kubernetes

Example `values.yaml` file for customizing Flipt v2 deployment. Configure logging, server ports, CORS, UI, telemetry, metrics, and storage.

```yaml
flipt:
  config:
    log:
      level: INFO
      encoding: json
    server:
      grpc_port: 9000
      http_port: 8080
    cors:
      enabled: true
      allowed_origins:
        - "http://localhost:3000"
        - "https://your-frontend-domain.com"
    ui:
      default_theme: dark
      topbar:
        color: "#7C3AED"
    meta:
      check_for_updates: false
      telemetry_enabled: false
    metrics:
      enabled: true
      exporter: prometheus
    storage:
      default:
        backend:
          type: memory
```

--------------------------------

### Example Configuration Settings

Source: https://docs.flipt.io/v2/configuration/overview

Example YAML configuration showing server settings with grpc_port set to 9000. This is used to illustrate how to override settings with environment variables.

```yaml
server:
  grpc_port: 9000
```

--------------------------------

### Install Flipt v2 with Helm

Source: https://docs.flipt.io/v2/guides/operations/deployment/deploy-to-kubernetes

Install the Flipt v2 Helm chart. Use the '-f values.yaml' flag to apply custom configurations or omit it to use default settings.

```bash
# Install with custom values
helm install flipt-v2 flipt/flipt-v2 -f values.yaml

# Or install with default settings
helm install flipt-v2 flipt/flipt-v2
```

--------------------------------

### Start Flipt v2 Server

Source: https://docs.flipt.io/v2/guides/migration/cloud/flipt-cloud-to-v2

Launch the Flipt v2 server using the '--config' flag to specify your configuration file. This will clone the repository and load feature flag data.

```bash
./flipt server --config config.yaml
```

--------------------------------

### Start server with remote configuration

Source: https://docs.flipt.io/v2/configuration/overview

Starts the Flipt server with a remote configuration file stored in S3. The --config flag accepts a URL to a configuration file in S3, Azure Blob Storage, or Google Cloud Storage. Authentication is handled via environment variables such as AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

```console
flipt server --config s3://bucket-name/path/to/config.yml

```

--------------------------------

### Flipt CLI Validate Command Examples

Source: https://docs.flipt.io/v2/cli/commands/validate

Examples of using the 'validate' command. These demonstrate basic validation, specifying a working directory, setting output format to JSON, and using an extra schema file.

```bash
flipt validate
```

```bash
flipt validate --work-dir /path/to/flags
```

```bash
flipt validate --format json
```

```bash
flipt validate --extra-schema /path/to/schema.json
```

--------------------------------

### Create Kind Kubernetes Cluster

Source: https://docs.flipt.io/v2/guides/operations/deployment/deploy-to-kubernetes

Use this command to create a local Kubernetes cluster named 'flipt-v2'. Ensure Docker and Kind are installed.

```bash
kind create cluster --name flipt-v2
```

--------------------------------

### Run Flipt Docker Container

Source: https://docs.flipt.io/v2/guides/operations/authentication/login-with-github

Execute this command to start a Flipt Docker container. It maps ports, mounts persistent storage, and includes a configuration file.

```bash
docker run -it --rm \
  -p 8080:8080 \
  -p 9000:9000 \
  -v $HOME/flipt:/var/opt/flipt \
  -v "$(pwd)/config.yml:/etc/flipt/config/default.yml" \
  docker.flipt.io/flipt/flipt:v2
```

--------------------------------

### Prometheus Metrics Example

Source: https://docs.flipt.io/v2/configuration/observability

Flipt exposes Prometheus metrics by default at the /metrics HTTP endpoint. This example shows sample output.

```yaml
flipt_cache_hit_total{cache="memory",type="flag"} 1
flipt_cache_miss_total{cache="memory",type="flag"} 1
---
go_gc_duration_seconds{quantile="0"} 8.641e-06
go_gc_duration_seconds{quantile="0.25"} 2.499e-05
go_gc_duration_seconds{quantile="0.5"} 3.5359e-05
go_gc_duration_seconds{quantile="0.75"} 6.6594e-05
go_gc_duration_seconds{quantile="1"} 0.00026651 go_gc_duration_seconds_sum
0.000402094 go_gc_duration_seconds_count 5
```

--------------------------------

### Console Log Example

Source: https://docs.flipt.io/v2/configuration/observability

Example of a log entry in console (text) format. This format is human-readable but less suitable for automated log processing.

```text
2024-01-20T22:04:18-05:00	INFO	finished unary call with code OK	{"server": "grpc", "grpc.start_time": "2024-01-20T22:04:18-05:00", "system": "grpc", "span.kind": "server", "grpc.service": "flipt.evaluation.EvaluationService", "grpc.method": "Boolean", "peer.address": "127.0.0.1:53714", "grpc.code": "OK", "grpc.time_ms": 0.373}
```

--------------------------------

### Define Multiple Storage Backends

Source: https://docs.flipt.io/v2/configuration/storage

Configure multiple storage backends with unique identifiers. This example shows 'staging' using local storage and 'development' using memory storage.

```yaml
storage:
  staging: # id
    name: "staging"
    backend:
      type: local
      path: "/path/to/staging/repository"
  development: # id
    name: "development"
    backend:
      type: memory
```

--------------------------------

### HTTP Request with Client Token

Source: https://docs.flipt.io/v2/guides/operations/authentication/connecting-applications

Example of making an HTTP request to the Flipt evaluate endpoint using a client token in the Authorization header.

```bash
curl --request POST http://localhost:8080/evaluate/v1/variant \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <client-token>' \
  --data '{
    "flagKey": "dark-mode",
    "entityId": "user-123",
    "namespaceKey": "default",
    "context": {
      "theme": "dark"
    }
  }'
```

--------------------------------

### Configure Git Remote Storage Backend

Source: https://docs.flipt.io/v2/configuration/storage

Set up a Git storage backend to sync flag state to and from a remote repository. This example configures the 'staging' identifier with a remote URL, branch, and poll interval.

```yaml
storage:
  staging:
    remote: "https://github.com/flipt-io/example.git"
    branch: "main"
    poll_interval: "30s"
    fetch_policy: "strict"
    credentials: "github"
    backend:
      type: memory
```

--------------------------------

### Add Flipt Helm Repository

Source: https://docs.flipt.io/v2/guides/operations/deployment/deploy-to-kubernetes

Add the official Flipt Helm repository to your Helm configuration. This makes Flipt Helm charts available for installation.

```bash
helm repo add flipt https://helm.flipt.io/
```

--------------------------------

### Enable persistence in values.yaml

Source: https://docs.flipt.io/v2/guides/operations/deployment/kubernetes-troubleshooting

Add this to your values.yaml to enable persistence, requiring a writable directory for Flipt's local state. The default storage class varies by provider; run 'kubectl get storageclass' to list available options.

```yaml
persistence:
  enabled: true
  storageClass: "standard" # Use your cluster's storage class
  size: 10Gi
```

--------------------------------

### OIDC with Google: client credentials and Flipt configuration

Source: https://docs.flipt.io/v2/configuration/authentication

First block shows the Google OAuth client credentials obtained from the Google OAuth client setup. Second block shows the Flipt configuration that enables OIDC authentication with Google, using those credentials. The redirect URL for this provider is https://flipt.myorg.com/auth/v1/method/oidc/google/callback. Additional scopes like profile are optional but allow Flipt to identify more user details such as personalized greetings and profile pictures in the UI.

```yaml
client_id: "CyJcdvQMadOjSEx7ArArom0ytrbIHWd2Fb3N59oh8NQ="
client_secret: "WGgJmfQqN7cf17dFyZKXDL5S445/qhp+hfDAC0Mnl7oBrxgdAgiMyuwCkPiwfgQy"
```

```yaml
authentication:
  required: true
  methods:
    oidc:
      enabled: true
      providers:
        google:
          issuer_url: "https://accounts.google.com"
          client_id: "CyJcdvQMadOjSEx7ArArom0ytrbIHWd2Fb3N59oh8NQ="
          client_secret: "WGgJmfQqN7cf17dFyZKXDL5S445/qhp+hfDAC0Mnl7oBrxgdAgiMyuwCkPiwfgQy"
          redirect_address: "https://flipt.myorg.com"
          scopes:
            - email
            - profile
```

--------------------------------

### Session storage with Redis cluster mode

Source: https://docs.flipt.io/v2/configuration/authentication

Redis cluster configuration for session storage. Use mode: cluster for Redis cluster setups.

```yaml
authentication:
  required: true
  session:
    storage:
      type: redis
      redis:
        mode: cluster
        host: localhost
        port: 6379
        db: 0
        password: password
```

--------------------------------

### Front-Channel Logout URL with Query Parameters

Source: https://docs.flipt.io/v2/configuration/authentication

The browser makes a GET request to this URL when the provider initiates front-channel logout. The provider includes iss and sid query parameters.

```text
https://your.flipt.instance.url.com/auth/v1/method/oidc/{provider}/revoke?iss={issuer}&sid={session_id}
```

--------------------------------

### Secret references in configuration

Source: https://docs.flipt.io/v2/configuration/overview

References secrets from configured secret providers using the ${secret:provider:path:key} syntax. The example shows a file provider secret for the certificate file and a Vault secret for the private key.

```yaml
server:
  cert_file: ${secret:file:tls-cert} # Reference to file provider secret
  cert_key: ${secret:vault:tls/certs:private-key} # Reference to Vault secret

```

--------------------------------

### Dockerfile: Trust internal CA certificates for OIDC

Source: https://docs.flipt.io/v2/configuration/authentication

Use this Dockerfile to trust internal CA certificates for OIDC when running Flipt in a container. It installs ca-certificates, copies your CA files into the system trust store, and updates the store. Required because OIDC does not expose a ca_path option.

```dockerfile
FROM flipt/flipt:latest

# Install CA certificates tooling
RUN apk add --no-cache ca-certificates

# Copy your internal CA certificate(s)
COPY certs/Internal_Root_CA.crt /usr/local/share/ca-certificates/
COPY certs/Internal_Intermediate_CA.crt /usr/local/share/ca-certificates/

# Update the system trust store
RUN update-ca-certificates
```

--------------------------------

### JSON Log Example

Source: https://docs.flipt.io/v2/configuration/observability

Example of a log entry in JSON format. This format is suitable for ingestion into log aggregation systems.

```json
{
  "L": "INFO",
  "T": "2024-01-20T21:59:49-05:00",
  "M": "finished unary call with code OK",
  "server": "grpc",
  "grpc.start_time": "2024-01-20T21:59:49-05:00",
  "system": "grpc",
  "span.kind": "server",
  "grpc.service": "flipt.evaluation.EvaluationService",
  "grpc.method": "Boolean",
  "peer.address": "127.0.0.1:52635",
  "grpc.code": "OK",
  "grpc.time_ms": 0.146
}
```

--------------------------------

### Initialize Flipt Configuration

Source: https://docs.flipt.io/v2/cli/commands/config/init

Creates a new Flipt configuration file with default settings. Use the `--force` flag to overwrite an existing configuration file.

```bash
flipt config init
```

```bash
flipt config init --force
```

--------------------------------

### Initialize Git Repository

Source: https://docs.flipt.io/v2/guides/operations/environments/git-repository-initialization

Navigate to the flags directory, initialize a Git repository with a main branch, and add all files for the initial commit.

```bash
cd my-project/flags
git init -b main
git add .
git commit -m "Initial features"
```

--------------------------------

### Import GPG Key for Signing

Source: https://docs.flipt.io/v2/guides/operations/environments/commit-signing-setup

Test if your GPG key can be imported into your system. Replace `/path/to/private-key.asc` with the actual path to your private key file.

```bash
# Check if GPG key can be loaded
gpg --import /path/to/private-key.asc
```

--------------------------------

### Helm install with --skip-schema-validation

Source: https://docs.flipt.io/v2/guides/operations/deployment/kubernetes-troubleshooting

Installs the Flipt Helm chart while skipping schema validation. Requires Helm 3.13+ and bypasses chart schema checks entirely, so typos in values.yaml will not be caught automatically.

```bash
helm install flipt flipt/flipt-v2 -f values.yaml --skip-schema-validation
```

--------------------------------

### Helm install with schema validation error

Source: https://docs.flipt.io/v2/guides/operations/deployment/kubernetes-troubleshooting

Shows the error output when installing the Flipt Helm chart with invalid values. The error indicates that properties like targetMemoryUtilizationPercentage, limits, and requests are not allowed by the schema.

```text
helm install flipt flipt/flipt-v2 -f values.yaml
Error: INSTALLATION FAILED: values don't meet the specifications of the schema(s) in the following chart(s):
flipt-v2:
- autoscaling: Additional property targetMemoryUtilizationPercentage is not allowed
- resources: Additional property limits is not allowed
- resources: Additional property requests is not allowed
```

--------------------------------

### Flipt CLI Options

Source: https://docs.flipt.io/v2/cli/overview

Lists available options for the Flipt CLI, such as the help flag.

```bash
  -h, --help            help for flipt
```

--------------------------------

### Example Telemetry Data

Source: https://docs.flipt.io/v2/configuration/telemetry

This JSON object represents the structure of anonymous usage data collected by Flipt and sent to Jitsu.

```json
{
  "version": "2.0",
  "uuid": "1545d8a8-7a66-4d8d-a158-0a1c576c68a6",
  "lastTimestamp": "2023-04-25T01:01:51Z",
  "flipt": {
    "version": "v2.0.0",
    "os": "linux",
    "arch": "amd64"
  }
}
```

--------------------------------

### Configure Flipt Storage with GitHub Remote

Source: https://docs.flipt.io/v2/guides/operations/environments/git-sync

Set up Flipt's storage backend to sync with a GitHub repository. Replace `<your-username>` and `<your-repo>` with your GitHub details. The `local` backend is optional.

```yaml
storage:
  github:
    remote: "https://github.com/<your-username>/<your-repo>.git"
    branch: "main"
    poll_interval: "30s"
    credentials: "github"
    backend:
      type: local
      path: "/path/to/local/clone"
```

--------------------------------

### Configure Local Storage Backend

Source: https://docs.flipt.io/v2/configuration/storage

Set up a local storage backend to serve Flipt flag state directly from the filesystem. This persists flag state between server restarts. The default identifier is used.

```yaml
storage:
  backend:
    type: local
    path: "."
```

--------------------------------

### Configure Flipt Pro License

Source: https://docs.flipt.io/v2/pro

Configure your Flipt v2 instance with your license key. Ensure you have obtained a valid license key before proceeding.

```yaml
license:
  key: "your-license-key-here"
```

--------------------------------

### Configure Flipt v2 GitHub Storage Backend

Source: https://docs.flipt.io/v2/guides/migration/cloud/flipt-cloud-to-v2

Set up the GitHub storage backend for Flipt v2. Replace placeholders with your repository details and adjust the poll interval as needed. The backend type is set to 'local' with a specified path.

```yaml
storage:
  github:
    remote: "https://github.com/<your-username>/<your-repo>.git"
    branch: "main"
    poll_interval: "30s"
    credentials: "github"
    backend:
      type: local
      path: "/tmp/flipt-repo"
```

--------------------------------

### Set GitHub Token Environment Variable

Source: https://docs.flipt.io/v2/guides/migration/cloud/flipt-cloud-to-v2

Before starting Flipt v2, set the GITHUB_TOKEN environment variable to your GitHub token. This is required for repository access.

```bash
export GITHUB_TOKEN=your_github_token_here
```

--------------------------------

### Create Analytics Database for ClickHouse

Source: https://docs.flipt.io/v2/configuration/analytics

SQL command to create a dedicated database for Flipt analytics in ClickHouse. Ensure this database exists before starting Flipt.

```sql
CREATE DATABASE IF NOT EXISTS flipt_analytics_v2;
```

--------------------------------

### GitLab Environment Configuration

Source: https://docs.flipt.io/v2/guides/operations/environments/git-scm

Configure a production environment using GitLab for storage and Git sync. This basic setup assumes default GitLab configurations.

```yaml
environments:
  production:
    name: "Production"
    storage: "gitlab"
    default: true
    scm:
      type: gitlab
      credentials: "gitlab"
```

--------------------------------

### Configure Flipt v2 license key via YAML or environment variables

Source: https://docs.flipt.io/v2/configuration/licensing

Configure the Flipt v2 license key using either the configuration YAML file or environment variables. Both methods support optional settings for an offline license file and a stable machine ID for container environments. Restart the Flipt v2 instance after applying the configuration for it to take effect.

```yaml
license:
  key: "your-license-key"
  # Optional: Path to offline license file for annual licenses
  file: "/path/to/license.lic"
  # Optional: Stable machine fingerprint for container environments
  machine_id: "your-stable-machine-id"

```

```bash
FLIPT_LICENSE_KEY="your-license-key"
# Optional: Path to offline license file for annual licenses
FLIPT_LICENSE_FILE="/path/to/license.lic"
# Optional: Stable machine fingerprint for container environments
FLIPT_LICENSE_MACHINE_ID="your-stable-machine-id"

```

--------------------------------

### Configure Bitbucket Credentials with API Token

Source: https://docs.flipt.io/v2/guides/operations/environments/git-scm

Set up Bitbucket credentials in Flipt using an API token, recommended for Bitbucket Cloud.

```yaml
credentials:
  bitbucket:
    type: access_token
    access_token: <your-api-token>
```

--------------------------------

### Store Private Key in Vault

Source: https://docs.flipt.io/v2/guides/operations/environments/commit-signing-setup

Example command to store the exported private GPG key in HashiCorp Vault. Adjust the path and key name according to your Vault configuration.

```bash
vault kv put secret/flipt/signing-key private_key=@flipt-signing-key.asc
```

--------------------------------

### Configure Bitbucket SCM Environment

Source: https://docs.flipt.io/v2/guides/operations/environments/git-scm

Set up an environment in your Flipt configuration to use the Bitbucket SCM storage backend. Specify the storage type and credentials.

```yaml
environments:
  production:
    name: "Production"
    storage: "bitbucket"
    default: true
    scm:
      type: bitbucket
      credentials: "bitbucket"
```
Tokens:
Raw