Update documentation for Operator #219
Conversation
There was a problem hiding this comment.
A few areas I think we can tighten up. Eventually I need to migrate this content, but until then this looks like a good start.
Main point is making sure we're using examples consistently. SO if we have a quickstart, then examples for modifying/expanding should assume that quickstart as the 'base'.
|
|
||
| ## Getting Started | ||
| ## Steps to Run | ||
|
|
There was a problem hiding this comment.
Should state explicitly up here what this command does:
The following command creates a distributed MinIO deployment with 4 MinIO ``servers``. Each MinIO server consists of four ``volumes`` with a ``capacity`` of 1Ti each.
You can follow up noting something like
To modify the number of servers, volumes, or capacity per volume, change the values for ``servers``, ``volumes``, and
``capacity`` respectively.
- MinIO Erasure Coding relies on at least 4 drives across all MinIO instances in the distributed system. If the value of
``servers X volumes`` is less than ``4``, MinIO cannot enable erasure coding on the deployment.
- The MinIO operator cannot expand standalone deployments (``servers 1``) to distributed deployments.
There was a problem hiding this comment.
I forgot to ask this during the last engineering meeting - I remember vaguely we had some docs noting that we cannot expand from standalone to distributed. Maybe that's in my imagination though - I don't see it anymore (perhaps its no longer a concern). If so can scratch the last bullet.
| kubectl minio operator create | ||
| kubectl create ns tenant1-ns | ||
| kubectl create secret generic minio-secret --from-literal=accesskey=minio --from-literal=secretkey=minio123 --namespace tenant1-ns | ||
| kubectl minio tenant create --name tenant1 --secret minio-secret --servers 4 --volumes 4 --capacity 1Ti --namespace tenant1-ns | ||
| ``` |
There was a problem hiding this comment.
Should add connection information.
"To connect to the created cluster, add the cluster to your mc configuration and perform operations on it:
mc alias set tenant1-ns https://<service hostname>:9000 minio minio123
mc admin info
There was a problem hiding this comment.
I'm assuming we auto-create the service for them - if we can provide guidance on what the resulting URL will be, we should include that to make this easier.
There was a problem hiding this comment.
I'll leave this as a nit, but I'd still recommend we provide guidance on how to connect (if at all possible).
kannappanr
requested review from
donatello,
kerneltime,
krishnasrinivas and
wlan0
done |
Depends on #188