Skip to content

Commit

Permalink
Clarification about the metadata (#664)
Browse files Browse the repository at this point in the history
  • Loading branch information
dvaldivia authored Jun 3, 2021
1 parent 73fddaa commit afec3ea
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/operator-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ MinIO Operator creates native Kubernetes resources within the cluster. If the Te
| Field | Description |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| kind | This defines the resource type to be created. MinIO Operator CRD defines the `kind` for MinIO server as `Tenant`. |
| metadata | This field allows a way to assign metadata to a Tenant. Internally `metadata` is a struct type as [explained here](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#ObjectMeta). |
| scheduler | Set custom scheduler for pods created by MinIO Operator. |
| spec.metadata | Define the object metadata to be passed to all the members pods of this Tenant. This allows adding annotations and labels. For example,you can add Prometheus annotations here. Internally `metadata` is a struct type as [explained here](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#ObjectMeta). |
| metadata | This field allows a way to assign metadata to a Tenant. Labels and Annotations will be passed to all the member pods of this Tenant. For example, you can add Prometheus annotations here. Internally `metadata` is a struct type as [explained here](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#ObjectMeta). |
| scheduler | Set custom scheduler for pods created by MinIO Operator. | |
| spec.image | Set the container registry and image tag for MinIO server to be used in the Tenant. |
| spec.pools | Set the number of servers per MinIO Pool. Add a new Pool field to expand the MinIO cluster. Read more on [MinIO pools here](https://github.com/minio/minio/blob/master/docs/distributed/DESIGN.md). |
| spec.volumesPerServer | Set the number of volume mounts per MinIO node. For example if you set `spec.pools[0].Servers = 4`, `spec.pools[1].Servers = 8` and `spec.volumesPerServer = 4`, then you'll have total 12 MinIO Pods, with 4 volume mounts on each Pod. Note that `volumesPerServer` is static per cluster, expanding a cluster will add new nodes. |
Expand Down Expand Up @@ -51,4 +50,4 @@ MinIO Operator creates native Kubernetes resources within the cluster. If the Te
| spec.kes.labels | If provided, use these labels for KES Object Meta labels. |
| spec.kes.nodeSelector | If provided, use these nodeSelector for KES Object Meta nodeSelector. |

A complete list of values is available [here](crd.adoc) in the API reference.
A complete list of values is available [here](crd.adoc) in the API reference.

0 comments on commit afec3ea

Please sign in to comment.