From cb9874e8a708640d9625eaccd237d3939b8849f6 Mon Sep 17 00:00:00 2001 From: Mark Phelps <209477+markphelps@users.noreply.github.com> Date: Wed, 27 Mar 2024 10:04:27 -0400 Subject: [PATCH] chore: document oci manifest version and github teams --- configuration/overview.mdx | 22 ++++++++++++---------- configuration/storage.mdx | 11 +++++++++++ 2 files changed, 23 insertions(+), 10 deletions(-) diff --git a/configuration/overview.mdx b/configuration/overview.mdx index b84fd4b4..30aff475 100644 --- a/configuration/overview.mdx +++ b/configuration/overview.mdx @@ -165,16 +165,17 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001" #### Authentication Methods: GitHub -| Property | Description | Default | Since | -| --------------------------------------------------- | -------------------------------------------------------------- | ------- | ------- | -| authentication.methods.github.enabled | Enable GitHub authentication | false | v1.26.0 | -| authentication.methods.github.cleanup.interval | Interval between deletion of expired tokens | 1h | v1.26.0 | -| authentication.methods.github.cleanup.grace_period | How long an expired token can exist until considered deletable | 30m | v1.26.0 | -| authentication.methods.github.client_id | GitHub client ID | | v1.26.0 | -| authentication.methods.github.client_secret | GitHub client secret | | v1.26.0 | -| authentication.methods.github.redirect_address | Public URL on which this Flipt instance is reachable | | v1.26.0 | -| authentication.methods.github.scopes | Scopes to request from GitHub | | v1.26.0 | -| authentication.methods.github.allowed_organizations | List of GitHub organizations allowed to authenticate | | v1.33.0 | +| Property | Description | Default | Since | +| --------------------------------------------------- | ------------------------------------------------------------------ | ------- | ------- | +| authentication.methods.github.enabled | Enable GitHub authentication | false | v1.26.0 | +| authentication.methods.github.cleanup.interval | Interval between deletion of expired tokens | 1h | v1.26.0 | +| authentication.methods.github.cleanup.grace_period | How long an expired token can exist until considered deletable | 30m | v1.26.0 | +| authentication.methods.github.client_id | GitHub client ID | | v1.26.0 | +| authentication.methods.github.client_secret | GitHub client secret | | v1.26.0 | +| authentication.methods.github.redirect_address | Public URL on which this Flipt instance is reachable | | v1.26.0 | +| authentication.methods.github.scopes | Scopes to request from GitHub | | v1.26.0 | +| authentication.methods.github.allowed_organizations | List of GitHub organizations allowed to authenticate | | v1.33.0 | +| authentication.methods.github.allowed_teams | Map of GitHub organizations to teams that users must be members of | | v1.39.0 | #### Authentication Methods: Kubernetes @@ -266,6 +267,7 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001" | storage.oci.authentication.password | The password to use for authentication | | v1.31.0 | | storage.oci.bundles_directory | The directory in which to store local bundles | $config/flipt/bundles | v1.31.0 | | storage.oci.poll_interval | The interval to poll the registry for changes | 30s | v1.31.0 | +| storage.oci.manifest_verison | The OCI manifest version to use | 1.1 | v1.39.1 | ### Cache diff --git a/configuration/storage.mdx b/configuration/storage.mdx index 932ef69e..e9f12f1f 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -473,6 +473,7 @@ Flipt has its own custom OCI manifest format (we call them `bundles`), which can FLIPT_STORAGE_OCI_AUTHENTICATION_PASSWORD="password" # location used for storing local bundles FLIPT_STORAGE_OCI_BUNDLES_DIRECTORY="/flipt/bundles" + FLIPT_STORAGE_OCI_MANIFEST_VERSION="1.1" ``` @@ -488,11 +489,21 @@ Flipt has its own custom OCI manifest format (we call them `bundles`), which can username: "username" password: "password" bundles_directory: "/flipt/bundles" + manifest_version: "1.1" ``` + + Certain OCI registries may require setting the OCI manifest version to something other than the default (`1.1`) to work correctly. + + In this case, you can set the `FLIPT_STORAGE_OCI_MANIFEST_VERSION` environment variable or `storage.oci.manifest_version` configuration property to the desired version (e.g. `1.0`). + +See [this issue](https://github.com/flipt-io/flipt/issues/2907) for more information. + + + ### Flag State Configuration Each of Flipt's filesystem backends expects you to represent your feature flag configuration via a set of YAML files.