Skip to content

Commit

Permalink
feat: add gcp docs
Browse files Browse the repository at this point in the history
  • Loading branch information
markphelps committed Jan 9, 2024
1 parent b88c7f4 commit 9801fae
Showing 1 changed file with 49 additions and 2 deletions.
51 changes: 49 additions & 2 deletions configuration/storage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -282,8 +282,7 @@ Currently, Flipt supports the following object store providers:

- [AWS S3](https://aws.amazon.com/s3/)
- [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/)

Additional providers such as [Google Cloud Storage](https://cloud.google.com/storage) are planned for future releases.
- [Google Cloud Storage](https://cloud.google.com/storage)

#### Contents

Expand Down Expand Up @@ -408,6 +407,54 @@ AZURE_STORAGE_ACCOUNT=...
AZURE_STORAGE_KEY=...
```

#### Google Cloud Storage

The Google Cloud Storage backend can be configured to serve state from a single bucket from a target Google Cloud Storage account.


Check failure on line 414 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / lint

Delete `⏎`
The following is an example of how to configure Flipt to leverage this backend type:

<Tabs>
<Tab title="Environment Variable">

```bash
FLIPT_STORAGE_TYPE="object"
FLIPT_STORAGE_OBJECT_TYPE="googlecloud"
FLIPT_STORAGE_OBJECT_GOOGLECLOUD_BUCKET="flipt-feature-flags"
FLIPT_STORAGE_OBJECT_GOOGLECLOUD_POLL_INTERVAL="1m"
```

</Tab>
<Tab title="Configuration Yaml">

```yaml
storage:
type: object
object:
type: googlecloud
googlecloud:
bucket: flipt-feature-flags
poll_interval: "30s"
```

</Tab>
</Tabs>

<Note>
In addition to these Flipt configuration parameters, valid credentials will
also be required for Flipt to authenticate with the target object store.
</Note>

If running in a Google Cloud environment, you can use [Application Default Credentials](https://cloud.google.com/docs/authentication/production) to authenticate with Google Cloud Storage.

Alternatively, you can use a [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts) to authenticate with Google Cloud Storage and provide the service account key file to Flipt.

This should be provided as an environment variable to the Flipt server process:

```bash
GOOGLE_APPLICATION_CREDENTIALS=... # path to a service account key file
```

### OCI

Since `v1.31.0`, Flipt supports using any [OCI](https://opencontainers.org/) compatible registry as a declarative backend source.
Expand Down

0 comments on commit 9801fae

Please sign in to comment.