Merge pull request #378 from flipt-io/claude/issue-373-20251030-1333

markphelps · web-flow · commit 4474a4de4639 · 2025-10-31T14:46:17.000-04:00
docs: add fetch_policy configuration option for git storage
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,4 +21,3 @@ jobs:
 
       - name: Check for Broken Links
         run: npx -y mint broken-links
-
diff --git a/.github/workflows/worker.yml b/.github/workflows/worker.yml
diff --git a/docs.json b/docs.json
@@ -37,10 +37,7 @@
                 "group": "Pro Features",
                 "tag": "NEW",
                 "icon": "crown",
-                "pages": [
-                  "v2/pro",
-                  "v2/licensing"
-                ]
+                "pages": ["v2/pro", "v2/licensing"]
               },
               {
                 "group": "Configuration",
@@ -66,9 +63,7 @@
                   "v2/integration/overview",
                   {
                     "group": "Server-Side SDKs",
-                    "pages": [
-                      "v2/integration/server/rest"
-                    ]
+                    "pages": ["v2/integration/server/rest"]
                   },
                   "v2/integration/client",
                   "v2/integration/openfeature"
@@ -143,19 +138,15 @@
                   },
                   {
                     "group": "Migration Guides",
-                    "pages": [
-                      "v2/guides/migration/cloud/flipt-cloud-to-v2"
-                    ]
+                    "pages": ["v2/guides/migration/cloud/flipt-cloud-to-v2"]
                   }
                 ]
               },
               {
                 "group": "Tooling",
                 "icon": "hammer",
                 "tag": "NEW",
-                "pages": [
-                  "v2/tooling/github-actions"
-                ]
+                "pages": ["v2/tooling/github-actions"]
               }
             ]
           },
