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.

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

Document that auto_extend_size_limit is required if you want your volume to extend #1812

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions reference/configuration.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -681,7 +681,7 @@
* `kill_signal`: The signal to send to the test process if it runs too long. Defaults to the signal of the image, if a custom image is set.
* `kill_timeout`: The time to wait before sending the kill signal. Defaults to the timeout of the image, if a custom image is set.

Machine checks are especially useful for canary deploys. `flyctl` will spawn a new Machine, ensure all machine capabilities are functional, and then deploy the rest of the Machines in your app.

Check warning on line 684 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machine' instead of 'machine'. Raw Output: {"message": "[Fly.Machine] Use 'Machine' instead of 'machine'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 684, "column": 103}}}, "severity": "INFO"}

## The `mounts` section

Expand Down Expand Up @@ -732,15 +732,16 @@

### `auto_extend_size_threshold`

Optional. The threshold of storage used on a volume, by percentage, that triggers extending the volume's size by the value of `auto_extend_size_increment`.
Optional. The threshold of storage used on a volume, by percentage, that triggers extending the volume's size by the value of `auto_extend_size_increment`,
unless the resulting size would exceed `auto_extend_size_limit`.

### `auto_extend_size_increment`

The increment, in GB, by which to extend the volume after reaching the `auto_extend_size_threshold`. Required with `auto_extend_size_threshold`.

### `auto_extend_size_limit`

The total amount, in GB, to extend a volume. Optional with `auto_extend_size_increment`.
Maximum size, in GB, of a volume after an extension is completed. Required with `auto_extend_size_threshold`.

### Auto extend volume size configuration

Expand Down Expand Up @@ -847,13 +848,13 @@
processes = ["app"]
```

When a machine unexpectedly exits, our scheduling machinery follows a machine’s restart policy to restart it without your intervention. These policies are quite similar to docker’s container restart policies:

Check warning on line 851 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machine' instead of 'machine'. Raw Output: {"message": "[Fly.Machine] Use 'Machine' instead of 'machine'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 851, "column": 7}}}, "severity": "INFO"}

Check warning on line 851 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machine' instead of 'machine'. Raw Output: {"message": "[Fly.Machine] Use 'Machine' instead of 'machine'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 851, "column": 70}}}, "severity": "INFO"}

- always: we’ll attempt to restart the machine no matter the exit code.

Check warning on line 853 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machine' instead of 'machine'. Raw Output: {"message": "[Fly.Machine] Use 'Machine' instead of 'machine'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 853, "column": 39}}}, "severity": "INFO"}
- never: we won’t restart the machine even if it exits with a non-zero exit code.

Check warning on line 854 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machine' instead of 'machine'. Raw Output: {"message": "[Fly.Machine] Use 'Machine' instead of 'machine'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 854, "column": 30}}}, "severity": "INFO"}
- on-failure: we’ll only restart the machine if it exited with a non-zero exit code (due to a failure or crash). This is the default policy if one is not explicitly set.

Check warning on line 855 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machine' instead of 'machine'. Raw Output: {"message": "[Fly.Machine] Use 'Machine' instead of 'machine'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 855, "column": 37}}}, "severity": "INFO"}

A restart policy can be targeted to a specific process group. If a group is not specified, all machines in an app will have the same default restart policy. You can also specify the number of times we should retry restarting the machine before giving up.

Check warning on line 857 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machines' instead of 'machines'. Raw Output: {"message": "[Fly.Machine] Use 'Machines' instead of 'machines'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 857, "column": 95}}}, "severity": "INFO"}

Check warning on line 857 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machine' instead of 'machine'. Raw Output: {"message": "[Fly.Machine] Use 'Machine' instead of 'machine'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 857, "column": 229}}}, "severity": "INFO"}

## The `checks` section

Expand Down Expand Up @@ -974,7 +975,7 @@

The "guest path" --- the path inside your container where the files to serve are located --- can overlap with other static mappings; the URL prefix should not (so, two mappings to `/public/foo` and `/public/bar` are fine, but two mappings to `/public` are not).

Alternatively, you can serve statics directly from object storage using [Tigris](/docs/tigris/). Similar to machine statics, requests under `url_prefix` are served from static assets in your Tigris bucket under `guest_path`. The same rules apply for overlapping URL prefixes.

Check warning on line 978 in reference/configuration.html.markerb

View workflow job for this annotation

GitHub Actions / Vale linter

[vale] reported by reviewdog 🐶 [Fly.Machine] Use 'Machine' instead of 'machine'. Raw Output: {"message": "[Fly.Machine] Use 'Machine' instead of 'machine'.", "location": {"path": "reference/configuration.html.markerb", "range": {"start": {"line": 978, "column": 108}}}, "severity": "INFO"}

```toml
[[statics]]
Expand Down
Loading