docs(jcloud): added documentation for retain (jina-ai#5572)

osmanbaskaya · Jan 9, 2023 · 210d75f · 210d75f
1 parent 139cd2b
commit 210d75f
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/docs/concepts/jcloud/yaml-spec.md b/docs/concepts/jcloud/yaml-spec.md
@@ -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.
 
 ```{code-block} yaml
 ---
-emphasize-lines: 5-9,12,15
+emphasize-lines: 5-10,12,15
 ---
 jtype: Flow
 executors:
@@ -175,6 +176,7 @@ executors:
         storage:
           type: ebs
           size: 10G
+          retain: true
   - name: executor2
     uses: jinaai+docker://<username>/Executor2
     jcloud:
@@ -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!