diff --git a/README.adoc b/README.adoc index f7dec8b9..78d6e2ff 100644 --- a/README.adoc +++ b/README.adoc @@ -8,8 +8,8 @@ For the API reference docs go xref:api/v1alpha1/docs/apiref.adoc[here] == Building Requires: -* Go version 1.18.x (1.18.8 or higher) - download for your development environment https://golang.org/dl/[here]. -* Operator SDK v1.23.0 - download for your development environment https://v1-23-x.sdk.operatorframework.io/docs/installation/#install-from-github-release[here] +* Go version 1.20.x (1.20.11 or higher) - download for your development environment https://golang.org/dl/[here]. +* Operator SDK v1.25.0 - download for your development environment https://v1-25-x.sdk.operatorframework.io/docs/installation/#install-from-github-release[here] CodeReady ToolChain API is built using https://github.com/golang/go/wiki/Modules[Go modules]. diff --git a/api/v1alpha1/docs/apiref.adoc b/api/v1alpha1/docs/apiref.adoc index 9912b345..a0f295dd 100644 --- a/api/v1alpha1/docs/apiref.adoc +++ b/api/v1alpha1/docs/apiref.adoc @@ -156,7 +156,7 @@ BannedUser is used to maintain a list of banned e-mail addresses | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `BannedUser` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`spec`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-banneduserspec[$$BannedUserSpec$$]__ | | | |=== @@ -178,7 +178,7 @@ BannedUserList contains a list of BannedUser | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `BannedUserList` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-banneduser[$$BannedUser$$] array__ | | | XPreserveUnknownFields: {} + @@ -425,11 +425,11 @@ Supported condition types: ConditionReady + | | |=== | Field | Description | Default | Validation | *`type`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-conditiontype[$$ConditionType$$]__ | Type of condition + | | -| *`status`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#conditionstatus-v1-core[$$ConditionStatus$$]__ | Status of the condition, one of True, False, Unknown. + | | -| *`lastTransitionTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#time-v1-meta[$$Time$$]__ | Last time the condition transit from one status to another. + | | +| *`status`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#conditionstatus-v1-core[$$ConditionStatus$$]__ | Status of the condition, one of True, False, Unknown. + | | +| *`lastTransitionTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta[$$Time$$]__ | Last time the condition transit from one status to another. + | | | *`reason`* __string__ | (brief) reason for the condition's last transition. + | | | *`message`* __string__ | Human readable message indicating details about last transition. + | | -| *`lastUpdatedTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#time-v1-meta[$$Time$$]__ | Last time the condition was updated + | | +| *`lastUpdatedTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta[$$Time$$]__ | Last time the condition was updated + | | |=== @@ -771,7 +771,7 @@ For example an Idler with "foo" name will be managing pods in namespace "foo". | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `Idler` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`spec`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-idlerspec[$$IdlerSpec$$]__ | | | | *`status`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-idlerstatus[$$IdlerStatus$$]__ | | | @@ -794,7 +794,7 @@ IdlerList contains a list of Idlers | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `IdlerList` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-idler[$$Idler$$] array__ | | | XPreserveUnknownFields: {} + @@ -888,7 +888,7 @@ MasterUserRecord keeps all information about user, user accounts and namespaces | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `MasterUserRecord` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`spec`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-masteruserrecordspec[$$MasterUserRecordSpec$$]__ | | | | *`status`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-masteruserrecordstatus[$$MasterUserRecordStatus$$]__ | | | @@ -911,7 +911,7 @@ MasterUserRecordList contains a list of MasterUserRecord | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `MasterUserRecordList` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-masteruserrecord[$$MasterUserRecord$$] array__ | | | XPreserveUnknownFields: {} + @@ -968,7 +968,7 @@ MasterUserRecordStatus defines the observed state of MasterUserRecord Supported condition types: + Provisioning, UserAccountNotReady and Ready + | | | *`userAccounts`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-useraccountstatusembedded[$$UserAccountStatusEmbedded$$] array__ | The status of user accounts in the member clusters which belong to this MasterUserRecord + | | -| *`provisionedTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#time-v1-meta[$$Time$$]__ | The timestamp when the user was provisioned + | | +| *`provisionedTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta[$$Time$$]__ | The timestamp when the user was provisioned + | | |=== @@ -1016,7 +1016,7 @@ MemberOperatorConfig keeps all configuration parameters needed in member operato | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `MemberOperatorConfig` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`spec`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-memberoperatorconfigspec[$$MemberOperatorConfigSpec$$]__ | | | | *`status`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-memberoperatorconfigstatus[$$MemberOperatorConfigStatus$$]__ | | | @@ -1039,7 +1039,7 @@ MemberOperatorConfigList contains a list of MemberOperatorConfig | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `MemberOperatorConfigList` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-memberoperatorconfig[$$MemberOperatorConfig$$] array__ | | | XPreserveUnknownFields: {} + @@ -1139,7 +1139,7 @@ MemberStatus is used to track toolchain member status | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `MemberStatus` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`spec`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-memberstatusspec[$$MemberStatusSpec$$]__ | | | | *`status`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-memberstatusstatus[$$MemberStatusStatus$$]__ | | | @@ -1184,7 +1184,7 @@ MemberStatusList contains a list of MemberStatus | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `MemberStatusList` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-memberstatus[$$MemberStatus$$] array__ | | | XPreserveUnknownFields: {} + @@ -1316,7 +1316,7 @@ NSTemplateSet defines user environment via templates that are used for namespace | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `NSTemplateSet` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`spec`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-nstemplatesetspec[$$NSTemplateSetSpec$$]__ | | | | *`status`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-nstemplatesetstatus[$$NSTemplateSetStatus$$]__ | | | @@ -1361,7 +1361,7 @@ NSTemplateSetList contains a list of NSTemplateSet | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `NSTemplateSetList` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-nstemplateset[$$NSTemplateSet$$] array__ | | | XPreserveUnknownFields: {} + @@ -1484,7 +1484,7 @@ NSTemplateTier configures user environment via templates used for namespaces the | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `NSTemplateTier` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`spec`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-nstemplatetierspec[$$NSTemplateTierSpec$$]__ | | | | *`status`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-nstemplatetierstatus[$$NSTemplateTierStatus$$]__ | | | @@ -1529,9 +1529,9 @@ NSTemplateTierHistory a track record of an update [cols="20a,50a,15a,15a", options="header"] |=== | Field | Description | Default | Validation -| *`startTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#time-v1-meta[$$Time$$]__ | StartTime is the time when the NSTemplateTier was updated + | | +| *`startTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta[$$Time$$]__ | StartTime is the time when the NSTemplateTier was updated + | | | *`hash`* __string__ | Hash the hash matching on the templateRefs in the resource spec + | | -| *`completionTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#time-v1-meta[$$Time$$]__ | CompletionTime is the time when the last MasterUserRecord was updated + | | +| *`completionTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta[$$Time$$]__ | CompletionTime is the time when the last MasterUserRecord was updated + | | | *`failures`* __integer__ | Failures is the number of MasterUserRecords which failed to be updated + | | | *`failedAccounts`* __string array__ | FailedAccounts + | | |=== @@ -1553,7 +1553,7 @@ NSTemplateTierList contains a list of NSTemplateTier | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `NSTemplateTierList` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-nstemplatetier[$$NSTemplateTier$$] array__ | | | XPreserveUnknownFields: {} + @@ -1698,7 +1698,7 @@ Notification registers a notification in the CodeReady Toolchain | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `Notification` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`spec`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-notificationspec[$$NotificationSpec$$]__ | | | | *`status`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-notificationstatus[$$NotificationStatus$$]__ | | | @@ -1721,7 +1721,7 @@ NotificationList contains a list of Notification | Field | Description | Default | Validation | *`apiVersion`* __string__ | `toolchain.dev.openshift.com/v1alpha1` | | | *`kind`* __string__ | `NotificationList` | | -| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. +| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | | | *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-notification[$$Notification$$] array__ | | | XPreserveUnknownFields: {} + @@ -1900,7 +1900,7 @@ The value replaces all occurrences of the Parameter {{.NAME}}. + | | |=== | Field | Description | Default | Validation | *`name`* __string__ | | | -| *`startTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.2/#time-v1-meta[$$Time$$]__ | | | +| *`startTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta[$$Time$$]__ | | | |=== @@ -1955,7 +1955,7 @@ https:///plugins//workspaces/