Add comments relating memory sizing. #88
Conversation
charts/stardog/README.md
Outdated
| Memory settings are part of both javaArgs and resources within | ||
| values.yaml. The settings must be coordinated. | ||
|
|
||
| Stardog will aggressive use all memory allocated to it via the |
charts/stardog/README.md
Outdated
| must be at least 1g larger than -Xmx and -XX:MaxDirectMemorySize total. A | ||
| too small limits:memory setting will likely result in a system crash. | ||
|
|
||
| Network based disk storage is not recommended. If used, the |
There was a problem hiding this comment.
Can you clarify with some examples here vs block storage
There was a problem hiding this comment.
Rewrote the network storage section completely differently. And remembered we used a different approach with Disney and Windows SMB.
|
|
||
| Network based disk storage is not recommended. This include NFS, SMB, and | ||
| EFS based storage systems. | ||
|
|
There was a problem hiding this comment.
On AWS, we recommend gp2 as the storageClass. On GKS and AKS standard (the default) is what we recommend. I would just add something like "we instead recommend setting the storageClass to gp2 on AWS and leaving the default values of standard for Azure and GCP."
There was a problem hiding this comment.
Just to clarify from discussions outside of this PR. I think we should call out a bit more details that the storage classes may not always be named this depending on how they are configured. Instead we should tell people to use block volume storage classes for their infrastructure and depending on their use case they may want to explore differences between the types, e.g. gp2 vs io2 or standard vs premium. We can also link to the k8s docs on storage classes for further information: https://kubernetes.io/docs/concepts/storage/storage-classes/
There was a problem hiding this comment.
To include the suggestions from Paul's comment, I would edit it to read something like:
Stardog instead recommends using block volume storage classes such as gp2 on AWS or standard on other platforms. Depending on use case, it is recommended to explore differences between the types, e.g. gp2 vs io2 or standard vs premium.
|
|
||
| Network based disk storage is not recommended. This include NFS, SMB, and | ||
| EFS based storage systems. | ||
|
|
There was a problem hiding this comment.
To include the suggestions from Paul's comment, I would edit it to read something like:
Stardog instead recommends using block volume storage classes such as gp2 on AWS or standard on other platforms. Depending on use case, it is recommended to explore differences between the types, e.g. gp2 vs io2 or standard vs premium.
Adding comments about memory sizing in README.md and values.yaml.
These changes were part of the discussions to correct a customer issue in PLAT-5010. (Not naming customer since this is a public repo.)