Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This introduces a new CRD to add the ability to create subvolumegroup for a given ceph filesystem volume. Typically the name of the volume is the name of the filesystem created by rook. Closes: #7036 Signed-off-by: Sébastien Han <seb@redhat.com>
- Loading branch information
Showing
28 changed files
with
1,461 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,7 @@ | |
"rbd-mirror", | ||
"rgw", | ||
"security", | ||
"subvolumegroup", | ||
"test" | ||
] | ||
], | ||
|
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
title: CephFilesystemSubVolumeGroup CRD | ||
weight: 3610 | ||
indent: true | ||
--- | ||
|
||
{% include_relative branch.liquid %} | ||
|
||
This guide assumes you have created a Rook cluster as explained in the main [Quickstart guide](quickstart.md) | ||
|
||
# CephFilesystemSubVolumeGroup CRD | ||
|
||
Rook allows creation of Ceph Filesystem [SubVolumeGroups](https://docs.ceph.com/en/latest/cephfs/fs-volumes/#fs-subvolume-groups) through the custom resource definitions (CRDs). | ||
Filesystem subvolume groups are an abstraction for a directory level higher than Filesystem subvolumes to effect policies (e.g., File layouts) across a set of subvolumes. | ||
For more information about CephFS volume, subvolumegroup and subvolume refer to the [Ceph docs](https://docs.ceph.com/en/latest/cephfs/fs-volumes/#fs-volumes-and-subvolumes). | ||
|
||
## Creating daemon | ||
|
||
To get you started, here is a simple example of a CRD to create a subvolumegroup on the CephFilesystem "myfs". | ||
|
||
```yaml | ||
apiVersion: ceph.rook.io/v1 | ||
kind: CephFilesystemSubVolumeGroup | ||
metadata: | ||
name: my-subvolumegroup | ||
namespace: rook-ceph # namespace:cluster | ||
spec: | ||
# volumeName is the name of the CephFilesystem CR | ||
volumeName: myfs | ||
``` | ||
|
||
## Settings | ||
|
||
If any setting is unspecified, a suitable default will be used automatically. | ||
|
||
### CephFilesystemSubVolumeGroup metadata | ||
|
||
- `name`: The name that will be used for the Ceph Filesystem subvolume group. | ||
- `namespace`: The Kubernetes namespace that will be created for the Rook cluster. The services, pods, and other resources created by the operator will be added to this namespace. | ||
|
||
|
||
### CephFilesystemSubVolumeGroup spec | ||
|
||
- `volumeName`: The name of the Ceph Filesystem volume. |
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
apiVersion: ceph.rook.io/v1 | ||
kind: CephFilesystemSubVolumeGroup | ||
metadata: | ||
name: my-subvolumegroup | ||
namespace: rook-ceph # namespace:cluster | ||
spec: | ||
# volumeName is the name of the CephFilesystem CR | ||
volumeName: myfs |
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
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.