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 docs for configuring git storage backend #217

Merged
merged 3 commits into from
May 30, 2024
Merged

chore: add docs for configuring git storage backend #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
59d50ec
chore: add docs for configuring git storage backend
markphelps May 26, 2024
127d0c9
chore: fix backend type
markphelps May 26, 2024
678bd12
Merge branch 'main' into git-storage-backend
markphelps May 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
30 changes: 16 additions & 14 deletions configuration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,20 +264,22 @@

#### Storage Git

| Property | Description | Default | Since |
| ------------------------------------------------------- | ----------------------------------------------------------- | ------- | ------- |
| storage.git.repository | The URL of the git repository to use | | v1.25.0 |
| storage.git.ref | The git ref to use | main | v1.25.0 |
| storage.git.ref_type | How to parse the git ref (static, semver) | static | v1.41.0 |
| storage.git.poll_interval | The interval to poll the git repository and ref for changes | 30s | v1.25.0 |
| storage.git.directory | The root directory to search in the repository | | v1.40.0 |
| storage.git.authentication.basic.username | The username to use for basic authentication | | v1.25.0 |
| storage.git.authentication.basic.password | The password to use for basic authentication | | v1.25.0 |
| storage.git.authentication.token | The access token to use for authentication | | v1.25.0 |
| storage.git.authentication.ssh.password | Password used to generate the SSH key pair | | v1.30.0 |
| storage.git.authentication.ssh.private_key_path | Path to private key on the filesystem | | v1.30.0 |
| storage.git.authentication.ssh.private_key_bytes | (Alternative) Raw private key bytes | | v1.30.0 |
| storage.git.authentication.ssh.insecure_ignore_host_key | Skip verifying the known hosts key (avoid in production) | false | v1.30.0 |
| Property | Description | Default | Since |
| ------------------------------------------------------- | ---------------------------------------------------------------------- | ------- | ------- |
| storage.git.repository | The URL of the git repository to use | | v1.25.0 |

Check warning on line 269 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": 269, "column": 65}}}, "severity": "WARNING"}
| storage.git.ref | The git ref to use | main | v1.25.0 |
| storage.git.ref_type | How to parse the git ref (static, semver) | static | v1.41.0 |
| storage.git.poll_interval | The interval to poll the git repository and ref for changes | 30s | v1.25.0 |
| storage.git.directory | The root directory to search in the repository | | v1.40.0 |
| storage.git.authentication.basic.username | The username to use for basic authentication | | v1.25.0 |
| storage.git.authentication.basic.password | The password to use for basic authentication | | v1.25.0 |
| storage.git.authentication.token | The access token to use for authentication | | v1.25.0 |
| storage.git.authentication.ssh.password | Password used to generate the SSH key pair | | v1.30.0 |
| storage.git.authentication.ssh.private_key_path | Path to private key on the filesystem | | v1.30.0 |
| storage.git.authentication.ssh.private_key_bytes | (Alternative) Raw private key bytes | | v1.30.0 |
| storage.git.authentication.ssh.insecure_ignore_host_key | Skip verifying the known hosts key (avoid in production) | false | v1.30.0 |
| storage.git.backend.type | The backend to use for git repository storage (options: memory, local) | memory | v1.43.0 |

Check warning on line 281 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.

Raw Output:
{"message": "[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 281, "column": 15}}}, "severity": "WARNING"}

Check warning on line 281 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.

Raw Output:
{"message": "[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 281, "column": 65}}}, "severity": "WARNING"}
| storage.git.backend.local.path | The path to the local storage directory for git backend | | v1.43.0 |

Check warning on line 282 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.

Raw Output:
{"message": "[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 282, "column": 15}}}, "severity": "WARNING"}

Check warning on line 282 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.

Raw Output:
{"message": "[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 282, "column": 109}}}, "severity": "WARNING"}

#### Storage Object

Expand Down
16 changes: 16 additions & 0 deletions configuration/storage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,22 @@

See our [GitOps Guide](/guides/get-going-with-gitops) for an example of how to set up a GitHub repository as a flag state backend.

#### Repository Storage

Check warning on line 282 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / Vale 

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

Raw Output:
{"message": "[Openly.Titles] 'Repository Storage' should be in sentence case", "location": {"path": "configuration/storage.mdx", "range": {"start": {"line": 282, "column": 6}}}, "severity": "WARNING"}

The `git` backend also supports configuring where the Git repository is cloned to.

Check warning on line 284 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.

Raw Output:
{"message": "[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.", "location": {"path": "configuration/storage.mdx", "range": {"start": {"line": 284, "column": 11}}}, "severity": "WARNING"}

Check warning on line 284 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'so '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'so '", "location": {"path": "configuration/storage.mdx", "range": {"start": {"line": 284, "column": 21}}}, "severity": "WARNING"}

By default, Flipt will clone the repository to an in-memory filesystem, but you can configure a local directory to clone the repository to which is useful for relieving memory pressure especially for large repositories.

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

Check warning on line 286 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.FutureTense] Possible future tense.

Raw Output:
{"message": "[Openly.FutureTense] Possible future tense.", "location": {"path": "configuration/storage.mdx", "range": {"start": {"line": 286, "column": 19}}}, "severity": "WARNING"}

```yaml
storage:
type: git
git:
repository: [email protected]:flipt-io/some-private-repo.git
backend:
type: local
path: /var/opt/flipt/git
```

### Object

The object storage type supports using a hosted object storage service as the source of truth for Flipt state configuration.
Expand Down
Loading