From e99084120655c08f623a5d1794001ed34c5efb6f Mon Sep 17 00:00:00 2001 From: Alexander Trost Date: Fri, 14 Aug 2020 14:36:40 +0200 Subject: [PATCH] docs: added rbd mirror crd documentation This adds some basic RBDMirror CRD documentation and fixes the types.go comments accordingly. Signed-off-by: Alexander Trost --- Documentation/ceph-rbd-mirror-crd.md | 18 ++++++++++++++++++ pkg/apis/ceph.rook.io/v1/types.go | 4 ++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/Documentation/ceph-rbd-mirror-crd.md b/Documentation/ceph-rbd-mirror-crd.md index 2dd70a20c..2d3842895 100644 --- a/Documentation/ceph-rbd-mirror-crd.md +++ b/Documentation/ceph-rbd-mirror-crd.md @@ -27,3 +27,21 @@ spec: ### Prerequisites This guide assumes you have created a Rook cluster as explained in the main [Quickstart guide](ceph-quickstart.md) + +## Settings + +If any setting is unspecified, a suitable default will be used automatically. + +### RBDMirror metadata + +* `name`: The name that will be used for the Ceph RBD Mirror daemon. +* `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. + +### RBDMirror Settings + +* `count`: The number of rbd mirror instance to run. +* `placement`: The rbd mirror pods can be given standard Kubernetes placement restrictions with `nodeAffinity`, `tolerations`, `podAffinity`, and `podAntiAffinity` similar to placement defined for daemons configured by the [cluster CRD](https://github.com/rook/rook/blob/{{ branchName }}/cluster/examples/kubernetes/ceph/cluster.yaml). +* `annotations`: Key value pair list of annotations to add. +* `labels`: Key value pair list of labels to add. +* `resources`: The resource requirements for the rbd mirror pods. +* `priorityClassName`: The priority class to set on the rbd mirror pods. diff --git a/pkg/apis/ceph.rook.io/v1/types.go b/pkg/apis/ceph.rook.io/v1/types.go index b776cffcb..b28464642 100755 --- a/pkg/apis/ceph.rook.io/v1/types.go +++ b/pkg/apis/ceph.rook.io/v1/types.go @@ -773,9 +773,9 @@ type RBDMirroringSpec struct { // The annotations-related configuration to add/set on each Pod related object. Annotations rookv1.Annotations `json:"annotations,omitempty"` - // The resource requirements for the rgw pods + // The resource requirements for the rbd mirror pods Resources v1.ResourceRequirements `json:"resources"` - // PriorityClassName sets priority classes on the rgw pods + // PriorityClassName sets priority class on the rbd mirror pods PriorityClassName string `json:"priorityClassName,omitempty"` }