Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add gcp docs #168

Merged
merged 3 commits into from
Jan 10, 2024
Merged

feat: add gcp docs #168

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9801fae
feat: add gcp docs
markphelps Jan 9, 2024
f5d55d4
chore: format code
markphelps Jan 9, 2024
65150c3
chore: Update storage.mdx
markphelps Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 50 additions & 2 deletions configuration/storage.mdx
View file
Open in desktop
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,55 @@ 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.

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"
markphelps marked this conversation as resolved.
Show resolved Hide resolved
# optional: bucket prefix for locating flag state files
FLIPT_STORAGE_OBJECT_GOOGLECLOUD_PREFIX="production"
```

</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