Skip to content

Commit 0141b54

Browse files
spuiukphlogistonjohn
authored andcommitted
docs: Document pvc path directive
Describe how to export a share within a pre-existing PVC. Signed-off-by: Sachin Prabhu <[email protected]>
1 parent 425177e commit 0141b54

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/howto.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,24 @@ Note that this only changes the name of the share in the SMB protocol.
5454
Resources created by the operator and other networking aspects may continue to
5555
reflect the name of the SmbShare resource.
5656

57+
# Export a path within a pre-existing PVC.
58+
59+
Given a pre-existing PVC `mypvc` containing a directory `exports` which is to be exported as a share.
60+
61+
```yaml
62+
apiVersion: samba-operator.samba.org/v1alpha1
63+
kind: SmbShare
64+
metadata:
65+
name: smbshare1
66+
spec:
67+
storage:
68+
pvc:
69+
name: "mypvc"
70+
path: "exports"
71+
readOnly: false
72+
```
73+
74+
The `path` directive only supports the export of top level directories within the PVC.
5775

5876
# Configure a share with custom users
5977

0 commit comments

Comments
 (0)