Skip to content

Commit

Permalink
docs(api): add clusterresources for owner spec
Browse files Browse the repository at this point in the history
Signed-off-by: Oliver Bähler <[email protected]>
  • Loading branch information
oliverbaehler committed Mar 6, 2024
1 parent f16a26a commit 4349140
Showing 1 changed file with 129 additions and 0 deletions.
129 changes: 129 additions & 0 deletions docs/content/general/crds-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -1489,6 +1489,13 @@ TenantSpec defines the desired state of Tenant.
Name of tenant owner.<br/>
</td>
<td>true</td>
</tr><tr>
<td><b><a href="#tenantspecownersindexclusterresourcesindex">clusterResources</a></b></td>
<td>[]object</td>
<td>
Defines additional cluster-resources for the specific Owner.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>clusterRoles</b></td>
<td>[]string</td>
Expand All @@ -1509,6 +1516,128 @@ TenantSpec defines the desired state of Tenant.
</table>


### Tenant.spec.owners[index].clusterResources[index]





<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>apiGroups</b></td>
<td>[]string</td>
<td>
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against any resource listed will be allowed. '*' represents all resources. Empty string represents v1 api resources.<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>operations</b></td>
<td>[]enum</td>
<td>
Operations which can be executed on the selected resources.<br/>
<br/>
<i>Default</i>: [List]<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>resources</b></td>
<td>[]string</td>
<td>
Resources is a list of resources this rule applies to. '*' represents all resources.<br/>
</td>
<td>true</td>
</tr><tr>
<td><b><a href="#tenantspecownersindexclusterresourcesindexselector">selector</a></b></td>
<td>object</td>
<td>
Select all cluster scoped resources with the given label selector.<br/>
</td>
<td>true</td>
</tr></tbody>
</table>


### Tenant.spec.owners[index].clusterResources[index].selector



Select all cluster scoped resources with the given label selector.

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b><a href="#tenantspecownersindexclusterresourcesindexselectormatchexpressionsindex">matchExpressions</a></b></td>
<td>[]object</td>
<td>
matchExpressions is a list of label selector requirements. The requirements are ANDed.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>matchLabels</b></td>
<td>map[string]string</td>
<td>
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>


### Tenant.spec.owners[index].clusterResources[index].selector.matchExpressions[index]



A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>key</b></td>
<td>string</td>
<td>
key is the label key that the selector applies to.<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>operator</b></td>
<td>string</td>
<td>
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>values</b></td>
<td>[]string</td>
<td>
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>


### Tenant.spec.owners[index].proxySettings[index]


Expand Down

0 comments on commit 4349140

Please sign in to comment.