-
Notifications
You must be signed in to change notification settings - Fork 166
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.
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
doc: add a page explaining storage class parameters #762
doc: add a page explaining storage class parameters #762
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- It's better to add one example at the beginning.
- I think we can explain how Longhorn creates the default SC. And why we use a ConfigMap to create that default SC (since some fields are immutable.)
b445a45
to
e5d1ae2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Much improved. A couple of questions still. One big thing we need to do is "backport" this to other versions of the website. Probably we don't need to go all the way back to the beginning of time, but to the versions that aren't EOL. That will be annoying, as some of these options are new.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, LGTM. Just some minor suggestions.
Good job, James.
The PR LGTM once all the above review comments are resolved. |
& incorporate review feedback Signed-off-by: James Munson <[email protected]>
Signed-off-by: James Munson <[email protected]>
Signed-off-by: James Munson <[email protected]>
e5d1ae2
to
c5bca59
Compare
Signed-off-by: James Munson <[email protected]>
Signed-off-by: James Munson <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like you addressed every comment of mine but one. This is looking really good. Still need to add a version of this (minus newly introduced parameters) to other versions IMO. Let me know if you disagree.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. The only remaining from my side is to have this page for the latest existing patch or upcoming patch release doc as well, such as 1.3.3. 1.4.3 & 1.4.4, 1.5.1 & 1.5.2.
P.S. No need to have that in 1.3.4, since it's EOL and we will not release it.
…and 1.5.x docs Signed-off-by: James Munson <[email protected]>
I added the 1.4.x and 1.5.x versions. I did not add a 1.3.x version. If we do that, it will also require adjusting filesystem trim and mkfs parameters. WDYT? Worth going back that far? |
Signed-off-by: James Munson <[email protected]>
Signed-off-by: James Munson <[email protected]>
Also added documentation for "replica disk soft anti-affinity" to global settings and replica scheduling section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the Replica Disk Soft Anti Affinity addition. Looks good!
I am personally fine with not including this page on the v1.3.x branch given its EOL status, so approving. Not sure where others will fall.
I am fine with not having it in 1.3.x too |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but some comments need to resolve first.
> Global setting: [Replica Zone Level Soft Anti-Affinity](../settings#replica-zone-level-soft-anti-affinity). | ||
> More details in [Scheduling](../../volumes-and-nodes/scheduling). | ||
|
||
#### Backend Store Driver *(field: `parameters.backendStoreDriver`)* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The value should be v1 or v2. If it's empty, it's just v1.
/k8s/pkg/apis/longhorn/v1beta2/volume.go#L162-L165
const (
BackendStoreDriverTypeV1 = BackendStoreDriverType("v1")
BackendStoreDriverTypeV2 = BackendStoreDriverType("v2")
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. Fixed, thanks.
|
||
When this setting is un-checked, Longhorn Manager will not allow scheduling new replicas of a volume to the same disks as existing healthy replicas. | ||
|
||
> **Note:** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is it not false
by default? A disk with two replicas of a volume seems not a good practice.
BTW, Node Soft Anti Affinity
will supersede this setting if it's false
. It's better to mention this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh, it was reviewed. It's about backward compatibility. https://github.com/longhorn/longhorn/blob/master/enhancements/20230718-disk-anti-affinity.md#upgrade-strategy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added, thanks.
Signed-off-by: James Munson <[email protected]>
longhorn/longhorn#4776