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

chore: document oci manifest version and github teams #197

Merged
merged 1 commit into from
Mar 27, 2024
Merged

chore: document oci manifest version and github teams #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 12 additions & 10 deletions configuration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,16 +165,17 @@

#### 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 |

Check warning on line 175 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.

Raw Output:
{"message": "[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 175, "column": 64}}}, "severity": "WARNING"}
| 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

Expand Down Expand Up @@ -266,6 +267,7 @@
| 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

Expand Down
11 changes: 11 additions & 0 deletions configuration/storage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,7 @@
FLIPT_STORAGE_OCI_AUTHENTICATION_PASSWORD="password"
# location used for storing local bundles
FLIPT_STORAGE_OCI_BUNDLES_DIRECTORY="<user_config_dir>/flipt/bundles"
FLIPT_STORAGE_OCI_MANIFEST_VERSION="1.1"
```

</Tab>
Expand All @@ -488,11 +489,21 @@
username: "username"
password: "password"
bundles_directory: "<user_config_dir>/flipt/bundles"
manifest_version: "1.1"
```

</Tab>
</Tabs>

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

Check warning on line 501 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.", "location": {"path": "configuration/storage.mdx", "range": {"start": {"line": 501, "column": 172}}}, "severity": "WARNING"}

Check warning on line 501 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Punctuation] Use 'eg' instead of 'e.g.'

Raw Output:
{"message": "[Openly.Punctuation] Use 'eg' instead of 'e.g.'", "location": {"path": "configuration/storage.mdx", "range": {"start": {"line": 501, "column": 172}}}, "severity": "WARNING"}

See [this issue](https://github.com/flipt-io/flipt/issues/2907) for more information.

</Note>

### 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