docs icon indicating copy to clipboard operation
docs copied to clipboard

Provide example on how to create users in tenant chart

Open aqeelat opened this issue 1 year ago • 8 comments

The docs say that it is a list of secrets. It does not say that the list should be of objects that contain a name.

I had to go through the crd schema to understand why my tenant was not being created.

Incorrect:

tenant:
  users:
    - my-user

Correct:

tenant:
  users:
    - name: my-user

aqeelat avatar Jul 16 '24 09:07 aqeelat

@aqeelat Which docs are you refering too?

ramondeklein avatar Jul 16 '24 09:07 ramondeklein

@ramondeklein https://min.io/docs/minio/kubernetes/upstream/operations/install-deploy-manage/deploy-minio-tenant.html#minio-k8s-deploy-minio-tenant

aqeelat avatar Oct 31 '24 10:10 aqeelat

I can't find any reference on creating users on that page.

ramondeklein avatar Oct 31 '24 11:10 ramondeklein

Sorry I meant https://min.io/docs/minio/kubernetes/upstream/reference/tenant-chart-values.html#minio-tenant-chart-values

Regardless, its not very straightforward to find

aqeelat avatar Nov 04 '24 12:11 aqeelat

I think the reporter of this issue has a valid point. We should provide an example here.

ramondeklein avatar Nov 04 '24 14:11 ramondeklein

https://github.com/minio/operator/blob/master/helm/tenant/values.yaml

We generate that page using the values in the actual values.yaml, so to update this line with more details.

Looking at the chart , that all boils down to the crd where we accept a LocalObjectReference .

We could try to do a pass through the CRD and back that into the values.yaml for those areas where we look for some sort of K8s-standard object. Might take us a bit to schedule this, but we will try to get to it as we have spare cycles.

ravindk89 avatar Nov 04 '24 16:11 ravindk89

We can't update that value, because that would create a user by default and we don't want to do that.

ramondeklein avatar Nov 04 '24 16:11 ramondeklein

@ramondeklein we can just add to the commented line above it, I should have been more specific.

We use an autoyaml plugin that just takes whatever is in that comment block and pops it into the RST. No change to the actual value is required.

ravindk89 avatar Nov 04 '24 17:11 ravindk89

Whatever you do, the documentation is unusable in its current state regarding this particular (yet "slightly" important :wink:) item, because you are unable to understand how users are created only by reading it. I face the exact same problem just now, hence the google search that brought me here.

personal comment: I am quite surprised that such a basic thing is not documented ... maybe I understand the "need" for a community chart now 😬

Update: Removed remark showing my inability to read 😬

flypenguin avatar Jul 08 '25 13:07 flypenguin

https://github.com/minio/operator/pull/2470 should wind up addressing this. After that PR is merged, then at the next build of the docs site, the tenant helm chart will update to reflect the expanded details.

Note though that docs are moving, and the eventually updated page will be at https://docs.min.io/community/minio-object-store/reference/tenant-chart-values.html.

djwfyi avatar Jul 10 '25 13:07 djwfyi