Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(storage/oci): added new OCI authentication configuration property type #201

Merged
merged 4 commits into from
Apr 5, 2024
Merged

docs(storage/oci): added new OCI authentication configuration property type #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7323a3e
docs: added new OCI authentication configuration property type
erka Apr 5, 2024
59616d7
cleanup
erka Apr 5, 2024
3f78892
Merge branch 'main' into oci-auth-type
markphelps Apr 5, 2024
e3c7222
Apply suggestions from code review
erka Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions configuration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
15 changes: 13 additions & 2 deletions configuration/storage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,14 +496,25 @@
</Tabs>

<Note>
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.

Check warning on line 499 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "configuration/storage.mdx", "range": {"start": {"line": 499, "column": 3}}}, "severity": "WARNING"}

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.

</Note>

#### 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.
Expand Down
Loading