diff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml index 65c64f73..389083a0 100755 --- a/apis/v1alpha1/ack-generate-metadata.yaml +++ b/apis/v1alpha1/ack-generate-metadata.yaml @@ -1,13 +1,13 @@ ack_generate_info: - build_date: "2021-11-04T00:41:44Z" + build_date: "2021-11-04T01:39:36Z" build_hash: 4b30ff5578e2f570d1c5b1741f3098be0d78e246 go_version: go1.14.15 version: v0.15.1 -api_directory_checksum: 139bda1b5017f26ea2f7668213a25f89a0160811 +api_directory_checksum: 29b892915da3900404bebadaca0cfe6336dfd060 api_version: v1alpha1 aws_sdk_go_version: v1.38.11 generator_config_info: - file_checksum: 5f4a348b91348bdbe09172fc6b3c52357dd7a381 + file_checksum: a9ce25d6cb1988f84092cad1da9ae25b416c2169 original_file_name: generator.yaml last_modification: reason: API generation diff --git a/apis/v1alpha1/app.go b/apis/v1alpha1/app.go new file mode 100644 index 00000000..5195422e --- /dev/null +++ b/apis/v1alpha1/app.go @@ -0,0 +1,85 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package v1alpha1 + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +) + +// AppSpec defines the desired state of App. +type AppSpec struct { + // The name of the app. + // +kubebuilder:validation:Required + AppName *string `json:"appName"` + // The type of app. Supported apps are JupyterServer and KernelGateway. TensorBoard + // is not supported. + // +kubebuilder:validation:Required + AppType *string `json:"appType"` + // The domain ID. + // +kubebuilder:validation:Required + DomainID *string `json:"domainID"` + // The instance type and the Amazon Resource Name (ARN) of the SageMaker image + // created on the instance. + ResourceSpec *ResourceSpec `json:"resourceSpec,omitempty"` + // Each tag consists of a key and an optional value. Tag keys must be unique + // per resource. + Tags []*Tag `json:"tags,omitempty"` + // The user profile name. + // +kubebuilder:validation:Required + UserProfileName *string `json:"userProfileName"` +} + +// AppStatus defines the observed state of App +type AppStatus struct { + // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member + // that is used to contain resource sync state, account ownership, + // constructed ARN for the resource + // +kubebuilder:validation:Optional + ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` + // All CRS managed by ACK have a common `Status.Conditions` member that + // contains a collection of `ackv1alpha1.Condition` objects that describe + // the various terminal states of the CR and its backend AWS service API + // resource + // +kubebuilder:validation:Optional + Conditions []*ackv1alpha1.Condition `json:"conditions"` + // The status. + // +kubebuilder:validation:Optional + Status *string `json:"status,omitempty"` +} + +// App is the Schema for the Apps API +// +kubebuilder:object:root=true +// +kubebuilder:subresource:status +// +kubebuilder:printcolumn:name="STATUS",type=string,priority=0,JSONPath=`.status.status` +type App struct { + metav1.TypeMeta `json:",inline"` + metav1.ObjectMeta `json:"metadata,omitempty"` + Spec AppSpec `json:"spec,omitempty"` + Status AppStatus `json:"status,omitempty"` +} + +// AppList contains a list of App +// +kubebuilder:object:root=true +type AppList struct { + metav1.TypeMeta `json:",inline"` + metav1.ListMeta `json:"metadata,omitempty"` + Items []App `json:"items"` +} + +func init() { + SchemeBuilder.Register(&App{}, &AppList{}) +} diff --git a/apis/v1alpha1/enums.go b/apis/v1alpha1/enums.go index 7a54798c..b6b2360d 100644 --- a/apis/v1alpha1/enums.go +++ b/apis/v1alpha1/enums.go @@ -108,14 +108,14 @@ const ( AppSortKey_CreationTime AppSortKey = "CreationTime" ) -type AppStatus string +type AppStatus_SDK string const ( - AppStatus_Deleted AppStatus = "Deleted" - AppStatus_Deleting AppStatus = "Deleting" - AppStatus_Failed AppStatus = "Failed" - AppStatus_InService AppStatus = "InService" - AppStatus_Pending AppStatus = "Pending" + AppStatus_SDK_Deleted AppStatus_SDK = "Deleted" + AppStatus_SDK_Deleting AppStatus_SDK = "Deleting" + AppStatus_SDK_Failed AppStatus_SDK = "Failed" + AppStatus_SDK_InService AppStatus_SDK = "InService" + AppStatus_SDK_Pending AppStatus_SDK = "Pending" ) type AppType string diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml index 32509128..8f243104 100644 --- a/apis/v1alpha1/generator.yaml +++ b/apis/v1alpha1/generator.yaml @@ -786,10 +786,41 @@ resources: Tags: compare: is_ignored: true + App: + exceptions: + errors: + 404: + code: ResourceNotFound + terminal_codes: + - ResourceNotFound + - InvalidParameterCombination + - InvalidParameterValue + - MissingParameter + hooks: + sdk_read_one_post_set_output: + code: rm.customDescribeAppSetOutput(ko) + dk_delete_pre_build_request: + template_path: app/sdk_delete_pre_build_request.go.tpl + sdk_delete_post_request: + template_path: common/sdk_delete_post_request.go.tpl + fields: + Status: + is_read_only: true + print: + name: STATUS + from: + operation: DescribeApp + path: Status + ResourceSpec: + late_initialize: + min_backoff_seconds: 5 + Tags: + compare: + is_ignored: true ignore: resource_names: - Algorithm - - App + # - App - AutoMLJob - Action - AppImageConfig diff --git a/apis/v1alpha1/types.go b/apis/v1alpha1/types.go index a79876a9..a0931edb 100644 --- a/apis/v1alpha1/types.go +++ b/apis/v1alpha1/types.go @@ -95,8 +95,11 @@ type AlgorithmValidationSpecification struct { // Details about an Amazon SageMaker app. type AppDetails struct { + AppName *string `json:"appName,omitempty"` + AppType *string `json:"appType,omitempty"` CreationTime *metav1.Time `json:"creationTime,omitempty"` DomainID *string `json:"domainID,omitempty"` + Status *string `json:"status,omitempty"` UserProfileName *string `json:"userProfileName,omitempty"` } diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go index c6814cd8..079d0c7f 100644 --- a/apis/v1alpha1/zz_generated.deepcopy.go +++ b/apis/v1alpha1/zz_generated.deepcopy.go @@ -242,9 +242,46 @@ func (in *AlgorithmValidationSpecification) DeepCopy() *AlgorithmValidationSpeci return out } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *App) DeepCopyInto(out *App) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ObjectMeta.DeepCopyInto(&out.ObjectMeta) + in.Spec.DeepCopyInto(&out.Spec) + in.Status.DeepCopyInto(&out.Status) +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new App. +func (in *App) DeepCopy() *App { + if in == nil { + return nil + } + out := new(App) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *App) DeepCopyObject() runtime.Object { + if c := in.DeepCopy(); c != nil { + return c + } + return nil +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *AppDetails) DeepCopyInto(out *AppDetails) { *out = *in + if in.AppName != nil { + in, out := &in.AppName, &out.AppName + *out = new(string) + **out = **in + } + if in.AppType != nil { + in, out := &in.AppType, &out.AppType + *out = new(string) + **out = **in + } if in.CreationTime != nil { in, out := &in.CreationTime, &out.CreationTime *out = (*in).DeepCopy() @@ -254,6 +291,11 @@ func (in *AppDetails) DeepCopyInto(out *AppDetails) { *out = new(string) **out = **in } + if in.Status != nil { + in, out := &in.Status, &out.Status + *out = new(string) + **out = **in + } if in.UserProfileName != nil { in, out := &in.UserProfileName, &out.UserProfileName *out = new(string) @@ -299,6 +341,89 @@ func (in *AppImageConfigDetails) DeepCopy() *AppImageConfigDetails { return out } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *AppList) DeepCopyInto(out *AppList) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ListMeta.DeepCopyInto(&out.ListMeta) + if in.Items != nil { + in, out := &in.Items, &out.Items + *out = make([]App, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppList. +func (in *AppList) DeepCopy() *AppList { + if in == nil { + return nil + } + out := new(AppList) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *AppList) DeepCopyObject() runtime.Object { + if c := in.DeepCopy(); c != nil { + return c + } + return nil +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *AppSpec) DeepCopyInto(out *AppSpec) { + *out = *in + if in.AppName != nil { + in, out := &in.AppName, &out.AppName + *out = new(string) + **out = **in + } + if in.AppType != nil { + in, out := &in.AppType, &out.AppType + *out = new(string) + **out = **in + } + if in.DomainID != nil { + in, out := &in.DomainID, &out.DomainID + *out = new(string) + **out = **in + } + if in.ResourceSpec != nil { + in, out := &in.ResourceSpec, &out.ResourceSpec + *out = new(ResourceSpec) + (*in).DeepCopyInto(*out) + } + if in.Tags != nil { + in, out := &in.Tags, &out.Tags + *out = make([]*Tag, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(Tag) + (*in).DeepCopyInto(*out) + } + } + } + if in.UserProfileName != nil { + in, out := &in.UserProfileName, &out.UserProfileName + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppSpec. +func (in *AppSpec) DeepCopy() *AppSpec { + if in == nil { + return nil + } + out := new(AppSpec) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *AppSpecification) DeepCopyInto(out *AppSpecification) { *out = *in @@ -341,6 +466,42 @@ func (in *AppSpecification) DeepCopy() *AppSpecification { return out } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *AppStatus) DeepCopyInto(out *AppStatus) { + *out = *in + if in.ACKResourceMetadata != nil { + in, out := &in.ACKResourceMetadata, &out.ACKResourceMetadata + *out = new(corev1alpha1.ResourceMetadata) + (*in).DeepCopyInto(*out) + } + if in.Conditions != nil { + in, out := &in.Conditions, &out.Conditions + *out = make([]*corev1alpha1.Condition, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(corev1alpha1.Condition) + (*in).DeepCopyInto(*out) + } + } + } + if in.Status != nil { + in, out := &in.Status, &out.Status + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppStatus. +func (in *AppStatus) DeepCopy() *AppStatus { + if in == nil { + return nil + } + out := new(AppStatus) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *ArtifactSourceType) DeepCopyInto(out *ArtifactSourceType) { *out = *in diff --git a/cmd/controller/main.go b/cmd/controller/main.go index d3859c28..1cf0ad23 100644 --- a/cmd/controller/main.go +++ b/cmd/controller/main.go @@ -33,6 +33,7 @@ import ( svctypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1" svcresource "github.com/aws-controllers-k8s/sagemaker-controller/pkg/resource" + _ "github.com/aws-controllers-k8s/sagemaker-controller/pkg/resource/app" _ "github.com/aws-controllers-k8s/sagemaker-controller/pkg/resource/data_quality_job_definition" _ "github.com/aws-controllers-k8s/sagemaker-controller/pkg/resource/domain" _ "github.com/aws-controllers-k8s/sagemaker-controller/pkg/resource/endpoint" diff --git a/config/crd/bases/sagemaker.services.k8s.aws_apps.yaml b/config/crd/bases/sagemaker.services.k8s.aws_apps.yaml new file mode 100644 index 00000000..5086e8a4 --- /dev/null +++ b/config/crd/bases/sagemaker.services.k8s.aws_apps.yaml @@ -0,0 +1,158 @@ + +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.7.0 + creationTimestamp: null + name: apps.sagemaker.services.k8s.aws +spec: + group: sagemaker.services.k8s.aws + names: + kind: App + listKind: AppList + plural: apps + singular: app + scope: Namespaced + versions: + - additionalPrinterColumns: + - jsonPath: .status.status + name: STATUS + type: string + name: v1alpha1 + schema: + openAPIV3Schema: + description: App is the Schema for the Apps API + properties: + apiVersion: + description: 'APIVersion defines the versioned schema of this representation + of an object. Servers should convert recognized schemas to the latest + internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + type: string + kind: + description: 'Kind is a string value representing the REST resource this + object represents. Servers may infer this from the endpoint the client + submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + type: string + metadata: + type: object + spec: + description: AppSpec defines the desired state of App. + properties: + appName: + description: The name of the app. + type: string + appType: + description: The type of app. Supported apps are JupyterServer and + KernelGateway. TensorBoard is not supported. + type: string + domainID: + description: The domain ID. + type: string + resourceSpec: + description: The instance type and the Amazon Resource Name (ARN) + of the SageMaker image created on the instance. + properties: + instanceType: + type: string + sageMakerImageARN: + type: string + sageMakerImageVersionARN: + type: string + type: object + tags: + description: Each tag consists of a key and an optional value. Tag + keys must be unique per resource. + items: + description: Describes a tag. + properties: + key: + type: string + value: + type: string + type: object + type: array + userProfileName: + description: The user profile name. + type: string + required: + - appName + - appType + - domainID + - userProfileName + type: object + status: + description: AppStatus defines the observed state of App + properties: + ackResourceMetadata: + description: All CRs managed by ACK have a common `Status.ACKResourceMetadata` + member that is used to contain resource sync state, account ownership, + constructed ARN for the resource + properties: + arn: + description: 'ARN is the Amazon Resource Name for the resource. + This is a globally-unique identifier and is set only by the + ACK service controller once the controller has orchestrated + the creation of the resource OR when it has verified that an + "adopted" resource (a resource where the ARN annotation was + set by the Kubernetes user on the CR) exists and matches the + supplied CR''s Spec field values. TODO(vijat@): Find a better + strategy for resources that do not have ARN in CreateOutputResponse + https://github.com/aws/aws-controllers-k8s/issues/270' + type: string + ownerAccountID: + description: OwnerAccountID is the AWS Account ID of the account + that owns the backend AWS service API resource. + type: string + required: + - ownerAccountID + type: object + conditions: + description: All CRS managed by ACK have a common `Status.Conditions` + member that contains a collection of `ackv1alpha1.Condition` objects + that describe the various terminal states of the CR and its backend + AWS service API resource + items: + description: Condition is the common struct used by all CRDs managed + by ACK service controllers to indicate terminal states of the + CR and its backend AWS service API resource + properties: + lastTransitionTime: + description: Last time the condition transitioned from one status + to another. + format: date-time + type: string + message: + description: A human readable message indicating details about + the transition. + type: string + reason: + description: The reason for the condition's last transition. + type: string + status: + description: Status of the condition, one of True, False, Unknown. + type: string + type: + description: Type is the type of the Condition + type: string + required: + - status + - type + type: object + type: array + status: + description: The status. + type: string + type: object + type: object + served: true + storage: true + subresources: + status: {} +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml index cfc6f678..a556d2d1 100644 --- a/config/crd/kustomization.yaml +++ b/config/crd/kustomization.yaml @@ -3,6 +3,7 @@ kind: Kustomization bases: - common resources: + - bases/sagemaker.services.k8s.aws_apps.yaml - bases/sagemaker.services.k8s.aws_dataqualityjobdefinitions.yaml - bases/sagemaker.services.k8s.aws_domains.yaml - bases/sagemaker.services.k8s.aws_endpoints.yaml diff --git a/config/rbac/cluster-role-controller.yaml b/config/rbac/cluster-role-controller.yaml index ca916a85..1f3a47f5 100644 --- a/config/rbac/cluster-role-controller.yaml +++ b/config/rbac/cluster-role-controller.yaml @@ -22,6 +22,26 @@ rules: - get - list - watch +- apiGroups: + - sagemaker.services.k8s.aws + resources: + - apps + verbs: + - create + - delete + - get + - list + - patch + - update + - watch +- apiGroups: + - sagemaker.services.k8s.aws + resources: + - apps/status + verbs: + - get + - patch + - update - apiGroups: - sagemaker.services.k8s.aws resources: diff --git a/config/rbac/role-reader.yaml b/config/rbac/role-reader.yaml index e2a3baed..eeb85fa7 100644 --- a/config/rbac/role-reader.yaml +++ b/config/rbac/role-reader.yaml @@ -9,6 +9,7 @@ rules: - apiGroups: - sagemaker.services.k8s.aws resources: + - apps - dataqualityjobdefinitions - domains - endpoints diff --git a/config/rbac/role-writer.yaml b/config/rbac/role-writer.yaml index 3e2e8bdb..581263e0 100644 --- a/config/rbac/role-writer.yaml +++ b/config/rbac/role-writer.yaml @@ -9,6 +9,7 @@ rules: - apiGroups: - sagemaker.services.k8s.aws resources: + - apps - dataqualityjobdefinitions - domains - endpoints @@ -39,6 +40,7 @@ rules: - apiGroups: - sagemaker.services.k8s.aws resources: + - apps - dataqualityjobdefinitions - domains - endpoints diff --git a/generator.yaml b/generator.yaml index 32509128..8f243104 100644 --- a/generator.yaml +++ b/generator.yaml @@ -786,10 +786,41 @@ resources: Tags: compare: is_ignored: true + App: + exceptions: + errors: + 404: + code: ResourceNotFound + terminal_codes: + - ResourceNotFound + - InvalidParameterCombination + - InvalidParameterValue + - MissingParameter + hooks: + sdk_read_one_post_set_output: + code: rm.customDescribeAppSetOutput(ko) + dk_delete_pre_build_request: + template_path: app/sdk_delete_pre_build_request.go.tpl + sdk_delete_post_request: + template_path: common/sdk_delete_post_request.go.tpl + fields: + Status: + is_read_only: true + print: + name: STATUS + from: + operation: DescribeApp + path: Status + ResourceSpec: + late_initialize: + min_backoff_seconds: 5 + Tags: + compare: + is_ignored: true ignore: resource_names: - Algorithm - - App + # - App - AutoMLJob - Action - AppImageConfig diff --git a/helm/crds/sagemaker.services.k8s.aws_apps.yaml b/helm/crds/sagemaker.services.k8s.aws_apps.yaml new file mode 100644 index 00000000..5086e8a4 --- /dev/null +++ b/helm/crds/sagemaker.services.k8s.aws_apps.yaml @@ -0,0 +1,158 @@ + +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.7.0 + creationTimestamp: null + name: apps.sagemaker.services.k8s.aws +spec: + group: sagemaker.services.k8s.aws + names: + kind: App + listKind: AppList + plural: apps + singular: app + scope: Namespaced + versions: + - additionalPrinterColumns: + - jsonPath: .status.status + name: STATUS + type: string + name: v1alpha1 + schema: + openAPIV3Schema: + description: App is the Schema for the Apps API + properties: + apiVersion: + description: 'APIVersion defines the versioned schema of this representation + of an object. Servers should convert recognized schemas to the latest + internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + type: string + kind: + description: 'Kind is a string value representing the REST resource this + object represents. Servers may infer this from the endpoint the client + submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + type: string + metadata: + type: object + spec: + description: AppSpec defines the desired state of App. + properties: + appName: + description: The name of the app. + type: string + appType: + description: The type of app. Supported apps are JupyterServer and + KernelGateway. TensorBoard is not supported. + type: string + domainID: + description: The domain ID. + type: string + resourceSpec: + description: The instance type and the Amazon Resource Name (ARN) + of the SageMaker image created on the instance. + properties: + instanceType: + type: string + sageMakerImageARN: + type: string + sageMakerImageVersionARN: + type: string + type: object + tags: + description: Each tag consists of a key and an optional value. Tag + keys must be unique per resource. + items: + description: Describes a tag. + properties: + key: + type: string + value: + type: string + type: object + type: array + userProfileName: + description: The user profile name. + type: string + required: + - appName + - appType + - domainID + - userProfileName + type: object + status: + description: AppStatus defines the observed state of App + properties: + ackResourceMetadata: + description: All CRs managed by ACK have a common `Status.ACKResourceMetadata` + member that is used to contain resource sync state, account ownership, + constructed ARN for the resource + properties: + arn: + description: 'ARN is the Amazon Resource Name for the resource. + This is a globally-unique identifier and is set only by the + ACK service controller once the controller has orchestrated + the creation of the resource OR when it has verified that an + "adopted" resource (a resource where the ARN annotation was + set by the Kubernetes user on the CR) exists and matches the + supplied CR''s Spec field values. TODO(vijat@): Find a better + strategy for resources that do not have ARN in CreateOutputResponse + https://github.com/aws/aws-controllers-k8s/issues/270' + type: string + ownerAccountID: + description: OwnerAccountID is the AWS Account ID of the account + that owns the backend AWS service API resource. + type: string + required: + - ownerAccountID + type: object + conditions: + description: All CRS managed by ACK have a common `Status.Conditions` + member that contains a collection of `ackv1alpha1.Condition` objects + that describe the various terminal states of the CR and its backend + AWS service API resource + items: + description: Condition is the common struct used by all CRDs managed + by ACK service controllers to indicate terminal states of the + CR and its backend AWS service API resource + properties: + lastTransitionTime: + description: Last time the condition transitioned from one status + to another. + format: date-time + type: string + message: + description: A human readable message indicating details about + the transition. + type: string + reason: + description: The reason for the condition's last transition. + type: string + status: + description: Status of the condition, one of True, False, Unknown. + type: string + type: + description: Type is the type of the Condition + type: string + required: + - status + - type + type: object + type: array + status: + description: The status. + type: string + type: object + type: object + served: true + storage: true + subresources: + status: {} +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] diff --git a/helm/templates/cluster-role-controller.yaml b/helm/templates/cluster-role-controller.yaml index 8cebddc6..fba70125 100644 --- a/helm/templates/cluster-role-controller.yaml +++ b/helm/templates/cluster-role-controller.yaml @@ -28,6 +28,26 @@ rules: - get - list - watch +- apiGroups: + - sagemaker.services.k8s.aws + resources: + - apps + verbs: + - create + - delete + - get + - list + - patch + - update + - watch +- apiGroups: + - sagemaker.services.k8s.aws + resources: + - apps/status + verbs: + - get + - patch + - update - apiGroups: - sagemaker.services.k8s.aws resources: diff --git a/helm/templates/role-reader.yaml b/helm/templates/role-reader.yaml index 06bce79e..9d58a303 100644 --- a/helm/templates/role-reader.yaml +++ b/helm/templates/role-reader.yaml @@ -9,6 +9,7 @@ rules: - apiGroups: - sagemaker.services.k8s.aws resources: + - apps - dataqualityjobdefinitions - domains - endpoints diff --git a/helm/templates/role-writer.yaml b/helm/templates/role-writer.yaml index 31f43640..672f08dc 100644 --- a/helm/templates/role-writer.yaml +++ b/helm/templates/role-writer.yaml @@ -9,6 +9,8 @@ rules: - apiGroups: - sagemaker.services.k8s.aws resources: + - apps + - dataqualityjobdefinitions - domains @@ -58,6 +60,7 @@ rules: - apiGroups: - sagemaker.services.k8s.aws resources: + - apps - dataqualityjobdefinitions - domains - endpoints diff --git a/pkg/resource/app/delta.go b/pkg/resource/app/delta.go new file mode 100644 index 00000000..b1a4e51c --- /dev/null +++ b/pkg/resource/app/delta.go @@ -0,0 +1,99 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package app + +import ( + "bytes" + "reflect" + + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" +) + +// Hack to avoid import errors during build... +var ( + _ = &bytes.Buffer{} + _ = &reflect.Method{} +) + +// newResourceDelta returns a new `ackcompare.Delta` used to compare two +// resources +func newResourceDelta( + a *resource, + b *resource, +) *ackcompare.Delta { + delta := ackcompare.NewDelta() + if (a == nil && b != nil) || + (a != nil && b == nil) { + delta.Add("", a, b) + return delta + } + + if ackcompare.HasNilDifference(a.ko.Spec.AppName, b.ko.Spec.AppName) { + delta.Add("Spec.AppName", a.ko.Spec.AppName, b.ko.Spec.AppName) + } else if a.ko.Spec.AppName != nil && b.ko.Spec.AppName != nil { + if *a.ko.Spec.AppName != *b.ko.Spec.AppName { + delta.Add("Spec.AppName", a.ko.Spec.AppName, b.ko.Spec.AppName) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.AppType, b.ko.Spec.AppType) { + delta.Add("Spec.AppType", a.ko.Spec.AppType, b.ko.Spec.AppType) + } else if a.ko.Spec.AppType != nil && b.ko.Spec.AppType != nil { + if *a.ko.Spec.AppType != *b.ko.Spec.AppType { + delta.Add("Spec.AppType", a.ko.Spec.AppType, b.ko.Spec.AppType) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.DomainID, b.ko.Spec.DomainID) { + delta.Add("Spec.DomainID", a.ko.Spec.DomainID, b.ko.Spec.DomainID) + } else if a.ko.Spec.DomainID != nil && b.ko.Spec.DomainID != nil { + if *a.ko.Spec.DomainID != *b.ko.Spec.DomainID { + delta.Add("Spec.DomainID", a.ko.Spec.DomainID, b.ko.Spec.DomainID) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.ResourceSpec, b.ko.Spec.ResourceSpec) { + delta.Add("Spec.ResourceSpec", a.ko.Spec.ResourceSpec, b.ko.Spec.ResourceSpec) + } else if a.ko.Spec.ResourceSpec != nil && b.ko.Spec.ResourceSpec != nil { + if ackcompare.HasNilDifference(a.ko.Spec.ResourceSpec.InstanceType, b.ko.Spec.ResourceSpec.InstanceType) { + delta.Add("Spec.ResourceSpec.InstanceType", a.ko.Spec.ResourceSpec.InstanceType, b.ko.Spec.ResourceSpec.InstanceType) + } else if a.ko.Spec.ResourceSpec.InstanceType != nil && b.ko.Spec.ResourceSpec.InstanceType != nil { + if *a.ko.Spec.ResourceSpec.InstanceType != *b.ko.Spec.ResourceSpec.InstanceType { + delta.Add("Spec.ResourceSpec.InstanceType", a.ko.Spec.ResourceSpec.InstanceType, b.ko.Spec.ResourceSpec.InstanceType) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.ResourceSpec.SageMakerImageARN, b.ko.Spec.ResourceSpec.SageMakerImageARN) { + delta.Add("Spec.ResourceSpec.SageMakerImageARN", a.ko.Spec.ResourceSpec.SageMakerImageARN, b.ko.Spec.ResourceSpec.SageMakerImageARN) + } else if a.ko.Spec.ResourceSpec.SageMakerImageARN != nil && b.ko.Spec.ResourceSpec.SageMakerImageARN != nil { + if *a.ko.Spec.ResourceSpec.SageMakerImageARN != *b.ko.Spec.ResourceSpec.SageMakerImageARN { + delta.Add("Spec.ResourceSpec.SageMakerImageARN", a.ko.Spec.ResourceSpec.SageMakerImageARN, b.ko.Spec.ResourceSpec.SageMakerImageARN) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.ResourceSpec.SageMakerImageVersionARN, b.ko.Spec.ResourceSpec.SageMakerImageVersionARN) { + delta.Add("Spec.ResourceSpec.SageMakerImageVersionARN", a.ko.Spec.ResourceSpec.SageMakerImageVersionARN, b.ko.Spec.ResourceSpec.SageMakerImageVersionARN) + } else if a.ko.Spec.ResourceSpec.SageMakerImageVersionARN != nil && b.ko.Spec.ResourceSpec.SageMakerImageVersionARN != nil { + if *a.ko.Spec.ResourceSpec.SageMakerImageVersionARN != *b.ko.Spec.ResourceSpec.SageMakerImageVersionARN { + delta.Add("Spec.ResourceSpec.SageMakerImageVersionARN", a.ko.Spec.ResourceSpec.SageMakerImageVersionARN, b.ko.Spec.ResourceSpec.SageMakerImageVersionARN) + } + } + } + if ackcompare.HasNilDifference(a.ko.Spec.UserProfileName, b.ko.Spec.UserProfileName) { + delta.Add("Spec.UserProfileName", a.ko.Spec.UserProfileName, b.ko.Spec.UserProfileName) + } else if a.ko.Spec.UserProfileName != nil && b.ko.Spec.UserProfileName != nil { + if *a.ko.Spec.UserProfileName != *b.ko.Spec.UserProfileName { + delta.Add("Spec.UserProfileName", a.ko.Spec.UserProfileName, b.ko.Spec.UserProfileName) + } + } + + return delta +} diff --git a/pkg/resource/app/descriptor.go b/pkg/resource/app/descriptor.go new file mode 100644 index 00000000..6e4a9db1 --- /dev/null +++ b/pkg/resource/app/descriptor.go @@ -0,0 +1,154 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package app + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + k8sapirt "k8s.io/apimachinery/pkg/runtime" + k8sctrlutil "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" + + svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1" +) + +const ( + finalizerString = "finalizers.sagemaker.services.k8s.aws/App" +) + +var ( + GroupVersionResource = svcapitypes.GroupVersion.WithResource("apps") + GroupKind = metav1.GroupKind{ + Group: "sagemaker.services.k8s.aws", + Kind: "App", + } +) + +// resourceDescriptor implements the +// `aws-service-operator-k8s/pkg/types.AWSResourceDescriptor` interface +type resourceDescriptor struct { +} + +// GroupKind returns a Kubernetes metav1.GroupKind struct that describes the +// API Group and Kind of CRs described by the descriptor +func (d *resourceDescriptor) GroupKind() *metav1.GroupKind { + return &GroupKind +} + +// EmptyRuntimeObject returns an empty object prototype that may be used in +// apimachinery and k8s client operations +func (d *resourceDescriptor) EmptyRuntimeObject() k8sapirt.Object { + return &svcapitypes.App{} +} + +// ResourceFromRuntimeObject returns an AWSResource that has been initialized +// with the supplied runtime.Object +func (d *resourceDescriptor) ResourceFromRuntimeObject( + obj k8sapirt.Object, +) acktypes.AWSResource { + return &resource{ + ko: obj.(*svcapitypes.App), + } +} + +// Delta returns an `ackcompare.Delta` object containing the difference between +// one `AWSResource` and another. +func (d *resourceDescriptor) Delta(a, b acktypes.AWSResource) *ackcompare.Delta { + return newResourceDelta(a.(*resource), b.(*resource)) +} + +// IsManaged returns true if the supplied AWSResource is under the management +// of an ACK service controller. What this means in practice is that the +// underlying custom resource (CR) in the AWSResource has had a +// resource-specific finalizer associated with it. +func (d *resourceDescriptor) IsManaged( + res acktypes.AWSResource, +) bool { + obj := res.RuntimeMetaObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + // Remove use of custom code once + // https://github.com/kubernetes-sigs/controller-runtime/issues/994 is + // fixed. This should be able to be: + // + // return k8sctrlutil.ContainsFinalizer(obj, finalizerString) + return containsFinalizer(obj, finalizerString) +} + +// Remove once https://github.com/kubernetes-sigs/controller-runtime/issues/994 +// is fixed. +func containsFinalizer(obj acktypes.RuntimeMetaObject, finalizer string) bool { + f := obj.GetFinalizers() + for _, e := range f { + if e == finalizer { + return true + } + } + return false +} + +// MarkManaged places the supplied resource under the management of ACK. What +// this typically means is that the resource manager will decorate the +// underlying custom resource (CR) with a finalizer that indicates ACK is +// managing the resource and the underlying CR may not be deleted until ACK is +// finished cleaning up any backend AWS service resources associated with the +// CR. +func (d *resourceDescriptor) MarkManaged( + res acktypes.AWSResource, +) { + obj := res.RuntimeMetaObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + k8sctrlutil.AddFinalizer(obj, finalizerString) +} + +// MarkUnmanaged removes the supplied resource from management by ACK. What +// this typically means is that the resource manager will remove a finalizer +// underlying custom resource (CR) that indicates ACK is managing the resource. +// This will allow the Kubernetes API server to delete the underlying CR. +func (d *resourceDescriptor) MarkUnmanaged( + res acktypes.AWSResource, +) { + obj := res.RuntimeMetaObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + k8sctrlutil.RemoveFinalizer(obj, finalizerString) +} + +// MarkAdopted places descriptors on the custom resource that indicate the +// resource was not created from within ACK. +func (d *resourceDescriptor) MarkAdopted( + res acktypes.AWSResource, +) { + obj := res.RuntimeMetaObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + curr := obj.GetAnnotations() + if curr == nil { + curr = make(map[string]string) + } + curr[ackv1alpha1.AnnotationAdopted] = "true" + obj.SetAnnotations(curr) +} diff --git a/pkg/resource/app/hook.go b/pkg/resource/app/hook.go new file mode 100644 index 00000000..68bfbd2b --- /dev/null +++ b/pkg/resource/app/hook.go @@ -0,0 +1,51 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +package app + +import ( + "context" + "errors" + + ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue" + svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1" + svccommon "github.com/aws-controllers-k8s/sagemaker-controller/pkg/common" + svcsdk "github.com/aws/aws-sdk-go/service/sagemaker" +) + +var ( + modifyingStatuses = []string{ + svcsdk.AppStatusPending, + svcsdk.AppStatusDeleting, + } + + resourceName = GroupKind.Kind + + requeueWaitWhileDeleting = ackrequeue.NeededAfter( + errors.New(resourceName+" is Deleting."), + ackrequeue.DefaultRequeueAfterDuration, + ) +) + +// requeueUntilCanModify creates and returns an +// ackrequeue error if a resource's latest status matches +// any of the defined modifying statuses below. +func (rm *resourceManager) requeueUntilCanModify(ctx context.Context, r *resource) error { + latestStatus := r.ko.Status.Status + return svccommon.RequeueIfModifying(latestStatus, &resourceName, &modifyingStatuses) +} + +// Sets the ResourceSynced condition to False if resource is being modified by AWS +func (rm *resourceManager) customDescribeAppSetOutput(ko *svcapitypes.App) { + svccommon.SetSyncedCondition(&resource{ko}, ko.Status.Status, &resourceName, &modifyingStatuses) +} diff --git a/pkg/resource/app/identifiers.go b/pkg/resource/app/identifiers.go new file mode 100644 index 00000000..f246b0f2 --- /dev/null +++ b/pkg/resource/app/identifiers.go @@ -0,0 +1,46 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package app + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" +) + +// resourceIdentifiers implements the +// `aws-service-operator-k8s/pkg/types.AWSResourceIdentifiers` interface +type resourceIdentifiers struct { + meta *ackv1alpha1.ResourceMetadata +} + +// ARN returns the AWS Resource Name for the backend AWS resource. If nil, +// this means the resource has not yet been created in the backend AWS +// service. +func (ri *resourceIdentifiers) ARN() *ackv1alpha1.AWSResourceName { + if ri.meta != nil { + return ri.meta.ARN + } + return nil +} + +// OwnerAccountID returns the AWS account identifier in which the +// backend AWS resource resides, or nil if this information is not known +// for the resource +func (ri *resourceIdentifiers) OwnerAccountID() *ackv1alpha1.AWSAccountID { + if ri.meta != nil { + return ri.meta.OwnerAccountID + } + return nil +} diff --git a/pkg/resource/app/manager.go b/pkg/resource/app/manager.go new file mode 100644 index 00000000..4012d74f --- /dev/null +++ b/pkg/resource/app/manager.go @@ -0,0 +1,313 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package app + +import ( + "context" + "fmt" + "time" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + ackcondition "github.com/aws-controllers-k8s/runtime/pkg/condition" + ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config" + ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors" + ackmetrics "github.com/aws-controllers-k8s/runtime/pkg/metrics" + ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue" + ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/go-logr/logr" + corev1 "k8s.io/api/core/v1" + + svcsdk "github.com/aws/aws-sdk-go/service/sagemaker" + svcsdkapi "github.com/aws/aws-sdk-go/service/sagemaker/sagemakeriface" +) + +// +kubebuilder:rbac:groups=sagemaker.services.k8s.aws,resources=apps,verbs=get;list;watch;create;update;patch;delete +// +kubebuilder:rbac:groups=sagemaker.services.k8s.aws,resources=apps/status,verbs=get;update;patch + +var lateInitializeFieldNames = []string{"ResourceSpec"} + +// resourceManager is responsible for providing a consistent way to perform +// CRUD operations in a backend AWS service API for Book custom resources. +type resourceManager struct { + // cfg is a copy of the ackcfg.Config object passed on start of the service + // controller + cfg ackcfg.Config + // log refers to the logr.Logger object handling logging for the service + // controller + log logr.Logger + // metrics contains a collection of Prometheus metric objects that the + // service controller and its reconcilers track + metrics *ackmetrics.Metrics + // rr is the Reconciler which can be used for various utility + // functions such as querying for Secret values given a SecretReference + rr acktypes.Reconciler + // awsAccountID is the AWS account identifier that contains the resources + // managed by this resource manager + awsAccountID ackv1alpha1.AWSAccountID + // The AWS Region that this resource manager targets + awsRegion ackv1alpha1.AWSRegion + // sess is the AWS SDK Session object used to communicate with the backend + // AWS service API + sess *session.Session + // sdk is a pointer to the AWS service API interface exposed by the + // aws-sdk-go/services/{alias}/{alias}iface package. + sdkapi svcsdkapi.SageMakerAPI +} + +// concreteResource returns a pointer to a resource from the supplied +// generic AWSResource interface +func (rm *resourceManager) concreteResource( + res acktypes.AWSResource, +) *resource { + // cast the generic interface into a pointer type specific to the concrete + // implementing resource type managed by this resource manager + return res.(*resource) +} + +// ReadOne returns the currently-observed state of the supplied AWSResource in +// the backend AWS service API. +func (rm *resourceManager) ReadOne( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's ReadOne() method received resource with nil CR object") + } + observed, err := rm.sdkFind(ctx, r) + if err != nil { + if observed != nil { + return rm.onError(observed, err) + } + return rm.onError(r, err) + } + return rm.onSuccess(observed) +} + +// Create attempts to create the supplied AWSResource in the backend AWS +// service API, returning an AWSResource representing the newly-created +// resource +func (rm *resourceManager) Create( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Create() method received resource with nil CR object") + } + created, err := rm.sdkCreate(ctx, r) + if err != nil { + return rm.onError(r, err) + } + return rm.onSuccess(created) +} + +// Update attempts to mutate the supplied desired AWSResource in the backend AWS +// service API, returning an AWSResource representing the newly-mutated +// resource. +// Note for specialized logic implementers can check to see how the latest +// observed resource differs from the supplied desired state. The +// higher-level reonciler determines whether or not the desired differs +// from the latest observed and decides whether to call the resource +// manager's Update method +func (rm *resourceManager) Update( + ctx context.Context, + resDesired acktypes.AWSResource, + resLatest acktypes.AWSResource, + delta *ackcompare.Delta, +) (acktypes.AWSResource, error) { + desired := rm.concreteResource(resDesired) + latest := rm.concreteResource(resLatest) + if desired.ko == nil || latest.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Update() method received resource with nil CR object") + } + updated, err := rm.sdkUpdate(ctx, desired, latest, delta) + if err != nil { + return rm.onError(latest, err) + } + return rm.onSuccess(updated) +} + +// Delete attempts to destroy the supplied AWSResource in the backend AWS +// service API, returning an AWSResource representing the +// resource being deleted (if delete is asynchronous and takes time) +func (rm *resourceManager) Delete( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Update() method received resource with nil CR object") + } + observed, err := rm.sdkDelete(ctx, r) + if err != nil { + if observed != nil { + return rm.onError(observed, err) + } + return rm.onError(r, err) + } + + return rm.onSuccess(observed) +} + +// ARNFromName returns an AWS Resource Name from a given string name. This +// is useful for constructing ARNs for APIs that require ARNs in their +// GetAttributes operations but all we have (for new CRs at least) is a +// name for the resource +func (rm *resourceManager) ARNFromName(name string) string { + return fmt.Sprintf( + "arn:aws:sagemaker:%s:%s:%s", + rm.awsRegion, + rm.awsAccountID, + name, + ) +} + +// LateInitialize returns an acktypes.AWSResource after setting the late initialized +// fields from the readOne call. This method will initialize the optional fields +// which were not provided by the k8s user but were defaulted by the AWS service. +// If there are no such fields to be initialized, the returned object is similar to +// object passed in the parameter. +func (rm *resourceManager) LateInitialize( + ctx context.Context, + latest acktypes.AWSResource, +) (acktypes.AWSResource, error) { + rlog := ackrtlog.FromContext(ctx) + // If there are no fields to late initialize, do nothing + if len(lateInitializeFieldNames) == 0 { + rlog.Debug("no late initialization required.") + return latest, nil + } + latestCopy := latest.DeepCopy() + lateInitConditionReason := "" + lateInitConditionMessage := "" + observed, err := rm.ReadOne(ctx, latestCopy) + if err != nil { + lateInitConditionMessage = "Unable to complete Read operation required for late initialization" + lateInitConditionReason = "Late Initialization Failure" + ackcondition.SetLateInitialized(latestCopy, corev1.ConditionFalse, &lateInitConditionMessage, &lateInitConditionReason) + return latestCopy, err + } + lateInitializedRes := rm.lateInitializeFromReadOneOutput(observed, latestCopy) + incompleteInitialization := rm.incompleteLateInitialization(lateInitializedRes) + if incompleteInitialization { + // Add the condition with LateInitialized=False + lateInitConditionMessage = "Late initialization did not complete, requeuing with delay of 5 seconds" + lateInitConditionReason = "Delayed Late Initialization" + ackcondition.SetLateInitialized(lateInitializedRes, corev1.ConditionFalse, &lateInitConditionMessage, &lateInitConditionReason) + return lateInitializedRes, ackrequeue.NeededAfter(nil, time.Duration(5)*time.Second) + } + // Set LateInitialized condition to True + lateInitConditionMessage = "Late initialization successful" + lateInitConditionReason = "Late initialization successful" + ackcondition.SetLateInitialized(lateInitializedRes, corev1.ConditionTrue, &lateInitConditionMessage, &lateInitConditionReason) + return lateInitializedRes, nil +} + +// incompleteLateInitialization return true if there are fields which were supposed to be +// late initialized but are not. If all the fields are late initialized, false is returned +func (rm *resourceManager) incompleteLateInitialization( + res acktypes.AWSResource, +) bool { + ko := rm.concreteResource(res).ko.DeepCopy() + if ko.Spec.ResourceSpec == nil { + return true + } + return false +} + +// lateInitializeFromReadOneOutput late initializes the 'latest' resource from the 'observed' +// resource and returns 'latest' resource +func (rm *resourceManager) lateInitializeFromReadOneOutput( + observed acktypes.AWSResource, + latest acktypes.AWSResource, +) acktypes.AWSResource { + observedKo := rm.concreteResource(observed).ko.DeepCopy() + latestKo := rm.concreteResource(latest).ko.DeepCopy() + if observedKo.Spec.ResourceSpec != nil && latestKo.Spec.ResourceSpec == nil { + latestKo.Spec.ResourceSpec = observedKo.Spec.ResourceSpec + } + return &resource{latestKo} +} + +// newResourceManager returns a new struct implementing +// acktypes.AWSResourceManager +func newResourceManager( + cfg ackcfg.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + sess *session.Session, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, +) (*resourceManager, error) { + return &resourceManager{ + cfg: cfg, + log: log, + metrics: metrics, + rr: rr, + awsAccountID: id, + awsRegion: region, + sess: sess, + sdkapi: svcsdk.New(sess), + }, nil +} + +// onError updates resource conditions and returns updated resource +// it returns nil if no condition is updated. +func (rm *resourceManager) onError( + r *resource, + err error, +) (acktypes.AWSResource, error) { + if r == nil { + return nil, err + } + r1, updated := rm.updateConditions(r, false, err) + if !updated { + return r, err + } + for _, condition := range r1.Conditions() { + if condition.Type == ackv1alpha1.ConditionTypeTerminal && + condition.Status == corev1.ConditionTrue { + // resource is in Terminal condition + // return Terminal error + return r1, ackerr.Terminal + } + } + return r1, err +} + +// onSuccess updates resource conditions and returns updated resource +// it returns the supplied resource if no condition is updated. +func (rm *resourceManager) onSuccess( + r *resource, +) (acktypes.AWSResource, error) { + if r == nil { + return nil, nil + } + r1, updated := rm.updateConditions(r, true, nil) + if !updated { + return r, nil + } + return r1, nil +} diff --git a/pkg/resource/app/manager_factory.go b/pkg/resource/app/manager_factory.go new file mode 100644 index 00000000..d02a8a88 --- /dev/null +++ b/pkg/resource/app/manager_factory.go @@ -0,0 +1,96 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package app + +import ( + "fmt" + "sync" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcfg "github.com/aws-controllers-k8s/runtime/pkg/config" + ackmetrics "github.com/aws-controllers-k8s/runtime/pkg/metrics" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/go-logr/logr" + + svcresource "github.com/aws-controllers-k8s/sagemaker-controller/pkg/resource" +) + +// resourceManagerFactory produces resourceManager objects. It implements the +// `types.AWSResourceManagerFactory` interface. +type resourceManagerFactory struct { + sync.RWMutex + // rmCache contains resource managers for a particular AWS account ID + rmCache map[string]*resourceManager +} + +// ResourcePrototype returns an AWSResource that resource managers produced by +// this factory will handle +func (f *resourceManagerFactory) ResourceDescriptor() acktypes.AWSResourceDescriptor { + return &resourceDescriptor{} +} + +// ManagerFor returns a resource manager object that can manage resources for a +// supplied AWS account +func (f *resourceManagerFactory) ManagerFor( + cfg ackcfg.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + sess *session.Session, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, +) (acktypes.AWSResourceManager, error) { + rmId := fmt.Sprintf("%s/%s", id, region) + f.RLock() + rm, found := f.rmCache[rmId] + f.RUnlock() + + if found { + return rm, nil + } + + f.Lock() + defer f.Unlock() + + rm, err := newResourceManager(cfg, log, metrics, rr, sess, id, region) + if err != nil { + return nil, err + } + f.rmCache[rmId] = rm + return rm, nil +} + +// IsAdoptable returns true if the resource is able to be adopted +func (f *resourceManagerFactory) IsAdoptable() bool { + return true +} + +// RequeueOnSuccessSeconds returns true if the resource should be requeued after specified seconds +// Default is false which means resource will not be requeued after success. +func (f *resourceManagerFactory) RequeueOnSuccessSeconds() int { + return 0 +} + +func newResourceManagerFactory() *resourceManagerFactory { + return &resourceManagerFactory{ + rmCache: map[string]*resourceManager{}, + } +} + +func init() { + svcresource.RegisterManagerFactory(newResourceManagerFactory()) +} diff --git a/pkg/resource/app/resource.go b/pkg/resource/app/resource.go new file mode 100644 index 00000000..5b9d712b --- /dev/null +++ b/pkg/resource/app/resource.go @@ -0,0 +1,120 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package app + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackerrors "github.com/aws-controllers-k8s/runtime/pkg/errors" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + k8srt "k8s.io/apimachinery/pkg/runtime" + + svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1" +) + +// Hack to avoid import errors during build... +var ( + _ = &ackerrors.MissingNameIdentifier +) + +// resource implements the `aws-controller-k8s/runtime/pkg/types.AWSResource` +// interface +type resource struct { + // The Kubernetes-native CR representing the resource + ko *svcapitypes.App +} + +// Identifiers returns an AWSResourceIdentifiers object containing various +// identifying information, including the AWS account ID that owns the +// resource, the resource's AWS Resource Name (ARN) +func (r *resource) Identifiers() acktypes.AWSResourceIdentifiers { + return &resourceIdentifiers{r.ko.Status.ACKResourceMetadata} +} + +// IsBeingDeleted returns true if the Kubernetes resource has a non-zero +// deletion timestemp +func (r *resource) IsBeingDeleted() bool { + return !r.ko.DeletionTimestamp.IsZero() +} + +// RuntimeObject returns the Kubernetes apimachinery/runtime representation of +// the AWSResource +func (r *resource) RuntimeObject() k8srt.Object { + return r.ko +} + +// MetaObject returns the Kubernetes apimachinery/apis/meta/v1.Object +// representation of the AWSResource +func (r *resource) MetaObject() metav1.Object { + return r.ko.GetObjectMeta() +} + +// RuntimeMetaObject returns an object that implements both the Kubernetes +// apimachinery/runtime.Object and the Kubernetes +// apimachinery/apis/meta/v1.Object interfaces +func (r *resource) RuntimeMetaObject() acktypes.RuntimeMetaObject { + return r.ko +} + +// Conditions returns the ACK Conditions collection for the AWSResource +func (r *resource) Conditions() []*ackv1alpha1.Condition { + return r.ko.Status.Conditions +} + +// ReplaceConditions sets the Conditions status field for the resource +func (r *resource) ReplaceConditions(conditions []*ackv1alpha1.Condition) { + r.ko.Status.Conditions = conditions +} + +// SetObjectMeta sets the ObjectMeta field for the resource +func (r *resource) SetObjectMeta(meta metav1.ObjectMeta) { + r.ko.ObjectMeta = meta +} + +// SetStatus will set the Status field for the resource +func (r *resource) SetStatus(desired acktypes.AWSResource) { + r.ko.Status = desired.(*resource).ko.Status +} + +// SetIdentifiers sets the Spec or Status field that is referenced as the unique +// resource identifier +func (r *resource) SetIdentifiers(identifier *ackv1alpha1.AWSIdentifiers) error { + if identifier.NameOrID == "" { + return ackerrors.MissingNameIdentifier + } + r.ko.Spec.AppName = &identifier.NameOrID + + f1, f1ok := identifier.AdditionalKeys["appType"] + if f1ok { + r.ko.Spec.AppType = &f1 + } + f2, f2ok := identifier.AdditionalKeys["domainID"] + if f2ok { + r.ko.Spec.DomainID = &f2 + } + f3, f3ok := identifier.AdditionalKeys["userProfileName"] + if f3ok { + r.ko.Spec.UserProfileName = &f3 + } + + return nil +} + +// DeepCopy will return a copy of the resource +func (r *resource) DeepCopy() acktypes.AWSResource { + koCopy := r.ko.DeepCopy() + return &resource{koCopy} +} diff --git a/pkg/resource/app/sdk.go b/pkg/resource/app/sdk.go new file mode 100644 index 00000000..f0ea1329 --- /dev/null +++ b/pkg/resource/app/sdk.go @@ -0,0 +1,433 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package app + +import ( + "context" + "strings" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + ackcondition "github.com/aws-controllers-k8s/runtime/pkg/condition" + ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors" + ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" + "github.com/aws/aws-sdk-go/aws" + svcsdk "github.com/aws/aws-sdk-go/service/sagemaker" + corev1 "k8s.io/api/core/v1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + + svcapitypes "github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1" +) + +// Hack to avoid import errors during build... +var ( + _ = &metav1.Time{} + _ = strings.ToLower("") + _ = &aws.JSONValue{} + _ = &svcsdk.SageMaker{} + _ = &svcapitypes.App{} + _ = ackv1alpha1.AWSAccountID("") + _ = &ackerr.NotFound + _ = &ackcondition.NotManagedMessage +) + +// sdkFind returns SDK-specific information about a supplied resource +func (rm *resourceManager) sdkFind( + ctx context.Context, + r *resource, +) (latest *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkFind") + defer exit(err) + // If any required fields in the input shape are missing, AWS resource is + // not created yet. Return NotFound here to indicate to callers that the + // resource isn't yet created. + if rm.requiredFieldsMissingFromReadOneInput(r) { + return nil, ackerr.NotFound + } + + input, err := rm.newDescribeRequestPayload(r) + if err != nil { + return nil, err + } + + var resp *svcsdk.DescribeAppOutput + resp, err = rm.sdkapi.DescribeAppWithContext(ctx, input) + rm.metrics.RecordAPICall("READ_ONE", "DescribeApp", err) + if err != nil { + if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == "ResourceNotFound" { + return nil, ackerr.NotFound + } + return nil, err + } + + // Merge in the information we read from the API call above to the copy of + // the original Kubernetes object we passed to the function + ko := r.ko.DeepCopy() + + if ko.Status.ACKResourceMetadata == nil { + ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{} + } + if resp.AppArn != nil { + arn := ackv1alpha1.AWSResourceName(*resp.AppArn) + ko.Status.ACKResourceMetadata.ARN = &arn + } + if resp.AppName != nil { + ko.Spec.AppName = resp.AppName + } else { + ko.Spec.AppName = nil + } + if resp.AppType != nil { + ko.Spec.AppType = resp.AppType + } else { + ko.Spec.AppType = nil + } + if resp.DomainId != nil { + ko.Spec.DomainID = resp.DomainId + } else { + ko.Spec.DomainID = nil + } + if resp.ResourceSpec != nil { + f8 := &svcapitypes.ResourceSpec{} + if resp.ResourceSpec.InstanceType != nil { + f8.InstanceType = resp.ResourceSpec.InstanceType + } + if resp.ResourceSpec.SageMakerImageArn != nil { + f8.SageMakerImageARN = resp.ResourceSpec.SageMakerImageArn + } + if resp.ResourceSpec.SageMakerImageVersionArn != nil { + f8.SageMakerImageVersionARN = resp.ResourceSpec.SageMakerImageVersionArn + } + ko.Spec.ResourceSpec = f8 + } else { + ko.Spec.ResourceSpec = nil + } + if resp.Status != nil { + ko.Status.Status = resp.Status + } else { + ko.Status.Status = nil + } + if resp.UserProfileName != nil { + ko.Spec.UserProfileName = resp.UserProfileName + } else { + ko.Spec.UserProfileName = nil + } + + rm.setStatusDefaults(ko) + rm.customDescribeAppSetOutput(ko) + return &resource{ko}, nil +} + +// requiredFieldsMissingFromReadOneInput returns true if there are any fields +// for the ReadOne Input shape that are required but not present in the +// resource's Spec or Status +func (rm *resourceManager) requiredFieldsMissingFromReadOneInput( + r *resource, +) bool { + return r.ko.Spec.DomainID == nil || r.ko.Spec.UserProfileName == nil || r.ko.Spec.AppType == nil || r.ko.Spec.AppName == nil + +} + +// newDescribeRequestPayload returns SDK-specific struct for the HTTP request +// payload of the Describe API call for the resource +func (rm *resourceManager) newDescribeRequestPayload( + r *resource, +) (*svcsdk.DescribeAppInput, error) { + res := &svcsdk.DescribeAppInput{} + + if r.ko.Spec.AppName != nil { + res.SetAppName(*r.ko.Spec.AppName) + } + if r.ko.Spec.AppType != nil { + res.SetAppType(*r.ko.Spec.AppType) + } + if r.ko.Spec.DomainID != nil { + res.SetDomainId(*r.ko.Spec.DomainID) + } + if r.ko.Spec.UserProfileName != nil { + res.SetUserProfileName(*r.ko.Spec.UserProfileName) + } + + return res, nil +} + +// sdkCreate creates the supplied resource in the backend AWS service API and +// returns a copy of the resource with resource fields (in both Spec and +// Status) filled in with values from the CREATE API operation's Output shape. +func (rm *resourceManager) sdkCreate( + ctx context.Context, + desired *resource, +) (created *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkCreate") + defer exit(err) + input, err := rm.newCreateRequestPayload(ctx, desired) + if err != nil { + return nil, err + } + + var resp *svcsdk.CreateAppOutput + _ = resp + resp, err = rm.sdkapi.CreateAppWithContext(ctx, input) + rm.metrics.RecordAPICall("CREATE", "CreateApp", err) + if err != nil { + return nil, err + } + // Merge in the information we read from the API call above to the copy of + // the original Kubernetes object we passed to the function + ko := desired.ko.DeepCopy() + + if ko.Status.ACKResourceMetadata == nil { + ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{} + } + if resp.AppArn != nil { + arn := ackv1alpha1.AWSResourceName(*resp.AppArn) + ko.Status.ACKResourceMetadata.ARN = &arn + } + + rm.setStatusDefaults(ko) + return &resource{ko}, nil +} + +// newCreateRequestPayload returns an SDK-specific struct for the HTTP request +// payload of the Create API call for the resource +func (rm *resourceManager) newCreateRequestPayload( + ctx context.Context, + r *resource, +) (*svcsdk.CreateAppInput, error) { + res := &svcsdk.CreateAppInput{} + + if r.ko.Spec.AppName != nil { + res.SetAppName(*r.ko.Spec.AppName) + } + if r.ko.Spec.AppType != nil { + res.SetAppType(*r.ko.Spec.AppType) + } + if r.ko.Spec.DomainID != nil { + res.SetDomainId(*r.ko.Spec.DomainID) + } + if r.ko.Spec.ResourceSpec != nil { + f3 := &svcsdk.ResourceSpec{} + if r.ko.Spec.ResourceSpec.InstanceType != nil { + f3.SetInstanceType(*r.ko.Spec.ResourceSpec.InstanceType) + } + if r.ko.Spec.ResourceSpec.SageMakerImageARN != nil { + f3.SetSageMakerImageArn(*r.ko.Spec.ResourceSpec.SageMakerImageARN) + } + if r.ko.Spec.ResourceSpec.SageMakerImageVersionARN != nil { + f3.SetSageMakerImageVersionArn(*r.ko.Spec.ResourceSpec.SageMakerImageVersionARN) + } + res.SetResourceSpec(f3) + } + if r.ko.Spec.Tags != nil { + f4 := []*svcsdk.Tag{} + for _, f4iter := range r.ko.Spec.Tags { + f4elem := &svcsdk.Tag{} + if f4iter.Key != nil { + f4elem.SetKey(*f4iter.Key) + } + if f4iter.Value != nil { + f4elem.SetValue(*f4iter.Value) + } + f4 = append(f4, f4elem) + } + res.SetTags(f4) + } + if r.ko.Spec.UserProfileName != nil { + res.SetUserProfileName(*r.ko.Spec.UserProfileName) + } + + return res, nil +} + +// sdkUpdate patches the supplied resource in the backend AWS service API and +// returns a new resource with updated fields. +func (rm *resourceManager) sdkUpdate( + ctx context.Context, + desired *resource, + latest *resource, + delta *ackcompare.Delta, +) (*resource, error) { + // TODO(jaypipes): Figure this out... + return nil, ackerr.NotImplemented +} + +// sdkDelete deletes the supplied resource in the backend AWS service API +func (rm *resourceManager) sdkDelete( + ctx context.Context, + r *resource, +) (latest *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkDelete") + defer exit(err) + input, err := rm.newDeleteRequestPayload(r) + if err != nil { + return nil, err + } + var resp *svcsdk.DeleteAppOutput + _ = resp + resp, err = rm.sdkapi.DeleteAppWithContext(ctx, input) + rm.metrics.RecordAPICall("DELETE", "DeleteApp", err) + + if err == nil { + if observed, err := rm.sdkFind(ctx, r); err != ackerr.NotFound { + if err != nil { + return nil, err + } + r.SetStatus(observed) + return r, requeueWaitWhileDeleting + } + } + + return nil, err +} + +// newDeleteRequestPayload returns an SDK-specific struct for the HTTP request +// payload of the Delete API call for the resource +func (rm *resourceManager) newDeleteRequestPayload( + r *resource, +) (*svcsdk.DeleteAppInput, error) { + res := &svcsdk.DeleteAppInput{} + + if r.ko.Spec.AppName != nil { + res.SetAppName(*r.ko.Spec.AppName) + } + if r.ko.Spec.AppType != nil { + res.SetAppType(*r.ko.Spec.AppType) + } + if r.ko.Spec.DomainID != nil { + res.SetDomainId(*r.ko.Spec.DomainID) + } + if r.ko.Spec.UserProfileName != nil { + res.SetUserProfileName(*r.ko.Spec.UserProfileName) + } + + return res, nil +} + +// setStatusDefaults sets default properties into supplied custom resource +func (rm *resourceManager) setStatusDefaults( + ko *svcapitypes.App, +) { + if ko.Status.ACKResourceMetadata == nil { + ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{} + } + if ko.Status.ACKResourceMetadata.OwnerAccountID == nil { + ko.Status.ACKResourceMetadata.OwnerAccountID = &rm.awsAccountID + } + if ko.Status.Conditions == nil { + ko.Status.Conditions = []*ackv1alpha1.Condition{} + } +} + +// updateConditions returns updated resource, true; if conditions were updated +// else it returns nil, false +func (rm *resourceManager) updateConditions( + r *resource, + onSuccess bool, + err error, +) (*resource, bool) { + ko := r.ko.DeepCopy() + rm.setStatusDefaults(ko) + + // Terminal condition + var terminalCondition *ackv1alpha1.Condition = nil + var recoverableCondition *ackv1alpha1.Condition = nil + var syncCondition *ackv1alpha1.Condition = nil + for _, condition := range ko.Status.Conditions { + if condition.Type == ackv1alpha1.ConditionTypeTerminal { + terminalCondition = condition + } + if condition.Type == ackv1alpha1.ConditionTypeRecoverable { + recoverableCondition = condition + } + if condition.Type == ackv1alpha1.ConditionTypeResourceSynced { + syncCondition = condition + } + } + + if rm.terminalAWSError(err) || err == ackerr.SecretTypeNotSupported || err == ackerr.SecretNotFound { + if terminalCondition == nil { + terminalCondition = &ackv1alpha1.Condition{ + Type: ackv1alpha1.ConditionTypeTerminal, + } + ko.Status.Conditions = append(ko.Status.Conditions, terminalCondition) + } + var errorMessage = "" + if err == ackerr.SecretTypeNotSupported || err == ackerr.SecretNotFound { + errorMessage = err.Error() + } else { + awsErr, _ := ackerr.AWSError(err) + errorMessage = awsErr.Error() + } + terminalCondition.Status = corev1.ConditionTrue + terminalCondition.Message = &errorMessage + } else { + // Clear the terminal condition if no longer present + if terminalCondition != nil { + terminalCondition.Status = corev1.ConditionFalse + terminalCondition.Message = nil + } + // Handling Recoverable Conditions + if err != nil { + if recoverableCondition == nil { + // Add a new Condition containing a non-terminal error + recoverableCondition = &ackv1alpha1.Condition{ + Type: ackv1alpha1.ConditionTypeRecoverable, + } + ko.Status.Conditions = append(ko.Status.Conditions, recoverableCondition) + } + recoverableCondition.Status = corev1.ConditionTrue + awsErr, _ := ackerr.AWSError(err) + errorMessage := err.Error() + if awsErr != nil { + errorMessage = awsErr.Error() + } + recoverableCondition.Message = &errorMessage + } else if recoverableCondition != nil { + recoverableCondition.Status = corev1.ConditionFalse + recoverableCondition.Message = nil + } + } + // Required to avoid the "declared but not used" error in the default case + _ = syncCondition + if terminalCondition != nil || recoverableCondition != nil || syncCondition != nil { + return &resource{ko}, true // updated + } + return nil, false // not updated +} + +// terminalAWSError returns awserr, true; if the supplied error is an aws Error type +// and if the exception indicates that it is a Terminal exception +// 'Terminal' exception are specified in generator configuration +func (rm *resourceManager) terminalAWSError(err error) bool { + if err == nil { + return false + } + awsErr, ok := ackerr.AWSError(err) + if !ok { + return false + } + switch awsErr.Code() { + case "ResourceNotFound", + "InvalidParameterCombination", + "InvalidParameterValue", + "MissingParameter": + return true + default: + return false + } +} diff --git a/templates/app/sdk_delete_pre_build_request.go.tpl b/templates/app/sdk_delete_pre_build_request.go.tpl new file mode 100644 index 00000000..52d619f8 --- /dev/null +++ b/templates/app/sdk_delete_pre_build_request.go.tpl @@ -0,0 +1,8 @@ + latestStatus := r.ko.Status.Status + if latestStatus != nil && *latestStatus == svcsdk.AppStatusDeleted { + return nil, nil + } + + if err = rm.requeueUntilCanModify(ctx, r); err != nil { + return r, err + }