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(jcloud): added documentation for retain #5572

Merged
merged 1 commit into from
Jan 9, 2023
Merged

docs(jcloud): added documentation for retain #5572

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
14 changes: 8 additions & 6 deletions docs/concepts/jcloud/yaml-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,11 @@ If your Executor needs high IO, you can use `ebs` instead. Please note that:
- You must pass a storage size parameter (default: `1G`, max `10G`).

````
JCloud also supports retaining the data a Flow was using while active. You can set the `retain` argument to `true` to enable this feature.
alexcg1 marked this conversation as resolved.
Show resolved Hide resolved

```{code-block} yaml
---
emphasize-lines: 5-9,12,15
emphasize-lines: 5-10,12,15
---
jtype: Flow
executors:
Expand All @@ -175,6 +176,7 @@ executors:
storage:
type: ebs
size: 10G
retain: true
- name: executor2
uses: jinaai+docker://<username>/Executor2
jcloud:
Expand Down Expand Up @@ -231,12 +233,12 @@ executors:

Below are the defaults and requirements for the configurations:

| Name | Default | Allowed | Description |
| ------ | ----------- | ------------------------ | ----------------------------------------------- |
| Name | Default | Allowed | Description |
| ------ | ----------- | ------------------------ | ------------------------------------------------- |
| min | 1 | int | Minimum number of replicas (`0` means serverless) |
| max | 2 | int, up to 5 | Maximum number of replicas |
| metric | concurrency | `concurrency` / `rps` | Metric for scaling |
| target | 100 | int | Target number after which replicas autoscale |
| max | 2 | int, up to 5 | Maximum number of replicas |
| metric | concurrency | `concurrency` / `rps` | Metric for scaling |
| target | 100 | int | Target number after which replicas autoscale |

After JCloud deployment using the autoscaling configuration, the Flow serving part is just the same; the only difference you may notice is it takes a few extra seconds to handle the initial requests since it needs to scale the deployments behind the scenes. Let JCloud handle the scaling from now on, and you should only worry about the code!

Expand Down