Skip to content

Commit

Permalink
chore: fix merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
yquansah committed Sep 29, 2023
2 parents c1c0b74 + cc45f64 commit 3378c83
Show file tree
Hide file tree
Showing 10 changed files with 64 additions and 27 deletions.
2 changes: 1 addition & 1 deletion authentication/methods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ curl -X POST localhost:8080/auth/v1/method/token \

#### UI

As of version 1.19.0, the UI also supports the creation and deletion of tokens. To access this functionality, navigate to `Settings` from the main menu and see the 'Static Tokens' section.
The UI also supports the creation and deletion of tokens. To access this functionality, navigate to `Settings` from the main menu and see the 'Static Tokens' section.

![Create Token UI](/images/authentication/create-token.png)

Expand Down
2 changes: 1 addition & 1 deletion concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ More information on how to use Flipt is noted in the [Getting Started](/introduc

## Namespaces

Namespaces are the recommended way to organize all of the resources such as Flags, Segments, Rules, etc within Flipt as of [v1.20.0](https://github.com/flipt-io/flipt/releases/tag/v1.20.0).
Namespaces are the recommended way to organize all resources such as Flags, Segments, Rules, etc within Flipt.

Namespaces allow you to separate all data within Flipt for use in different environments such as Development, Staging, Production, etc.

Expand Down
2 changes: 1 addition & 1 deletion configuration/observability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ go_gc_duration_seconds{quantile="1"} 0.00026651 go_gc_duration_seconds_sum
0.000402094 go_gc_duration_seconds_count 5
```

An [example](https://github.com/flipt-io/flipt/tree/main/examples/prometheus)
An [example](https://github.com/flipt-io/flipt/tree/main/examples/metrics)
showing how to set up Flipt with Prometheus can be found in the GitHub repository.

### Dashboards
Expand Down
2 changes: 1 addition & 1 deletion configuration/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The default way that Flipt is configured is with the use of a configuration file
This file is read when Flipt starts up and configures several important
properties for the server.

As of version [v1.23](https://github.com/flipt-io/flipt/releases/tag/v1.23.0), the server will check in a few different locations for server configuration (in order):
The server will check in a few different locations for server configuration (in order):

1. `--config` flag as an override
2. `{{ USER_CONFIG_DIR }}/flipt/config.yml` (the `USER_CONFIG_DIR` value is based on your architecture and specified in the [Go documentation](https://pkg.go.dev/os#UserConfigDir))
Expand Down
2 changes: 1 addition & 1 deletion configuration/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ meta:
export FLIPT_META_TELEMETRY_ENABLED=false
```

As of [v1.21.0](https://github.com/flipt-io/flipt/releases/tag/v1.21.0), telemetry can also be disabled by setting the [DO_NOT_TRACK](https://consoledonottrack.com/) environment variable to `true` or `1`:
Telemetry can also be disabled by setting the [DO_NOT_TRACK](https://consoledonottrack.com/) environment variable to `true` or `1`:

```shell
export DO_NOT_TRACK=true
Expand Down
56 changes: 48 additions & 8 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,37 @@
title: "Installation"
---

## Quickstart

Flipt is a single binary that can be run on any Linux or macOS (arm64) host. You can install and try out Flipt in a few different ways:

<CodeGroup>

```console Docker
docker run -d \
-p 8080:8080 \
-p 9000:9000 \
-v $HOME/flipt:/var/opt/flipt \
flipt/flipt:latest
```

```console Kubernetes/Helm
helm repo add flipt https://helm.flipt.io
helm install flipt flipt/flipt
```

```console Homebrew
brew install flipt-io/brew/flipt
```

```console Binary
curl -fsSL https://github.com/flipt-io/flipt/raw/main/install.sh | bash
```

</CodeGroup>

For more details on each installation method, see the sections below.

## Docker

The simplest way to run Flipt is via Docker. This streamlines the installation
Expand Down Expand Up @@ -51,10 +82,7 @@ This allows data to persist between Docker container restarts.
After starting the container you can visit http://0.0.0.0:8080 to view the
application.

<Note>
Flipt runs without the root user in the Docker container as of
[v1.6.1](https://github.com/flipt-io/flipt/releases/tag/v1.6.1).
</Note>
<Note>Flipt runs without the root user in the Docker container.</Note>

### Configuration

Expand Down Expand Up @@ -130,14 +158,26 @@ You can always download the latest release archive of Flipt from the

### Installing

#### Script

You can use the following script to download and install the latest Flipt binary:

```console
curl -fsSL https://github.com/flipt-io/flipt/raw/main/install.sh | bash
```

View the [install.sh](https://github.com/flipt-io/flipt/blob/main/install.sh) source for more details.

#### Manual

Download to an accessible location on your host and un-zip with the following
commands (requires [jq](https://stedolan.github.io/jq/)):

```console
$ export FLIPT_VERSION=$(curl --silent "https://api.github.com/repos/flipt-io/flipt/releases/latest" | jq '.tag_name?' | tr -d '"' | tr -d 'v')
$ curl -L "https://github.com/flipt-io/flipt/releases/download/v${FLIPT_VERSION}/flipt_${FLIPT_VERSION}_linux_x86_64.tar.gz" -o flipt.tar.gz && \
tar -xvf flipt.tar.gz && \
chmod +x ./flipt
export FLIPT_VERSION=$(curl --silent "https://api.github.com/repos/flipt-io/flipt/releases/latest" | jq '.tag_name?' | tr -d '"' | tr -d 'v')
curl -L "https://github.com/flipt-io/flipt/releases/download/v${FLIPT_VERSION}/flipt_${FLIPT_VERSION}_linux_x86_64.tar.gz" -o flipt.tar.gz && \
tar -xvf flipt.tar.gz && \
chmod +x ./flipt
```

This archive contains the Flipt binary, configuration, README, LICENSE, and CHANGELOG files.
Expand Down
2 changes: 1 addition & 1 deletion integration/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Examples on how to configure Flipt to fit your needs.
href="https://github.com/flipt-io/flipt/tree/main/examples/authentication"
title="Authentication"
icon="lock"
color="#c13e29"
color="#cad929"
>
How to setup OIDC authentication with Flipt
</Card>
Expand Down
2 changes: 1 addition & 1 deletion operations/deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Deployment
description: Details on various ways to deploy Flipt.
---

Flipt is built and delivered as a single standalone Linux binary.
Flipt is built and delivered as a single standalone binary.
Head to the [Installation](/installation) section for more details.

Running Flipt with the default configuration is a great way to get to grips with using it.
Expand Down
13 changes: 5 additions & 8 deletions operations/import-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ description: Importing and exporting data to and from Flipt

<Note>Importing is only supported for database backed Flipt instances.</Note>

Prior to Flipt [v1.20.0](https://github.com/flipt-io/flipt/releases/tag/v1.20.0) `import` and `export` ran directly against the backing database.

Since `v1.20.0` you can now alternatively perform these operations through Flipt's API.
Both `flipt import` and `flipt export` support the `--address` and `--token` flags to enable this behaviour.
Both `flipt import` and `flipt export` support the `--address` and `--token` flags to enable transferring data to and from Flipt instances via the API instead of requiring a direct database connection.

```
flipt import --address http://flipt.my.org --token static-api-token
Expand Down Expand Up @@ -59,14 +56,14 @@ The namespaces are now inferred from the YAML documents themselves. If a namespa

</Note>

This command supports the `--drop` flag that will drop all of the data in your
This command supports the `--drop` flag that will drop all data in your
Flipt database tables before importing. This is to ensure that no data
collisions occur during the import.

<Warning>
Be careful when using the `--drop` flag as it will immediately drop all of
your data and there is no undo. It's recommended to first backup your database
before running this command just to be safe.
Be careful when using the `--drop` flag as it will immediately drop all data
and there is no undo. It's recommended to first backup your database before
running this command just to be safe.
</Warning>

## Export
Expand Down
8 changes: 4 additions & 4 deletions operations/production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Some of the configuration options and tips to consider when operating Flipt in p

## Database Connection Limits

By default, the Go `database/sql` client, will have `MaxOpenConn` equal to 0 (unlimited), and `MaxIdleConn` equal to 2.
By default, the Go `database/sql` client will have `MaxOpenConn` equal to 0 (unlimited), and `MaxIdleConn` equal to 2.

With the databases that listen over a network (MySQL, Postgres, CockroachDB), there are default server limits for the number of open connections it supports.

Expand Down Expand Up @@ -42,7 +42,7 @@ The [Go documentation](https://pkg.go.dev/database/sql#DB.SetMaxOpenConns) state
If MaxOpenConns is greater than 0 but less than the new MaxIdleConns, then the new MaxIdleConns will be reduced to match the MaxOpenConns limit.
```

So you should keep in mind that tuning `MaxOpenConn` might lead to tuning `MaxIdleConn` as well.
Keep in mind that tuning `MaxOpenConn` may lead to tuning `MaxIdleConn` as well.

<Tabs>
<Tab title="Environment Variable">
Expand All @@ -64,7 +64,7 @@ So you should keep in mind that tuning `MaxOpenConn` might lead to tuning `MaxId
## Prepared Statements
By default, all queries are run as prepared statements. This could post a problem in some environments.
By default, all queries are run as prepared statements. This could pose a problem in some environments.
For instance, PGBouncer doesn't support prepared statements in its [transaction pooling mode](https://www.pgbouncer.org/faq.html#how-to-use-prepared-statements-with-transaction-pooling).
Expand All @@ -90,7 +90,7 @@ You can disable prepared statements for the database client using:
## Debug Logging
Debug logging can be very useful if you are actively developing or trying to fix problems in an environment, but can have the adverse effect of eating up CPU time under load. Enabling debug logging can also end up mixing useful logs with non-useful ones.
Debug logging can be useful if you are actively developing or trying to fix problems in an environment, but can have the adverse effect of eating up CPU time under load. Enabling debug logging can end up mixing useful logs with non-useful ones.
It's recommended to disable Flipt's debug logging in a production environment by increasing the log level:
Expand Down

0 comments on commit 3378c83

Please sign in to comment.