Merge branch 'main' into jwt-docs

* main: chore: add new grpc conn settings (#169) feat: add gcp docs (#168)
flipt-io · Jan 10, 2024 · cfc7b48 · cfc7b48
2 parents fe970e9 + 2285401
commit cfc7b48
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 11 deletions.
diff --git a/configuration/overview.mdx b/configuration/overview.mdx
@@ -111,15 +111,18 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001"
 
 ### Server
 
-| Property          | Description                                                    | Default | Since  |
-| ----------------- | -------------------------------------------------------------- | ------- | ------ |
-| server.protocol   | http or https                                                  | http    | v0.8.0 |
-| server.host       | The host address on which to serve the Flipt application       | 0.0.0.0 |        |
-| server.http_port  | The HTTP port on which to serve the Flipt REST API and UI      | 8080    |        |
-| server.https_port | The HTTPS port on which to serve the Flipt REST API and UI     | 443     | v0.8.0 |
-| server.grpc_port  | The port on which to serve the Flipt GRPC server               | 9000    |        |
-| server.cert_file  | Path to the certificate file (if protocol is set to https)     |         | v0.8.0 |
-| server.cert_key   | Path to the certificate key file (if protocol is set to https) |         | v0.8.0 |
+| Property                       | Description                                                                                                 | Default   | Since   |
+| ------------------------------ | ----------------------------------------------------------------------------------------------------------- | --------- | ------- |
+| server.protocol                | http or https                                                                                               | http      | v0.8.0  |
+| server.host                    | The host address on which to serve the Flipt application                                                    | 0.0.0.0   |         |
+| server.http_port               | The HTTP port on which to serve the Flipt REST API and UI                                                   | 8080      |         |
+| server.https_port              | The HTTPS port on which to serve the Flipt REST API and UI                                                  | 443       | v0.8.0  |
+| server.grpc_port               | The port on which to serve the Flipt GRPC server                                                            | 9000      |         |
+| server.grpc_conn_max_idle_time | Maximum amount of time a GRPC connection can be idle                                                        | unlimited | v1.35.0 |
+| server.grpc_conn_max_age       | Maximum amount of time a GRPC connection can live                                                           | unlimited | v1.35.0 |
+| server.grpc_conn_max_age_grace | Maximum amount of time a GRPC connection can live for outstanding RPCs after exceeding `grpc_conn_max_age ` | unlimited | v1.35.0 |
+| server.cert_file               | Path to the certificate file (if protocol is set to https)                                                  |           | v0.8.0  |
+| server.cert_key                | Path to the certificate key file (if protocol is set to https)                                              |           | v0.8.0  |
 
 ### Authentication
 

diff --git 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,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"
+    # 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.