docs: add jcloud executor availability parameters #5624
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexcg1
requested changes
Jan 25, 2023
docs/concepts/jcloud/yaml-spec.md
Outdated
|
|
||
| In case of any unlikely event that would cause the service disruption of executors, JCloud allows users to specify a tolerance level in terms of number of replicas. | ||
|
|
||
| The JCloud parameters minAvailable and maxUnavailable ensures the absense of some replicas of an executor to be with in the limits of toleration. |
There was a problem hiding this comment.
Suggested change
| The JCloud parameters minAvailable and maxUnavailable ensures the absense of some replicas of an executor to be with in the limits of toleration. | |
| The JCloud parameters `minAvailable` and `maxUnavailable` ensure that Executors will stay up even if a certain number of replicas go down. |
Please spell-check in future :)
I did quite a significant rewrite. Is it still accurate?
docs/concepts/jcloud/yaml-spec.md
Outdated
Comment on lines
261
to
262
| | minAvailable | NA | lesser than [replicas](https://docs.jina.ai/concepts/flow/scale-out/#scale-out) | the minimum number of replicas available during the disruption | | ||
| | maxUnavailable | NA | lesser than [replicas](https://docs.jina.ai/concepts/flow/scale-out/#scale-out) | the maximum number of replicas unavailable during the disruption | |
There was a problem hiding this comment.
Suggested change
| | minAvailable | NA | lesser than [replicas](https://docs.jina.ai/concepts/flow/scale-out/#scale-out) | the minimum number of replicas available during the disruption | | |
| | maxUnavailable | NA | lesser than [replicas](https://docs.jina.ai/concepts/flow/scale-out/#scale-out) | the maximum number of replicas unavailable during the disruption | | |
| | `minAvailable` | N/A | Lower than number of [replicas](https://docs.jina.ai/concepts/flow/scale-out/#scale-out) | Minimum number of replicas available during disruption | | |
| | `maxUnavailable` | N/A | Lower than numbers of [replicas](https://docs.jina.ai/concepts/flow/scale-out/#scale-out) | Maximum number of replicas unavailable during disruption | |
docs/concepts/jcloud/yaml-spec.md
Outdated
| jcloud: | ||
| minAvailable: 2 | ||
| ``` | ||
| > In case of unlike disruption, it is ensured that at least 2 replicas would still be available. 3 replicas may be unavailable. |
There was a problem hiding this comment.
Suggested change
| > In case of unlike disruption, it is ensured that at least 2 replicas would still be available. 3 replicas may be unavailable. | |
| > In case of unlike disruption, ensure at least two replicas will still be available, while 3 may be down. |
- What does 'unlike' mean? unlikely?
docs/concepts/jcloud/yaml-spec.md
Outdated
| jcloud: | ||
| maxUnavailable: 2 | ||
| ``` | ||
| > In case of unlike disruption, it is ensured that at maximum 2 replicas would not be available. At least 3 replicas would still be available. |
There was a problem hiding this comment.
Suggested change
| > In case of unlike disruption, it is ensured that at maximum 2 replicas would not be available. At least 3 replicas would still be available. | |
| > In case of unlike disruption, ensure that if a maximum of 2 replicas are down, at least 3 replicas will still be available. |
Again, unlike means...?
docs/concepts/jcloud/yaml-spec.md
Outdated
| > In case of unlike disruption, it is ensured that at maximum 2 replicas would not be available. At least 3 replicas would still be available. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Configure gateway |
There was a problem hiding this comment.
Suggested change
| ## Configure gateway | |
| ## Configure Gateway |
docs/concepts/jcloud/yaml-spec.md
Outdated
| @@ -250,6 +250,45 @@ Below are the defaults and requirements for the configurations: | |||
|
|
|||
| 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! | |||
|
|
|||
| ## Configure Availability Tolerance | |||
|
|
|||
| In case of any unlikely event that would cause the service disruption of executors, JCloud allows users to specify a tolerance level in terms of number of replicas. | |||
There was a problem hiding this comment.
Suggested change
| In case of any unlikely event that would cause the service disruption of executors, JCloud allows users to specify a tolerance level in terms of number of replicas. | |
| If service issues cause disruption of Executors, JCloud lets you specify a tolerance level for number of replicas that stay up or go down. |
|
@subbuv26 what's status on this? |
Sorry for the delay, addressed review comment, please review again. thanks. |
alexcg1
requested changes
Jan 31, 2023
docs/concepts/jcloud/yaml-spec.md
Outdated
| jcloud: | ||
| minAvailable: 2 | ||
| ``` | ||
| > In case of unlike disruption, ensure at least two replicas will still be available, while 3 may be down. |
There was a problem hiding this comment.
Suggested change
| > In case of unlike disruption, ensure at least two replicas will still be available, while 3 may be down. | |
| > In case of disruption, ensure at least two replicas will still be available, while three may be down. |
docs/concepts/jcloud/yaml-spec.md
Outdated
| jcloud: | ||
| maxUnavailable: 2 | ||
| ``` | ||
| > In case of unlike disruption, ensure that if a maximum of 2 replicas are down, at least 3 replicas will still be available. |
There was a problem hiding this comment.
Suggested change
| > In case of unlike disruption, ensure that if a maximum of 2 replicas are down, at least 3 replicas will still be available. | |
| > In case of disruption, ensure that if a maximum of two replicas are down, at least three replicas will still be available. |
docs/concepts/jcloud/yaml-spec.md
Outdated
| @@ -250,8 +250,45 @@ Below are the defaults and requirements for the configurations: | |||
|
|
|||
| 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! | |||
|
|
|||
| ## Configure Availability Tolerance | |||
There was a problem hiding this comment.
Suggested change
| ## Configure Availability Tolerance | |
| ## Configure availability tolerance |
docs/concepts/jcloud/yaml-spec.md
Outdated
| @@ -250,8 +250,45 @@ Below are the defaults and requirements for the configurations: | |||
|
|
|||
| 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! | |||
There was a problem hiding this comment.
Suggested change
| 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! | |
| 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 can deal with the code! |
docs/concepts/jcloud/yaml-spec.md
Outdated
| --- | ||
| jtype: Flow | ||
| executors: | ||
| - uses: jinahub+docker://Sentencizer |
alexcg1
reviewed
Jan 31, 2023
docs/concepts/jcloud/yaml-spec.md
Outdated
|
|
||
| ```{code-block} yaml | ||
| --- | ||
| emphasize-lines: 5-6 | ||
| --- | ||
| jtype: Flow | ||
| executors: | ||
| - uses: jinahub+docker://Sentencizer | ||
| - uses: jinaai+docker://Sentencizer |
There was a problem hiding this comment.
Is this missing the username portion?
|
📝 Docs are deployed on https://jcloud_docs--jina-docs.netlify.app 🎉 |
JoanFM
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals: