From 9801faeeb6874d54491410a55844a2c418e47466 Mon Sep 17 00:00:00 2001 From: Mark Phelps <209477+markphelps@users.noreply.github.com> Date: Tue, 9 Jan 2024 16:26:04 -0500 Subject: [PATCH 1/3] feat: add gcp docs --- configuration/storage.mdx | 51 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/configuration/storage.mdx b/configuration/storage.mdx index c06d2a0..f9c23c7 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -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 @@ -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. + + +The following is an example of how to configure Flipt to leverage this backend type: + + + + + ```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" + ``` + + + + + ```yaml + storage: + type: object + object: + type: googlecloud + googlecloud: + bucket: flipt-feature-flags + poll_interval: "30s" + ``` + + + + + + In addition to these Flipt configuration parameters, valid credentials will + also be required for Flipt to authenticate with the target object store. + + +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. From f5d55d4ec036bc3eef18a26110921eafb09ef378 Mon Sep 17 00:00:00 2001 From: markphelps Date: Tue, 9 Jan 2024 21:32:09 +0000 Subject: [PATCH 2/3] chore: format code --- configuration/storage.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/configuration/storage.mdx b/configuration/storage.mdx index f9c23c7..c6bd436 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -411,7 +411,6 @@ AZURE_STORAGE_KEY=... 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: From 65150c344c5d744520a3171d52a6f8e74e0e8587 Mon Sep 17 00:00:00 2001 From: Mark Phelps <209477+markphelps@users.noreply.github.com> Date: Wed, 10 Jan 2024 07:34:09 -0500 Subject: [PATCH 3/3] chore: Update storage.mdx Co-authored-by: Roman Dmytrenko --- configuration/storage.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/configuration/storage.mdx b/configuration/storage.mdx index c6bd436..3a8a316 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -421,6 +421,8 @@ The following is an example of how to configure Flipt to leverage this backend t FLIPT_STORAGE_OBJECT_TYPE="googlecloud" FLIPT_STORAGE_OBJECT_GOOGLECLOUD_BUCKET="flipt-feature-flags" FLIPT_STORAGE_OBJECT_GOOGLECLOUD_POLL_INTERVAL="1m" + # optional: bucket prefix for locating flag state files + FLIPT_STORAGE_OBJECT_GOOGLECLOUD_PREFIX="production" ```