From 5819cfa41754e9566ff7bcbffe246bc918a0697c Mon Sep 17 00:00:00 2001 From: Roman Dmytrenko Date: Fri, 5 Apr 2024 19:12:43 +0300 Subject: [PATCH] docs(storage/oci): added new OCI authentication configuration property type (#201) --- configuration/overview.mdx | 1 + configuration/storage.mdx | 15 +++++++++++++-- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/configuration/overview.mdx b/configuration/overview.mdx index c4a06bb..d502d9c 100644 --- a/configuration/overview.mdx +++ b/configuration/overview.mdx @@ -268,6 +268,7 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001" | 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 | +| storage.oci.authentication.type | The type to use for authentication | static | v1.40.0 | ### Cache diff --git a/configuration/storage.mdx b/configuration/storage.mdx index e9f12f1..0b41b37 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -496,14 +496,25 @@ Flipt has its own custom OCI manifest format (we call them `bundles`), which can - Certain OCI registries may require setting the OCI manifest version to something other than the default (`1.1`) to work correctly. - + 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. +#### Authentication + +Starting from version `1.40.0`, Flipt offers two authentication methods: + +- **Static**: This is the default method that uses a username and password for authentication. +- **AWS ECR**: If you're using Flipt on AWS with a private ECR repository, you can configure authentication differently. + Set either the `FLIPT_STORAGE_OCI_AUTHENTICATION_TYPE` environment variable or the `storage.oci.authentication.type` configuration property to `aws-ecr`. + Additionally, make sure your compute instance or container has a role with permissions to pull from ECR. + +See [this issue](https://github.com/flipt-io/flipt/issues/2938) 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.