diff --git a/api/v1alpha1/docs/apiref.adoc b/api/v1alpha1/docs/apiref.adoc index 7c7ea8a7..ffe01899 100644 --- a/api/v1alpha1/docs/apiref.adoc +++ b/api/v1alpha1/docs/apiref.adoc @@ -180,7 +180,7 @@ BannedUserList contains a list of BannedUser | *`kind`* __string__ | `BannedUserList` | | | *`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: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-banneduser[$$BannedUser$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -769,6 +769,7 @@ a new IdP provider client, and contains the user's "original-sub" claim + | | | *`givenName`* __string__ | GivenName contains the value of the 'given_name' claim + | | | *`familyName`* __string__ | FamilyName contains the value of the 'family_name' claim + | | | *`company`* __string__ | Company contains the value of the 'company' claim + | | +| *`accountNumber`* __string__ | AccountNumber contains the value of the 'account_number' claim + | | |=== @@ -819,7 +820,7 @@ IdlerList contains a list of Idlers | *`kind`* __string__ | `IdlerList` | | | *`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: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-idler[$$Idler$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -935,7 +936,7 @@ MasterUserRecordList contains a list of MasterUserRecord | *`kind`* __string__ | `MasterUserRecordList` | | | *`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: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-masteruserrecord[$$MasterUserRecord$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -1063,7 +1064,7 @@ MemberOperatorConfigList contains a list of MemberOperatorConfig | *`kind`* __string__ | `MemberOperatorConfigList` | | | *`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: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-memberoperatorconfig[$$MemberOperatorConfig$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -1208,7 +1209,7 @@ MemberStatusList contains a list of MemberStatus | *`kind`* __string__ | `MemberStatusList` | | | *`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: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-memberstatus[$$MemberStatus$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -1385,7 +1386,7 @@ NSTemplateSetList contains a list of NSTemplateSet | *`kind`* __string__ | `NSTemplateSetList` | | | *`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: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-nstemplateset[$$NSTemplateSet$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -1552,7 +1553,7 @@ NSTemplateTierList contains a list of NSTemplateTier | *`kind`* __string__ | `NSTemplateTierList` | | | *`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: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-nstemplatetier[$$NSTemplateTier$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -1719,7 +1720,7 @@ NotificationList contains a list of Notification | *`kind`* __string__ | `NotificationList` | | | *`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: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-notification[$$Notification$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -1957,7 +1958,7 @@ ProxyPluginList contains a list of ProxyPlugin | *`kind`* __string__ | `ProxyPluginList` | | | *`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-proxyplugin[$$ProxyPlugin$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-proxyplugin[$$ProxyPlugin$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -2379,7 +2380,7 @@ SocialEventList contains a list of SocialEvent | *`kind`* __string__ | `SocialEventList` | | | *`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-socialevent[$$SocialEvent$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-socialevent[$$SocialEvent$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -2512,7 +2513,7 @@ SpaceBindingList contains a list of SpaceBinding | *`kind`* __string__ | `SpaceBindingList` | | | *`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-spacebinding[$$SpaceBinding$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-spacebinding[$$SpaceBinding$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -2562,7 +2563,7 @@ SpaceBindingRequestList contains a list of SpaceBindingRequests | *`kind`* __string__ | `SpaceBindingRequestList` | | | *`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-spacebindingrequest[$$SpaceBindingRequest$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-spacebindingrequest[$$SpaceBindingRequest$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -2694,7 +2695,7 @@ SpaceList contains a list of Space | *`kind`* __string__ | `SpaceList` | | | *`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-space[$$Space$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-space[$$Space$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -2743,13 +2744,11 @@ SpaceProvisionerCapacityThresholds defines the capacity thresholds of the space | Field | Description | Default | Validation | *`maxNumberOfSpaces`* __integer__ | MaxNumberOfSpaces is the maximum number of spaces that can be provisioned to the referenced cluster. + - 0 or undefined value means no limit. + | | Minimum: 0 + | *`maxMemoryUtilizationPercent`* __integer__ | MaxMemoryUtilizationPercent is the maximum memory utilization of the cluster to permit provisioning + new spaces to it. + - 0 or undefined value means no limit. + | | Maximum: 100 + Minimum: 0 + @@ -2801,7 +2800,7 @@ SpaceProvisionerConfigList contains a list of SpaceProvisionerConfig | *`kind`* __string__ | `SpaceProvisionerConfigList` | | | *`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-spaceprovisionerconfig[$$SpaceProvisionerConfig$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-spaceprovisionerconfig[$$SpaceProvisionerConfig$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -2923,7 +2922,7 @@ SpaceRequestList contains a list of SpaceRequests | *`kind`* __string__ | `SpaceRequestList` | | | *`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-spacerequest[$$SpaceRequest$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-spacerequest[$$SpaceRequest$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -2953,7 +2952,6 @@ The target cluster has to match ALL the roles defined in this field in order for | *`disableInheritance`* __boolean__ | DisableInheritance indicates whether or not SpaceBindings from the parent-spaces are + automatically inherited to all sub-spaces in the tree. + - Set to True to disable SpaceBinding inheritance from the parent-spaces. + Default is False. + | | |=== @@ -3015,14 +3013,12 @@ If not set then the tier name will be set automatically + | | | *`parentSpace`* __string__ | ParentSpace holds the name of the context (Space) from which this space was created (requested), + enabling hierarchy relationships between different Spaces. + - Keeping this association brings two main benefits: + 1. SpaceBindings are inherited from the parent Space + 2. Ability to easily monitor quota for the requested sub-spaces + | | | *`disableInheritance`* __boolean__ | DisableInheritance indicates whether or not SpaceBindings from the parent-spaces are + automatically inherited to all sub-spaces in the tree. + - Set to True to disable SpaceBinding inheritance from the parent-spaces. + Default is False. + | | |=== @@ -3098,7 +3094,7 @@ TierTemplateList contains a list of TierTemplate | *`kind`* __string__ | `TierTemplateList` | | | *`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-tiertemplate[$$TierTemplate$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-tiertemplate[$$TierTemplate$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -3147,7 +3143,7 @@ TierTemplateRevisionList contains a list of TierTemplateRevisions | *`kind`* __string__ | `TierTemplateRevisionList` | | | *`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-tiertemplaterevision[$$TierTemplateRevision$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-tiertemplaterevision[$$TierTemplateRevision$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -3199,12 +3195,10 @@ TierTemplateSpec defines the desired state of TierTemplate Note: this field will be removed in favor of the new TemplateObjects below. + | | | *`templateObjects`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#rawextension-runtime-pkg[$$RawExtension$$] array__ | TemplateObjects contains list of Unstructured Objects that can be parsed at runtime and will be applied as part of the tier provisioning. + - NOTE: when specifying variables as part of the objects list , those concatenated as part of other strings do not need to be wrapped inside quotes, + while those that are not part of other strings do need to be wrapped in single quotes. This is required otherwise the yaml parser will error while trying to parse those resources containing variables. + eg: https://docs.google.com/document/d/1x5SoBT80df9fmVsaDgAE6DE7hE6lzmNIK087JUmgaJs/edit#heading=h.2iuytpfnmul5 + - The template parameters values will be defined in the NSTemplateTier CRD. + | | |=== @@ -3304,7 +3298,7 @@ ToolchainClusterList contains a list of ToolchainCluster | *`kind`* __string__ | `ToolchainClusterList` | | | *`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-toolchaincluster[$$ToolchainCluster$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-toolchaincluster[$$ToolchainCluster$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -3402,7 +3396,7 @@ ToolchainConfigList contains a list of ToolchainConfig | *`kind`* __string__ | `ToolchainConfigList` | | | *`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-toolchainconfig[$$ToolchainConfig$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-toolchainconfig[$$ToolchainConfig$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -3545,7 +3539,7 @@ ToolchainStatusList contains a list of ToolchainStatus | *`kind`* __string__ | `ToolchainStatusList` | | | *`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-toolchainstatus[$$ToolchainStatus$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-toolchainstatus[$$ToolchainStatus$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -3603,7 +3597,6 @@ a phone number when receiving an SMS message), for example "RED HAT", with an ar code values for which the Sender ID value will be set via the Twilio API when sending a verification code to a user in any of the country codes specified. - Since some countries are starting to block long form phone numbers (i.e. SMS messages from international phone numbers) the Sender ID may be an acceptable alternative to requiring the verification message to be sent from a local phone number. @@ -3688,7 +3681,7 @@ UserAccountList contains a list of UserAccount | *`kind`* __string__ | `UserAccountList` | | | *`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-useraccount[$$UserAccount$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-useraccount[$$UserAccount$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -3808,7 +3801,7 @@ UserSignupList contains a list of UserSignup | *`kind`* __string__ | `UserSignupList` | | | *`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-usersignup[$$UserSignup$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-usersignup[$$UserSignup$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -3928,7 +3921,7 @@ UserTierList contains a list of UserTier | *`kind`* __string__ | `UserTierList` | | | *`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-usertier[$$UserTier$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-usertier[$$UserTier$$] array__ | | | XPreserveUnknownFields: \{} + |=== @@ -4070,7 +4063,7 @@ WorkspaceList contains a list of Workspaces | *`kind`* __string__ | `WorkspaceList` | | | *`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-workspace[$$Workspace$$] array__ | | | XPreserveUnknownFields: {} + +| *`items`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-workspace[$$Workspace$$] array__ | | | XPreserveUnknownFields: \{} + |=== diff --git a/api/v1alpha1/usersignup_types.go b/api/v1alpha1/usersignup_types.go index 6d1c1d42..ed5d06e4 100644 --- a/api/v1alpha1/usersignup_types.go +++ b/api/v1alpha1/usersignup_types.go @@ -206,6 +206,10 @@ type IdentityClaimsEmbedded struct { // Company contains the value of the 'company' claim // +optional Company string `json:"company,omitempty"` + + // AccountNumber contains the value of the 'account_number' claim + // +optional + AccountNumber string `json:"accountNumber,omitempty"` } // +k8s:openapi-gen=true diff --git a/api/v1alpha1/zz_generated.openapi.go b/api/v1alpha1/zz_generated.openapi.go index 3d980911..33cdfc8f 100644 --- a/api/v1alpha1/zz_generated.openapi.go +++ b/api/v1alpha1/zz_generated.openapi.go @@ -1031,6 +1031,13 @@ func schema_codeready_toolchain_api_api_v1alpha1_IdentityClaimsEmbedded(ref comm Format: "", }, }, + "accountNumber": { + SchemaProps: spec.SchemaProps{ + Description: "AccountNumber contains the value of the 'account_number' claim", + Type: []string{"string"}, + Format: "", + }, + }, }, Required: []string{"sub", "email", "preferredUsername"}, },