@@ -185,10 +176,7 @@
             "groups": [
               {
                 "group": "Overview",
-                "pages": [
-                  "v1/introduction",
-                  "v1/concepts"
-                ]
+                "pages": ["v1/introduction", "v1/concepts"]
               },
               {
                 "group": "Use Cases",
@@ -333,9 +321,7 @@
               },
               {
                 "group": "Authorization",
-                "pages": [
-                  "v1/authorization/overview"
-                ]
+                "pages": ["v1/authorization/overview"]
               },
               {
                 "group": "Operations",
@@ -362,9 +348,7 @@
             "groups": [
               {
                 "group": "Overview",
-                "pages": [
-                  "v1/reference/overview"
-                ]
+                "pages": ["v1/reference/overview"]
               },
               {
                 "group": "Authentication",
@@ -475,9 +459,7 @@
           {
             "anchor": "Changelog",
             "icon": "clock",
-            "pages": [
-              "v1/changelog/overview"
-            ]
+            "pages": ["v1/changelog/overview"]
           },
           {
             "anchor": "Blog",
diff --git a/docs/v2/configuration/overview.mdx b/docs/v2/configuration/overview.mdx
@@ -181,18 +181,19 @@ Server configuration controls how Flipt listens for and serves HTTP, HTTPS, and
 
 Storage configuration defines where and how Flipt persists feature flag data, including local and remote Git repositories.
 
-| Property                       | Description                                                         | Default             | Since  |
-| ------------------------------ | ------------------------------------------------------------------- | ------------------- | ------ |
-| storage.[id].name              | The canonical name of the storage instance                          | default             | v2.0.0 |
-| storage.[id].backend.type      | The type of backend to use (options: memory, local)                 | memory              | v2.0.0 |
-| storage.[id].backend.path      | The path to the local storage directory for git backend             | temporary directory | v2.0.0 |
-| storage.[id].remote            | The remote URL to sync storage to/from                              |                     | v2.0.0 |
-| storage.[id].branch            | The branch to use for git backend                                   | main                | v2.0.0 |
-| storage.[id].poll_interval     | The interval to poll the git repository and ref for changes         | 30s                 | v2.0.0 |
-| storage.[id].ca_cert_bytes     | The CA certificate bytes for the remote URL                         |                     | v2.0.0 |
-| storage.[id].ca_cert_path      | The CA certificate path for the remote URL                          |                     | v2.0.0 |
-| storage.[id].insecure_skip_tls | Skip verifying the server's certificate chain (avoid in production) | false               | v2.0.0 |
-| storage.[id].credentials       | The id of the credentials to use for the remote URL                 |                     | v2.0.0 |
+| Property                       | Description                                                                           | Default             | Since  |
+| ------------------------------ | ------------------------------------------------------------------------------------- | ------------------- | ------ |
+| storage.[id].name              | The canonical name of the storage instance                                            | default             | v2.0.0 |
+| storage.[id].backend.type      | The type of backend to use (options: memory, local)                                   | memory              | v2.0.0 |
+| storage.[id].backend.path      | The path to the local storage directory for git backend                               | temporary directory | v2.0.0 |
+| storage.[id].remote            | The remote URL to sync storage to/from                                                |                     | v2.0.0 |
+| storage.[id].branch            | The branch to use for git backend                                                     | main                | v2.0.0 |
+| storage.[id].poll_interval     | The interval to poll the git repository and ref for changes                           | 30s                 | v2.0.0 |
+| storage.[id].ca_cert_bytes     | The CA certificate bytes for the remote URL                                           |                     | v2.0.0 |
+| storage.[id].ca_cert_path      | The CA certificate path for the remote URL                                            |                     | v2.0.0 |
+| storage.[id].insecure_skip_tls | Skip verifying the server's certificate chain (avoid in production)                   | false               | v2.0.0 |
+| storage.[id].fetch_policy      | Policy for handling connection issues when fetching from remote Git (strict, lenient) | strict              | v2.3.0 |
+| storage.[id].credentials       | The id of the credentials to use for the remote URL                                   |                     | v2.0.0 |
 
 #### Commit Signing
 
diff --git a/docs/v2/configuration/storage.mdx b/docs/v2/configuration/storage.mdx
@@ -79,13 +79,49 @@ storage:
     remote: "https://github.com/flipt-io/example.git"
     branch: "main"
     poll_interval: "30s"
+    fetch_policy: "strict"
     credentials: "github"
     backend:
       type: memory
 ```
 
 This configuration will create a git storage backend with the identifier `staging` in memory and will sync flag state to and from the remote repository.
 
+### Fetch Policy
+
+The `fetch_policy` configuration option controls how Flipt handles connection-related issues when attempting to fetch from a remote Git repository.
+
+#### Available Policies
+
+- **`strict`** (default): Flipt will fail and return an error if it encounters connection issues when trying to fetch from the remote repository. This ensures that any connectivity problems are immediately visible and must be resolved.
+
+- **`lenient`**: Flipt will continue operating even if connection issues prevent fetching from the remote repository. This allows Flipt to remain functional during temporary network issues or remote repository unavailability.
+
+#### Usage Example
+
+```yaml
+storage:
+  production:
+    remote: "https://github.com/company/flags.git"
+    fetch_policy: "strict" # Fail fast on connection issues
+    backend:
+      type: local
+      path: "/var/lib/flipt"
+
+  development:
+    remote: "https://github.com/company/flags.git"
+    fetch_policy: "lenient" # Continue operation during connection issues
+    backend:
+      type: memory
+```
+
+<Warning>
+  In production environments, consider using `strict` to ensure that
+  connectivity issues are detected and resolved promptly, preventing potential
+  configuration drift between your remote repository and running Flipt
+  instances.
+</Warning>
+
 ### Conflict Resolution
 
 Conflicts can occur when syncing flag state to and from a remote repository. The conflict resolution strategy in Flipt v2 is currently rudimentary and we aim to improve this in future releases.

Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,3 @@ jobs:`
`21`	`21`
`22`	`22`	`- name: Check for Broken Links`
`23`	`23`	`run: npx -y mint broken-links`
`24`		`-`
Original file line number	Diff line number	Diff line change
`@@ -37,10 +37,7 @@`
`37`	`37`	`"group": "Pro Features",`
`38`	`38`	`"tag": "NEW",`
`39`	`39`	`"icon": "crown",`
`40`		`- "pages": [`
`41`		`- "v2/pro",`
`42`		`- "v2/licensing"`
`43`		`- ]`
	`40`	`+ "pages": ["v2/pro", "v2/licensing"]`
`44`	`41`	`},`
`45`	`42`	`{`
`46`	`43`	`"group": "Configuration",`
`@@ -66,9 +63,7 @@`
`66`	`63`	`"v2/integration/overview",`
`67`	`64`	`{`
`68`	`65`	`"group": "Server-Side SDKs",`
`69`		`- "pages": [`
`70`		`- "v2/integration/server/rest"`
`71`		`- ]`
	`66`	`+ "pages": ["v2/integration/server/rest"]`
`72`	`67`	`},`
`73`	`68`	`"v2/integration/client",`
`74`	`69`	`"v2/integration/openfeature"`
`@@ -143,19 +138,15 @@`
`143`	`138`	`},`
`144`	`139`	`{`
`145`	`140`	`"group": "Migration Guides",`
`146`		`- "pages": [`
`147`		`- "v2/guides/migration/cloud/flipt-cloud-to-v2"`
`148`		`- ]`
	`141`	`+ "pages": ["v2/guides/migration/cloud/flipt-cloud-to-v2"]`
`149`	`142`	`}`
`150`	`143`	`]`
`151`	`144`	`},`
`152`	`145`	`{`
`153`	`146`	`"group": "Tooling",`
`154`	`147`	`"icon": "hammer",`
`155`	`148`	`"tag": "NEW",`
`156`		`- "pages": [`
`157`		`- "v2/tooling/github-actions"`
`158`		`- ]`
	`149`	`+ "pages": ["v2/tooling/github-actions"]`
`159`	`150`	`}`
`160`	`151`	`]`
`161`	`152`	`},`
`@@ -185,10 +176,7 @@`
`185`	`176`	`"groups": [`
`186`	`177`	`{`
`187`	`178`	`"group": "Overview",`
`188`		`- "pages": [`
`189`		`- "v1/introduction",`
`190`		`- "v1/concepts"`
`191`		`- ]`
	`179`	`+ "pages": ["v1/introduction", "v1/concepts"]`
`192`	`180`	`},`
`193`	`181`	`{`
`194`	`182`	`"group": "Use Cases",`
`@@ -333,9 +321,7 @@`
`333`	`321`	`},`
`334`	`322`	`{`
`335`	`323`	`"group": "Authorization",`
`336`		`- "pages": [`
`337`		`- "v1/authorization/overview"`
`338`		`- ]`
	`324`	`+ "pages": ["v1/authorization/overview"]`
`339`	`325`	`},`
`340`	`326`	`{`
`341`	`327`	`"group": "Operations",`
`@@ -362,9 +348,7 @@`
`362`	`348`	`"groups": [`
`363`	`349`	`{`
`364`	`350`	`"group": "Overview",`
`365`		`- "pages": [`
`366`		`- "v1/reference/overview"`
`367`		`- ]`
	`351`	`+ "pages": ["v1/reference/overview"]`
`368`	`352`	`},`
`369`	`353`	`{`
`370`	`354`	`"group": "Authentication",`
`@@ -475,9 +459,7 @@`
`475`	`459`	`{`
`476`	`460`	`"anchor": "Changelog",`
`477`	`461`	`"icon": "clock",`
`478`		`- "pages": [`
`479`		`- "v1/changelog/overview"`
`480`		`- ]`
	`462`	`+ "pages": ["v1/changelog/overview"]`
`481`	`463`	`},`
`482`	`464`	`{`
`483`	`465`	`"anchor": "Blog",`