WIP: update multi-tenacy docs #1
Conversation
docs/book/src/topics/multitenancy.md
Outdated
| @@ -6,6 +6,8 @@ For details, see the [multi-tenancy proposal](https://github.com/kubernetes-sigs | |||
|
|
|||
| For multi-tenancy support, a reference field (`identityRef`) is added to `AWSCluster`, which describes the identity to be used when reconciling the cluster. | |||
|
|
|||
| In other words, `identityRef`is the function that dictates _which_ aws account cluster-api will deploy into. | |||
There was a problem hiding this comment.
I believe this might be redundant, the identityRef has nothing to do with the account per se, and the paragraph at line 24 clarify what is this about.
There was a problem hiding this comment.
I understand the point you're making. I think while it may be redundant, it states an important part of the multi-tenancy configuration. Which is how an operator dictates which cluster they can deploy into.
I'd like to leave something high level explaining this at the top of the doc, do you have any suggestions for wording?
There was a problem hiding this comment.
You could say something like:
identityRefreference the credentials or the role that the capa-controller will use to manage the relative cluster
But then we are, sort of, repeating what's in the previous paragraph
|
Aside from the comment above, LGTM |
davidblum
force-pushed
the
multi-tenancy-docs
branch
from
6cf67b8 to
64d6f82
Compare
typo CR feedback
davidblum
force-pushed
the
multi-tenancy-docs
branch
from
1b05e5c to
4048a8d
Compare
This PR updates the
multi-tenancysection to provide:/kind documentation
What this PR does / why we need it:
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #
Special notes for your reviewer:
Checklist:
Release note: