chore(docs): FilePermissions cas config user documentation #128
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
Codecov Report
@@ Coverage Diff @@
## develop #128 +/- ##
========================================
Coverage 49.79% 49.79%
========================================
Files 38 38
Lines 2705 2705
========================================
Hits 1347 1347
Misses 1255 1255
Partials 103 103 Continue to review full report at Codecov.
|
mittachaitu
pushed a commit
that referenced
this pull request
Dec 14, 2021
This PR introduces the FilePermissions `cas.openebs.io/config` PersistentVolumeClaim key. The data keys included within this config key are UID, GID, and mode. The openebs-nfs-provisioner process sets the values from these PersistentVolumeClaim keys into the ENVs FILEPERMISSIONS_UID, FILEPERMISSIONS_GID and FILEPERMISSIONS_MODE. The /nfs-server-container/nfsd.sh script issues chmod and chown commands to change the ownership and file mode of the shared filesystem directory (backend volume at /nfsshare). The checking criteria is similar to the Kubernetes fsGroupChangePolicy OnRootMismatch. NOTE: This also generates logs that announce the deprecation of the FSGID cas.openebs.io/config option in future releases. FSGID-like changes can be accomplished with file permissions. Instructions for this have been furnished in the user documentation(#128). If 'FSGID' is specified, and 'GID' and/or 'mode' FilePermissions keys are also specified, this is treated as an invalid input and provisioning fail. This is done to keep the file permissions strictly declarative. Signed-off-by: Niladri Halder <[email protected]>
mittachaitu
reviewed
Jan 3, 2022
There was a problem hiding this comment.
Changes looks good but we also need to update the troubleshooting doc with related changes
|
Can you also create another PR with helm changes for release? |
Signed-off-by: Niladri Halder <[email protected]>
Signed-off-by: Niladri Halder <[email protected]>
Signed-off-by: Niladri Halder <[email protected]>
Signed-off-by: Niladri Halder <[email protected]>
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: Niladri Halder [email protected]
Why is this PR required? What issue does it fix?:
This PR contains the user documentation for the FilePermissions feature in #125
What this PR does?:
Adds docs/tutorials/file-permissions.md
Does this PR require any upgrade changes?:
No
If the changes in this PR are manually verified, list down the scenarios covered::
The instructions in this doc have been verified manually.
Any additional information for your reviewer? :
This PR should be merged as a release activity after #125 is merged.