doc: add recommendation for nfs in external cluster #13876
Conversation
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in two weeks if no further activity occurs. Thank you for your contributions. |
|
This pull request has merge conflicts that must be resolved before it can be merged. @parth-gr please rebase it. https://rook.io/docs/rook/latest/Contributing/development-flow/#updating-your-fork |
Documentation/CRDs/Cluster/external-cluster/external-cluster.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Just one more nit, and I'll wait to approve until @BlaineEXE can review
parth-gr
force-pushed
the
external-nfs
branch
2 times, most recently
from
d0003c7
to
79385d9
Compare
|
@BlaineEXE ^^ |
There was a problem hiding this comment.
In general, I think that it is good for Rook to provide a suggestion for users on how to consume the external NFS export. This is especially true because we recommend a workflow that is different from RBD/CephFS with CSI.
That said, I think there are changes we could make to help users understand more generally, and specifically what to do to consume from an external NFS.
Documentation/CRDs/Cluster/external-cluster/external-cluster.md
Outdated
Show resolved
Hide resolved
Documentation/CRDs/ceph-nfs-crd.md
Outdated
| @@ -204,3 +204,17 @@ the size of the cluster. | |||
| ceph orch set backend "" | |||
| ceph mgr module disable rook | |||
| ``` | |||
|
|
|||
| ## External Clusters | |||
There was a problem hiding this comment.
This topic doesn't explicitly relate to the CephNFS CRD. It would be best to house this in the StorageConfiguration/NFS section. Probably the nfs.md file, at the end of the doc.
There was a problem hiding this comment.
I think the csi driver should be the right place, as it uses intree driver
Documentation/CRDs/ceph-nfs-crd.md
Outdated
| ceph nfs export create cephfs <nfs-client-name> /test <filesystem-name> | ||
| ``` | ||
|
|
||
| Create the [PV and PVC](https://github.com/kubernetes/examples/tree/master/staging/volumes/nfs) using `nfs-client-server-ip`. It will mount NFS volumes with PersistentVolumes and then mount the PVCs in the [user Pod Application](https://kubernetes.io/docs/concepts/storage/volumes/#nfs) to utilize the NFS type storage. |
There was a problem hiding this comment.
How do users know what the nfs-client-server-ip is? Where do they find that info?
Let's show this in the docs, or explain it.
Given that it's in code format, I assume that it's something from ceph CLI output?
There was a problem hiding this comment.
@nixpanic do you have any idea how we can get it?
There was a problem hiding this comment.
nfs:
path: /test
server: <nfs-client-server-ip>
```
the nfs server ip
Documentation/CRDs/ceph-nfs-crd.md
Outdated
| ```yaml | ||
| ceph nfs export create cephfs <nfs-client-name> /test <filesystem-name> | ||
| ``` |
There was a problem hiding this comment.
To be honest, I don't think Rook should document this. Users should defer to Ceph docs for instructions on how to create exports.
Instead, Rook docs should explain how to use a Ceph export's configurations (maybe it's already existing, maybe users create it just for Rook, it doesn't matter) in the PV/PVC.
I think this command should more rightly be a ceph nfs export get <service> <export-name> command, and then we can show how to use the example output of that command to configure the PV/PVCs.
There was a problem hiding this comment.
lets keep both for simplicity
|
This pull request has merge conflicts that must be resolved before it can be merged. @parth-gr please rebase it. https://rook.io/docs/rook/latest/Contributing/development-flow/#updating-your-fork |
BlaineEXE
changed the title
|
Please update the commit title to match the recently updated PR title, or something similar. We are no longer adding a design doc. |
with recent discussion we come to conclusion nfs can be suported easily in the external cluster so adding the design that we discussed closes: rook#13277 Signed-off-by: parth-gr <partharora1010@gmail.com> Signed-off-by: parth-gr <paarora@redhat.com>
|
@BlaineEXE please review I have updated the changes |
with recent discussion we come to conclusion
nfs can be suported easily in the external cluster
so adding the design that we discussed
closes: #13277
Checklist: