Issue 495: Validate Pravega manifest settings before deployment #584
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
Signed-off-by: Nishant Gupta <[email protected]>
jkhalack
reviewed
Oct 20, 2021
Comment on lines
+1210
to
+1218
| totalMemoryQuantity := p.Spec.Pravega.SegmentStoreResources.Requests[corev1.ResourceMemory] | ||
| if (resource.Quantity{}) == totalMemoryQuantity { | ||
| return fmt.Errorf("Missing required value for field .spec.pravega.segmentStoreResources.requests.memory") | ||
| } | ||
|
|
||
| cacheSizeString := p.Spec.Pravega.Options["pravegaservice.cache.size.max"] | ||
| if cacheSizeString == "" { | ||
| return fmt.Errorf("Missing required value for option pravegaservice.cache.size.max") | ||
| } |
There was a problem hiding this comment.
I'm not sure we need to make these two values required.
If they are to be required, they need to be made required in the CRD and the requirement needs to be documented.
Codecov Report
@@ Coverage Diff @@
## master #584 +/- ##
==========================================
- Coverage 74.17% 73.46% -0.72%
==========================================
Files 16 16
Lines 4229 4270 +41
==========================================
Hits 3137 3137
- Misses 962 1003 +41
Partials 130 130
Continue to review full report at Codecov.
|
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.
Signed-off-by: Nishant Gupta [email protected]
Change log description
While deploying Pravega , Segment Store settings should adhere to the following rules:
POD_MEM_LIMIT > JVM Heap (
-Xmx) + JVM Direct Memory (-XX:MaxDirectMemorySize)JVM Direct Memory > JVM Heap
JVM Direct memory > Segment Store read cache size (
pravegaservice.cache.size.max)Here we are validating the above scenarios before deployment by the operator happens instead of manually relying on the user to set them right.
Purpose of the change
Fixes #495
What the code does
The code makes sure the following checks are performed by the operator before deploying Pravega:
POD_MEM_LIMIT > JVM Heap + JVM Direct Memory
JVM Direct Memory > JVM Heap
JVM Direct memory > Segment Store read cache size
How to verify it
Try setting different values for
.spec.pravega.segmentStoreResources.requests.memory,-Xmx,-XX:MaxDirectMemorySizeandpravegaservice.cache.size.maxand the operator should return error in case the above mentioned rules are not met.