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: add remote config docs pre-release #204

Merged
merged 3 commits into from
Apr 30, 2024
Merged

chore: add remote config docs pre-release #204

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0d6e92
chore: add remote config docs pre-release
markphelps Apr 22, 2024
d6976b7
Merge branch 'main' into doc-remote-config
markphelps Apr 30, 2024
533b16f
Merge branch 'main' into doc-remote-config
markphelps Apr 30, 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
22 changes: 22 additions & 0 deletions configuration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,28 @@
You can edit any of these properties to your liking, and on restart Flipt will
pick up the new changes.

### Remote Configuration

Check warning on line 43 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Remote Configuration' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Remote Configuration' should be in sentence case", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 43, "column": 5}}}, "severity": "WARNING"}

As of `v1.41.0`, Flipt supports fetching configuration from a remote source. This is useful for managing configuration across multiple instances of Flipt. The remote configuration source can be a URL to a configuration file stored in one of the following object storage services:

Check warning on line 45 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": 45, "column": 197}}}, "severity": "WARNING"}

- S3 (eg: `s3://bucket-name/path/to/config.yml`)

Check failure on line 47 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Flipt.Spelling] Check the spelling of 'eg'. If the spelling is correct, add this word to the spelling exception list.

Raw Output:
{"message": "[Flipt.Spelling] Check the spelling of 'eg'. If the spelling is correct, add this word to the spelling exception list.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 47, "column": 7}}}, "severity": "ERROR"}

Check warning on line 47 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Punctuation] Use 'eg, or ie,' instead of 'eg:'

Raw Output:
{"message": "[Openly.Punctuation] Use 'eg, or ie,' instead of 'eg:'", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 47, "column": 7}}}, "severity": "WARNING"}
- Azure Blob Storage (eg: `azblob://container-name/path/to/config.yml`)

Check failure on line 48 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Flipt.Spelling] Check the spelling of 'eg'. If the spelling is correct, add this word to the spelling exception list.

Raw Output:
{"message": "[Flipt.Spelling] Check the spelling of 'eg'. If the spelling is correct, add this word to the spelling exception list.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 48, "column": 23}}}, "severity": "ERROR"}

Check warning on line 48 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Punctuation] Use 'eg, or ie,' instead of 'eg:'

Raw Output:
{"message": "[Openly.Punctuation] Use 'eg, or ie,' instead of 'eg:'", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 48, "column": 23}}}, "severity": "WARNING"}
- Google Cloud Storage (eg: `googlecloud://bucket-name/path/to/config.yml`)

Check failure on line 49 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Flipt.Spelling] Check the spelling of 'eg'. If the spelling is correct, add this word to the spelling exception list.

Raw Output:
{"message": "[Flipt.Spelling] Check the spelling of 'eg'. If the spelling is correct, add this word to the spelling exception list.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 49, "column": 25}}}, "severity": "ERROR"}

Check warning on line 49 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Punctuation] Use 'eg, or ie,' instead of 'eg:'

Raw Output:
{"message": "[Openly.Punctuation] Use 'eg, or ie,' instead of 'eg:'", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 49, "column": 25}}}, "severity": "WARNING"}

To load Flipt configuration from a remote source, replace the `config.yml` file with the URL to the remote configuration file in the `--config` flag when starting Flipt.

Check warning on line 51 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": 51, "column": 90}}}, "severity": "WARNING"}

```console
flipt --config s3://bucket-name/path/to/config.yml
```

For authenticating with the object storage service, you can use the following environment variables depending on the service:

- `AWS_ACCESS_KEY_ID` and `AWS_SECRET`
- `AZURE_STORAGE_ACCOUNT` and `AZURE_STORAGE_KEY` or `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, and `AZURE_CLIENT_SECRET`
- `GOOGLE_APPLICATION_CREDENTIALS`

These environment variables are used by the underlying object storage client libraries to authenticate with the object storage service and are the same values used in our [object storage configuration](/configuration/storage#object).

Check warning on line 63 in configuration/overview.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/overview.mdx", "range": {"start": {"line": 63, "column": 1}}}, "severity": "WARNING"}

Check warning on line 63 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 63, "column": 168}}}, "severity": "WARNING"}

## Environment Variables

All options in the configuration file can be overridden using environment
Expand Down
Loading