Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
RoleBinding
Maturity: merged
Version: 0.0
Role bindings links a user|team to a configured role
Property | Type | Required | Default | Description |
---|---|---|---|---|
metadata | object | Yes | metadata contains embedded CommonMetadata and can be extended with custom string fields TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen. | |
spec | object | Yes | ||
status | object | Yes |
Metadata
metadata contains embedded CommonMetadata and can be extended with custom string fields TODO: use CommonMetadata instead of redefining here; currently needs to be defined here without external reference as using the CommonMetadata reference breaks thema codegen.
It extends _kubeObjectMetadata.
Property | Type | Required | Default | Description |
---|---|---|---|---|
createdBy | string | Yes | ||
creationTimestamp | string | Yes | (Inherited from _kubeObjectMetadata) | |
extraFields | object | Yes | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata | |
finalizers | string[] | Yes | (Inherited from _kubeObjectMetadata) | |
labels | map[string]string | Yes | (Inherited from _kubeObjectMetadata) | |
resourceVersion | string | Yes | (Inherited from _kubeObjectMetadata) | |
uid | string | Yes | (Inherited from _kubeObjectMetadata) | |
updateTimestamp | string | Yes | ||
updatedBy | string | Yes | ||
deletionTimestamp | string | No | (Inherited from _kubeObjectMetadata) |
_kubeObjectMetadata
_kubeObjectMetadata is metadata found in a kubernetes object’s metadata field. It is not exhaustive and only includes fields which may be relevant to a kind’s implementation, As it is also intended to be generic enough to function with any API Server.
Property | Type | Required | Default | Description |
---|---|---|---|---|
creationTimestamp | string | Yes | ||
finalizers | string[] | Yes | ||
labels | map[string]string | Yes | ||
resourceVersion | string | Yes | ||
uid | string | Yes | ||
deletionTimestamp | string | No |
ExtraFields
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
Property | Type | Required | Default | Description |
---|
Spec
Property | Type | Required | Default | Description |
---|---|---|---|---|
role | object | Yes | The role we are discussing | |
subject | RoleBindingSubject | Yes |
RoleBindingSubject
Property | Type | Required | Default | Description |
---|---|---|---|---|
kind | string | Yes | Possible values are: Team , User . | |
name | string | Yes | The team/user identifier name |
Role
The role we are discussing
Property | Type | Required | Default | Description |
---|---|---|---|---|
object | Possible types are: BuiltinRoleRef, CustomRoleRef. |
BuiltinRoleRef
Property | Type | Required | Default | Description |
---|---|---|---|---|
kind | string | Yes | Possible values are: BuiltinRole . | |
name | string | Yes | Possible values are: viewer , editor , admin . |
CustomRoleRef
Property | Type | Required | Default | Description |
---|---|---|---|---|
kind | string | Yes | Possible values are: Role . | |
name | string | Yes |
Status
Property | Type | Required | Default | Description |
---|---|---|---|---|
additionalFields | object | No | additionalFields is reserved for future use | |
operatorStates | map[string]status.#OperatorState | No | operatorStates is a map of operator ID to operator state evaluations. Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
AdditionalFields
additionalFields is reserved for future use
Property | Type | Required | Default | Description |
---|
Status.#OperatorState
Property | Type | Required | Default | Description |
---|---|---|---|---|
lastEvaluation | string | Yes | lastEvaluation is the ResourceVersion last evaluated | |
state | string | Yes | state describes the state of the lastEvaluation. It is limited to three possible states for machine evaluation. Possible values are: success , in_progress , failed . | |
descriptiveState | string | No | descriptiveState is an optional more descriptive state field which has no requirements on format | |
details | object | No | details contains any extra information that is operator-specific |
Details
details contains any extra information that is operator-specific
Property | Type | Required | Default | Description |
---|