diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml index d8f2d78..aabc7b7 100644 --- a/apis/v1alpha1/generator.yaml +++ b/apis/v1alpha1/generator.yaml @@ -118,6 +118,28 @@ resources: hooks: sdk_read_many_post_set_output: template_path: hooks/cache_subnet_group/sdk_read_many_post_set_output.go.tpl + GlobalReplicationGroup: + fields: + GlobalReplicationGroupId: + is_primary_key: true + GlobalReplicationGroupIdSuffix: + is_immutable: true + PrimaryReplicationGroupId: + is_immutable: true + references: + resource: ReplicationGroup + path: Spec.ReplicationGroupID + exceptions: + errors: + 404: + code: GlobalReplicationGroupNotFoundFault + terminal_codes: + - GlobalReplicationGroupAlreadyExistsFault + - InvalidParameterValueException + - InvalidGlobalReplicationGroupStateFault + - ServiceLinkedRoleNotFoundFault + tags: + ignore: true ReplicationGroup: exceptions: terminal_codes: @@ -433,9 +455,12 @@ operations: set_output_custom_method_name: customModifyCacheClusterSetOutput override_values: ApplyImmediately: aws.Bool(true) + ModifyGlobalReplicationGroup: + override_values: + ApplyImmediately: aws.Bool(true) ignore: resource_names: - - GlobalReplicationGroup + - ServerlessCacheSnapshot - CacheSecurityGroup field_paths: - DescribeSnapshotsInput.CacheClusterId diff --git a/apis/v1alpha1/global_replication_group.go b/apis/v1alpha1/global_replication_group.go new file mode 100644 index 0000000..9b2a669 --- /dev/null +++ b/apis/v1alpha1/global_replication_group.go @@ -0,0 +1,137 @@ +// 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" +) + +// GlobalReplicationGroupSpec defines the desired state of GlobalReplicationGroup. +// +// Consists of a primary cluster that accepts writes and an associated secondary +// cluster that resides in a different Amazon region. The secondary cluster +// accepts only reads. The primary cluster automatically replicates updates +// to the secondary cluster. +// +// - The GlobalReplicationGroupIdSuffix represents the name of the Global +// datastore, which is what you use to associate a secondary cluster. +type GlobalReplicationGroupSpec struct { + + // Provides details of the Global datastore + GlobalReplicationGroupDescription *string `json:"globalReplicationGroupDescription,omitempty"` + // The suffix name of a Global datastore. Amazon ElastiCache automatically applies + // a prefix to the Global datastore ID when it is created. Each Amazon Region + // has its own prefix. For instance, a Global datastore ID created in the US-West-1 + // region will begin with "dsdfu" along with the suffix name you provide. The + // suffix, combined with the auto-generated prefix, guarantees uniqueness of + // the Global datastore name across multiple regions. + // + // For a full list of Amazon Regions and their respective Global datastore iD + // prefixes, see Using the Amazon CLI with Global datastores (http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastores-CLI.html). + // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set" + // +kubebuilder:validation:Required + GlobalReplicationGroupIDSuffix *string `json:"globalReplicationGroupIDSuffix"` + // The name of the primary cluster that accepts writes and will replicate updates + // to the secondary cluster. + // +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable once set" + PrimaryReplicationGroupID *string `json:"primaryReplicationGroupID,omitempty"` + PrimaryReplicationGroupRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"primaryReplicationGroupRef,omitempty"` +} + +// GlobalReplicationGroupStatus defines the observed state of GlobalReplicationGroup +type GlobalReplicationGroupStatus 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"` + // A flag that enables encryption at rest when set to true. + // + // You cannot modify the value of AtRestEncryptionEnabled after the replication + // group is created. To enable encryption at rest on a replication group you + // must set AtRestEncryptionEnabled to true when you create the replication + // group. + // + // Required: Only available when creating a replication group in an Amazon VPC + // using Redis OSS version 3.2.6, 4.x or later. + // +kubebuilder:validation:Optional + AtRestEncryptionEnabled *bool `json:"atRestEncryptionEnabled,omitempty"` + // A flag that enables using an AuthToken (password) when issuing Valkey or + // Redis OSS commands. + // + // Default: false + // +kubebuilder:validation:Optional + AuthTokenEnabled *bool `json:"authTokenEnabled,omitempty"` + // The cache node type of the Global datastore + // +kubebuilder:validation:Optional + CacheNodeType *string `json:"cacheNodeType,omitempty"` + // A flag that indicates whether the Global datastore is cluster enabled. + // +kubebuilder:validation:Optional + ClusterEnabled *bool `json:"clusterEnabled,omitempty"` + // The ElastiCache engine. For Valkey or Redis OSS only. + // +kubebuilder:validation:Optional + Engine *string `json:"engine,omitempty"` + // The ElastiCache engine version. + // +kubebuilder:validation:Optional + EngineVersion *string `json:"engineVersion,omitempty"` + // Indicates the slot configuration and global identifier for each slice group. + // +kubebuilder:validation:Optional + GlobalNodeGroups []*GlobalNodeGroup `json:"globalNodeGroups,omitempty"` + // The name of the Global datastore + // +kubebuilder:validation:Optional + GlobalReplicationGroupID *string `json:"globalReplicationGroupID,omitempty"` + // The replication groups that comprise the Global datastore. + // +kubebuilder:validation:Optional + Members []*GlobalReplicationGroupMember `json:"members,omitempty"` + // The status of the Global datastore + // +kubebuilder:validation:Optional + Status *string `json:"status,omitempty"` + // A flag that enables in-transit encryption when set to true. + // + // Required: Only available when creating a replication group in an Amazon VPC + // using Redis OSS version 3.2.6, 4.x or later. + // +kubebuilder:validation:Optional + TransitEncryptionEnabled *bool `json:"transitEncryptionEnabled,omitempty"` +} + +// GlobalReplicationGroup is the Schema for the GlobalReplicationGroups API +// +kubebuilder:object:root=true +// +kubebuilder:subresource:status +type GlobalReplicationGroup struct { + metav1.TypeMeta `json:",inline"` + metav1.ObjectMeta `json:"metadata,omitempty"` + Spec GlobalReplicationGroupSpec `json:"spec,omitempty"` + Status GlobalReplicationGroupStatus `json:"status,omitempty"` +} + +// GlobalReplicationGroupList contains a list of GlobalReplicationGroup +// +kubebuilder:object:root=true +type GlobalReplicationGroupList struct { + metav1.TypeMeta `json:",inline"` + metav1.ListMeta `json:"metadata,omitempty"` + Items []GlobalReplicationGroup `json:"items"` +} + +func init() { + SchemeBuilder.Register(&GlobalReplicationGroup{}, &GlobalReplicationGroupList{}) +} diff --git a/apis/v1alpha1/types.go b/apis/v1alpha1/types.go index fd121ec..8d5d2d1 100644 --- a/apis/v1alpha1/types.go +++ b/apis/v1alpha1/types.go @@ -345,27 +345,6 @@ type GlobalNodeGroup struct { Slots *string `json:"slots,omitempty"` } -// Consists of a primary cluster that accepts writes and an associated secondary -// cluster that resides in a different Amazon region. The secondary cluster -// accepts only reads. The primary cluster automatically replicates updates -// to the secondary cluster. -// -// - The GlobalReplicationGroupIdSuffix represents the name of the Global -// datastore, which is what you use to associate a secondary cluster. -type GlobalReplicationGroup struct { - ARN *string `json:"arn,omitempty"` - AtRestEncryptionEnabled *bool `json:"atRestEncryptionEnabled,omitempty"` - AuthTokenEnabled *bool `json:"authTokenEnabled,omitempty"` - CacheNodeType *string `json:"cacheNodeType,omitempty"` - ClusterEnabled *bool `json:"clusterEnabled,omitempty"` - Engine *string `json:"engine,omitempty"` - EngineVersion *string `json:"engineVersion,omitempty"` - GlobalReplicationGroupDescription *string `json:"globalReplicationGroupDescription,omitempty"` - GlobalReplicationGroupID *string `json:"globalReplicationGroupID,omitempty"` - Status *string `json:"status,omitempty"` - TransitEncryptionEnabled *bool `json:"transitEncryptionEnabled,omitempty"` -} - // The name of the Global datastore and role of this replication group in the // Global datastore. type GlobalReplicationGroupInfo struct { @@ -383,6 +362,29 @@ type GlobalReplicationGroupMember struct { Status *string `json:"status,omitempty"` } +// Consists of a primary cluster that accepts writes and an associated secondary +// cluster that resides in a different Amazon region. The secondary cluster +// accepts only reads. The primary cluster automatically replicates updates +// to the secondary cluster. +// +// - The GlobalReplicationGroupIdSuffix represents the name of the Global +// datastore, which is what you use to associate a secondary cluster. +type GlobalReplicationGroup_SDK struct { + ARN *string `json:"arn,omitempty"` + AtRestEncryptionEnabled *bool `json:"atRestEncryptionEnabled,omitempty"` + AuthTokenEnabled *bool `json:"authTokenEnabled,omitempty"` + CacheNodeType *string `json:"cacheNodeType,omitempty"` + ClusterEnabled *bool `json:"clusterEnabled,omitempty"` + Engine *string `json:"engine,omitempty"` + EngineVersion *string `json:"engineVersion,omitempty"` + GlobalNodeGroups []*GlobalNodeGroup `json:"globalNodeGroups,omitempty"` + GlobalReplicationGroupDescription *string `json:"globalReplicationGroupDescription,omitempty"` + GlobalReplicationGroupID *string `json:"globalReplicationGroupID,omitempty"` + Members []*GlobalReplicationGroupMember `json:"members,omitempty"` + Status *string `json:"status,omitempty"` + TransitEncryptionEnabled *bool `json:"transitEncryptionEnabled,omitempty"` +} + // The configuration details of the Kinesis Data Firehose destination. type KinesisFirehoseDestinationDetails struct { DeliveryStream *string `json:"deliveryStream,omitempty"` diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go index f4b04d0..5fd7c7f 100644 --- a/apis/v1alpha1/zz_generated.deepcopy.go +++ b/apis/v1alpha1/zz_generated.deepcopy.go @@ -1831,11 +1831,181 @@ func (in *GlobalNodeGroup) DeepCopy() *GlobalNodeGroup { // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *GlobalReplicationGroup) DeepCopyInto(out *GlobalReplicationGroup) { *out = *in - if in.ARN != nil { - in, out := &in.ARN, &out.ARN + 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 GlobalReplicationGroup. +func (in *GlobalReplicationGroup) DeepCopy() *GlobalReplicationGroup { + if in == nil { + return nil + } + out := new(GlobalReplicationGroup) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *GlobalReplicationGroup) 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 *GlobalReplicationGroupInfo) DeepCopyInto(out *GlobalReplicationGroupInfo) { + *out = *in + if in.GlobalReplicationGroupID != nil { + in, out := &in.GlobalReplicationGroupID, &out.GlobalReplicationGroupID + *out = new(string) + **out = **in + } + if in.GlobalReplicationGroupMemberRole != nil { + in, out := &in.GlobalReplicationGroupMemberRole, &out.GlobalReplicationGroupMemberRole + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalReplicationGroupInfo. +func (in *GlobalReplicationGroupInfo) DeepCopy() *GlobalReplicationGroupInfo { + if in == nil { + return nil + } + out := new(GlobalReplicationGroupInfo) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *GlobalReplicationGroupList) DeepCopyInto(out *GlobalReplicationGroupList) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ListMeta.DeepCopyInto(&out.ListMeta) + if in.Items != nil { + in, out := &in.Items, &out.Items + *out = make([]GlobalReplicationGroup, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalReplicationGroupList. +func (in *GlobalReplicationGroupList) DeepCopy() *GlobalReplicationGroupList { + if in == nil { + return nil + } + out := new(GlobalReplicationGroupList) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *GlobalReplicationGroupList) 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 *GlobalReplicationGroupMember) DeepCopyInto(out *GlobalReplicationGroupMember) { + *out = *in + if in.AutomaticFailover != nil { + in, out := &in.AutomaticFailover, &out.AutomaticFailover + *out = new(string) + **out = **in + } + if in.ReplicationGroupID != nil { + in, out := &in.ReplicationGroupID, &out.ReplicationGroupID + *out = new(string) + **out = **in + } + if in.ReplicationGroupRegion != nil { + in, out := &in.ReplicationGroupRegion, &out.ReplicationGroupRegion + *out = new(string) + **out = **in + } + if in.Role != nil { + in, out := &in.Role, &out.Role + *out = new(string) + **out = **in + } + 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 GlobalReplicationGroupMember. +func (in *GlobalReplicationGroupMember) DeepCopy() *GlobalReplicationGroupMember { + if in == nil { + return nil + } + out := new(GlobalReplicationGroupMember) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *GlobalReplicationGroupSpec) DeepCopyInto(out *GlobalReplicationGroupSpec) { + *out = *in + if in.GlobalReplicationGroupDescription != nil { + in, out := &in.GlobalReplicationGroupDescription, &out.GlobalReplicationGroupDescription + *out = new(string) + **out = **in + } + if in.GlobalReplicationGroupIDSuffix != nil { + in, out := &in.GlobalReplicationGroupIDSuffix, &out.GlobalReplicationGroupIDSuffix + *out = new(string) + **out = **in + } + if in.PrimaryReplicationGroupID != nil { + in, out := &in.PrimaryReplicationGroupID, &out.PrimaryReplicationGroupID *out = new(string) **out = **in } + if in.PrimaryReplicationGroupRef != nil { + in, out := &in.PrimaryReplicationGroupRef, &out.PrimaryReplicationGroupRef + *out = new(corev1alpha1.AWSResourceReferenceWrapper) + (*in).DeepCopyInto(*out) + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalReplicationGroupSpec. +func (in *GlobalReplicationGroupSpec) DeepCopy() *GlobalReplicationGroupSpec { + if in == nil { + return nil + } + out := new(GlobalReplicationGroupSpec) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *GlobalReplicationGroupStatus) DeepCopyInto(out *GlobalReplicationGroupStatus) { + *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.AtRestEncryptionEnabled != nil { in, out := &in.AtRestEncryptionEnabled, &out.AtRestEncryptionEnabled *out = new(bool) @@ -1866,16 +2036,33 @@ func (in *GlobalReplicationGroup) DeepCopyInto(out *GlobalReplicationGroup) { *out = new(string) **out = **in } - if in.GlobalReplicationGroupDescription != nil { - in, out := &in.GlobalReplicationGroupDescription, &out.GlobalReplicationGroupDescription - *out = new(string) - **out = **in + if in.GlobalNodeGroups != nil { + in, out := &in.GlobalNodeGroups, &out.GlobalNodeGroups + *out = make([]*GlobalNodeGroup, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(GlobalNodeGroup) + (*in).DeepCopyInto(*out) + } + } } if in.GlobalReplicationGroupID != nil { in, out := &in.GlobalReplicationGroupID, &out.GlobalReplicationGroupID *out = new(string) **out = **in } + if in.Members != nil { + in, out := &in.Members, &out.Members + *out = make([]*GlobalReplicationGroupMember, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(GlobalReplicationGroupMember) + (*in).DeepCopyInto(*out) + } + } + } if in.Status != nil { in, out := &in.Status, &out.Status *out = new(string) @@ -1888,77 +2075,104 @@ func (in *GlobalReplicationGroup) DeepCopyInto(out *GlobalReplicationGroup) { } } -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalReplicationGroup. -func (in *GlobalReplicationGroup) DeepCopy() *GlobalReplicationGroup { +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalReplicationGroupStatus. +func (in *GlobalReplicationGroupStatus) DeepCopy() *GlobalReplicationGroupStatus { if in == nil { return nil } - out := new(GlobalReplicationGroup) + out := new(GlobalReplicationGroupStatus) in.DeepCopyInto(out) return out } // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *GlobalReplicationGroupInfo) DeepCopyInto(out *GlobalReplicationGroupInfo) { +func (in *GlobalReplicationGroup_SDK) DeepCopyInto(out *GlobalReplicationGroup_SDK) { *out = *in - if in.GlobalReplicationGroupID != nil { - in, out := &in.GlobalReplicationGroupID, &out.GlobalReplicationGroupID + if in.ARN != nil { + in, out := &in.ARN, &out.ARN *out = new(string) **out = **in } - if in.GlobalReplicationGroupMemberRole != nil { - in, out := &in.GlobalReplicationGroupMemberRole, &out.GlobalReplicationGroupMemberRole + if in.AtRestEncryptionEnabled != nil { + in, out := &in.AtRestEncryptionEnabled, &out.AtRestEncryptionEnabled + *out = new(bool) + **out = **in + } + if in.AuthTokenEnabled != nil { + in, out := &in.AuthTokenEnabled, &out.AuthTokenEnabled + *out = new(bool) + **out = **in + } + if in.CacheNodeType != nil { + in, out := &in.CacheNodeType, &out.CacheNodeType *out = new(string) **out = **in } -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalReplicationGroupInfo. -func (in *GlobalReplicationGroupInfo) DeepCopy() *GlobalReplicationGroupInfo { - if in == nil { - return nil + if in.ClusterEnabled != nil { + in, out := &in.ClusterEnabled, &out.ClusterEnabled + *out = new(bool) + **out = **in } - out := new(GlobalReplicationGroupInfo) - in.DeepCopyInto(out) - return out -} - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *GlobalReplicationGroupMember) DeepCopyInto(out *GlobalReplicationGroupMember) { - *out = *in - if in.AutomaticFailover != nil { - in, out := &in.AutomaticFailover, &out.AutomaticFailover + if in.Engine != nil { + in, out := &in.Engine, &out.Engine *out = new(string) **out = **in } - if in.ReplicationGroupID != nil { - in, out := &in.ReplicationGroupID, &out.ReplicationGroupID + if in.EngineVersion != nil { + in, out := &in.EngineVersion, &out.EngineVersion *out = new(string) **out = **in } - if in.ReplicationGroupRegion != nil { - in, out := &in.ReplicationGroupRegion, &out.ReplicationGroupRegion + if in.GlobalNodeGroups != nil { + in, out := &in.GlobalNodeGroups, &out.GlobalNodeGroups + *out = make([]*GlobalNodeGroup, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(GlobalNodeGroup) + (*in).DeepCopyInto(*out) + } + } + } + if in.GlobalReplicationGroupDescription != nil { + in, out := &in.GlobalReplicationGroupDescription, &out.GlobalReplicationGroupDescription *out = new(string) **out = **in } - if in.Role != nil { - in, out := &in.Role, &out.Role + if in.GlobalReplicationGroupID != nil { + in, out := &in.GlobalReplicationGroupID, &out.GlobalReplicationGroupID *out = new(string) **out = **in } + if in.Members != nil { + in, out := &in.Members, &out.Members + *out = make([]*GlobalReplicationGroupMember, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(GlobalReplicationGroupMember) + (*in).DeepCopyInto(*out) + } + } + } if in.Status != nil { in, out := &in.Status, &out.Status *out = new(string) **out = **in } + if in.TransitEncryptionEnabled != nil { + in, out := &in.TransitEncryptionEnabled, &out.TransitEncryptionEnabled + *out = new(bool) + **out = **in + } } -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalReplicationGroupMember. -func (in *GlobalReplicationGroupMember) DeepCopy() *GlobalReplicationGroupMember { +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalReplicationGroup_SDK. +func (in *GlobalReplicationGroup_SDK) DeepCopy() *GlobalReplicationGroup_SDK { if in == nil { return nil } - out := new(GlobalReplicationGroupMember) + out := new(GlobalReplicationGroup_SDK) in.DeepCopyInto(out) return out } diff --git a/cmd/controller/main.go b/cmd/controller/main.go index cd7c4ad..ad67135 100644 --- a/cmd/controller/main.go +++ b/cmd/controller/main.go @@ -45,6 +45,7 @@ import ( _ "github.com/aws-controllers-k8s/elasticache-controller/pkg/resource/cache_cluster" _ "github.com/aws-controllers-k8s/elasticache-controller/pkg/resource/cache_parameter_group" _ "github.com/aws-controllers-k8s/elasticache-controller/pkg/resource/cache_subnet_group" + _ "github.com/aws-controllers-k8s/elasticache-controller/pkg/resource/global_replication_group" _ "github.com/aws-controllers-k8s/elasticache-controller/pkg/resource/replication_group" _ "github.com/aws-controllers-k8s/elasticache-controller/pkg/resource/serverless_cache" _ "github.com/aws-controllers-k8s/elasticache-controller/pkg/resource/serverless_cache_snapshot" diff --git a/config/crd/bases/elasticache.services.k8s.aws_globalreplicationgroups.yaml b/config/crd/bases/elasticache.services.k8s.aws_globalreplicationgroups.yaml new file mode 100644 index 0000000..192bf13 --- /dev/null +++ b/config/crd/bases/elasticache.services.k8s.aws_globalreplicationgroups.yaml @@ -0,0 +1,248 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.16.2 + name: globalreplicationgroups.elasticache.services.k8s.aws +spec: + group: elasticache.services.k8s.aws + names: + kind: GlobalReplicationGroup + listKind: GlobalReplicationGroupList + plural: globalreplicationgroups + singular: globalreplicationgroup + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: GlobalReplicationGroup is the Schema for the GlobalReplicationGroups + 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: |- + GlobalReplicationGroupSpec defines the desired state of GlobalReplicationGroup. + + Consists of a primary cluster that accepts writes and an associated secondary + cluster that resides in a different Amazon region. The secondary cluster + accepts only reads. The primary cluster automatically replicates updates + to the secondary cluster. + + * The GlobalReplicationGroupIdSuffix represents the name of the Global + datastore, which is what you use to associate a secondary cluster. + properties: + globalReplicationGroupDescription: + description: Provides details of the Global datastore + type: string + globalReplicationGroupIDSuffix: + description: |- + The suffix name of a Global datastore. Amazon ElastiCache automatically applies + a prefix to the Global datastore ID when it is created. Each Amazon Region + has its own prefix. For instance, a Global datastore ID created in the US-West-1 + region will begin with "dsdfu" along with the suffix name you provide. The + suffix, combined with the auto-generated prefix, guarantees uniqueness of + the Global datastore name across multiple regions. + + For a full list of Amazon Regions and their respective Global datastore iD + prefixes, see Using the Amazon CLI with Global datastores (http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastores-CLI.html). + type: string + x-kubernetes-validations: + - message: Value is immutable once set + rule: self == oldSelf + primaryReplicationGroupID: + description: |- + The name of the primary cluster that accepts writes and will replicate updates + to the secondary cluster. + type: string + x-kubernetes-validations: + - message: Value is immutable once set + rule: self == oldSelf + primaryReplicationGroupRef: + description: "AWSResourceReferenceWrapper provides a wrapper around + *AWSResourceReference\ntype to provide more user friendly syntax + for references using 'from' field\nEx:\nAPIIDRef:\n\n\tfrom:\n\t + \ name: my-api" + properties: + from: + description: |- + AWSResourceReference provides all the values necessary to reference another + k8s resource for finding the identifier(Id/ARN/Name) + properties: + name: + type: string + namespace: + type: string + type: object + type: object + required: + - globalReplicationGroupIDSuffix + type: object + status: + description: GlobalReplicationGroupStatus defines the observed state of + GlobalReplicationGroup + 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. + 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 + region: + description: Region is the AWS region in which the resource exists + or will exist. + type: string + required: + - ownerAccountID + - region + type: object + atRestEncryptionEnabled: + description: |- + A flag that enables encryption at rest when set to true. + + You cannot modify the value of AtRestEncryptionEnabled after the replication + group is created. To enable encryption at rest on a replication group you + must set AtRestEncryptionEnabled to true when you create the replication + group. + + Required: Only available when creating a replication group in an Amazon VPC + using Redis OSS version 3.2.6, 4.x or later. + type: boolean + authTokenEnabled: + description: |- + A flag that enables using an AuthToken (password) when issuing Valkey or + Redis OSS commands. + + Default: false + type: boolean + cacheNodeType: + description: The cache node type of the Global datastore + type: string + clusterEnabled: + description: A flag that indicates whether the Global datastore is + cluster enabled. + type: boolean + 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 + engine: + description: The ElastiCache engine. For Valkey or Redis OSS only. + type: string + engineVersion: + description: The ElastiCache engine version. + type: string + globalNodeGroups: + description: Indicates the slot configuration and global identifier + for each slice group. + items: + description: Indicates the slot configuration and global identifier + for a slice group. + properties: + globalNodeGroupID: + type: string + slots: + type: string + type: object + type: array + globalReplicationGroupID: + description: The name of the Global datastore + type: string + members: + description: The replication groups that comprise the Global datastore. + items: + description: |- + A member of a Global datastore. It contains the Replication Group Id, the + Amazon region and the role of the replication group. + properties: + automaticFailover: + type: string + replicationGroupID: + type: string + replicationGroupRegion: + type: string + role: + type: string + status: + type: string + type: object + type: array + status: + description: The status of the Global datastore + type: string + transitEncryptionEnabled: + description: |- + A flag that enables in-transit encryption when set to true. + + Required: Only available when creating a replication group in an Amazon VPC + using Redis OSS version 3.2.6, 4.x or later. + type: boolean + type: object + type: object + served: true + storage: true + subresources: + status: {} diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml index 967b537..312521f 100644 --- a/config/crd/kustomization.yaml +++ b/config/crd/kustomization.yaml @@ -5,6 +5,7 @@ resources: - bases/elasticache.services.k8s.aws_cacheclusters.yaml - bases/elasticache.services.k8s.aws_cacheparametergroups.yaml - bases/elasticache.services.k8s.aws_cachesubnetgroups.yaml + - bases/elasticache.services.k8s.aws_globalreplicationgroups.yaml - bases/elasticache.services.k8s.aws_replicationgroups.yaml - bases/elasticache.services.k8s.aws_serverlesscaches.yaml - bases/elasticache.services.k8s.aws_serverlesscachesnapshots.yaml diff --git a/config/rbac/cluster-role-controller.yaml b/config/rbac/cluster-role-controller.yaml index 8e3b892..b7110c4 100644 --- a/config/rbac/cluster-role-controller.yaml +++ b/config/rbac/cluster-role-controller.yaml @@ -38,6 +38,7 @@ rules: - cacheclusters - cacheparametergroups - cachesubnetgroups + - globalreplicationgroups - replicationgroups - serverlesscaches - serverlesscachesnapshots @@ -58,6 +59,7 @@ rules: - cacheclusters/status - cacheparametergroups/status - cachesubnetgroups/status + - globalreplicationgroups/status - replicationgroups/status - serverlesscaches/status - serverlesscachesnapshots/status diff --git a/config/rbac/role-reader.yaml b/config/rbac/role-reader.yaml index 801dbcc..edeabbf 100644 --- a/config/rbac/role-reader.yaml +++ b/config/rbac/role-reader.yaml @@ -12,6 +12,7 @@ rules: - cacheclusters - cacheparametergroups - cachesubnetgroups + - globalreplicationgroups - replicationgroups - serverlesscaches - serverlesscachesnapshots diff --git a/config/rbac/role-writer.yaml b/config/rbac/role-writer.yaml index b45826c..55adc2e 100644 --- a/config/rbac/role-writer.yaml +++ b/config/rbac/role-writer.yaml @@ -12,6 +12,7 @@ rules: - cacheclusters - cacheparametergroups - cachesubnetgroups + - globalreplicationgroups - replicationgroups - serverlesscaches - serverlesscachesnapshots @@ -32,6 +33,7 @@ rules: - cacheclusters - cacheparametergroups - cachesubnetgroups + - globalreplicationgroups - replicationgroups - serverlesscaches - serverlesscachesnapshots diff --git a/generator.yaml b/generator.yaml index d8f2d78..aabc7b7 100644 --- a/generator.yaml +++ b/generator.yaml @@ -118,6 +118,28 @@ resources: hooks: sdk_read_many_post_set_output: template_path: hooks/cache_subnet_group/sdk_read_many_post_set_output.go.tpl + GlobalReplicationGroup: + fields: + GlobalReplicationGroupId: + is_primary_key: true + GlobalReplicationGroupIdSuffix: + is_immutable: true + PrimaryReplicationGroupId: + is_immutable: true + references: + resource: ReplicationGroup + path: Spec.ReplicationGroupID + exceptions: + errors: + 404: + code: GlobalReplicationGroupNotFoundFault + terminal_codes: + - GlobalReplicationGroupAlreadyExistsFault + - InvalidParameterValueException + - InvalidGlobalReplicationGroupStateFault + - ServiceLinkedRoleNotFoundFault + tags: + ignore: true ReplicationGroup: exceptions: terminal_codes: @@ -433,9 +455,12 @@ operations: set_output_custom_method_name: customModifyCacheClusterSetOutput override_values: ApplyImmediately: aws.Bool(true) + ModifyGlobalReplicationGroup: + override_values: + ApplyImmediately: aws.Bool(true) ignore: resource_names: - - GlobalReplicationGroup + - ServerlessCacheSnapshot - CacheSecurityGroup field_paths: - DescribeSnapshotsInput.CacheClusterId diff --git a/helm/crds/elasticache.services.k8s.aws_globalreplicationgroups.yaml b/helm/crds/elasticache.services.k8s.aws_globalreplicationgroups.yaml new file mode 100644 index 0000000..b128d3b --- /dev/null +++ b/helm/crds/elasticache.services.k8s.aws_globalreplicationgroups.yaml @@ -0,0 +1,248 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.16.2 + name: globalreplicationgroups.elasticache.services.k8s.aws +spec: + group: elasticache.services.k8s.aws + names: + kind: GlobalReplicationGroup + listKind: GlobalReplicationGroupList + plural: globalreplicationgroups + singular: globalreplicationgroup + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: GlobalReplicationGroup is the Schema for the GlobalReplicationGroups + 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: |- + GlobalReplicationGroupSpec defines the desired state of GlobalReplicationGroup. + + Consists of a primary cluster that accepts writes and an associated secondary + cluster that resides in a different Amazon region. The secondary cluster + accepts only reads. The primary cluster automatically replicates updates + to the secondary cluster. + + - The GlobalReplicationGroupIdSuffix represents the name of the Global + datastore, which is what you use to associate a secondary cluster. + properties: + globalReplicationGroupDescription: + description: Provides details of the Global datastore + type: string + globalReplicationGroupIDSuffix: + description: |- + The suffix name of a Global datastore. Amazon ElastiCache automatically applies + a prefix to the Global datastore ID when it is created. Each Amazon Region + has its own prefix. For instance, a Global datastore ID created in the US-West-1 + region will begin with "dsdfu" along with the suffix name you provide. The + suffix, combined with the auto-generated prefix, guarantees uniqueness of + the Global datastore name across multiple regions. + + For a full list of Amazon Regions and their respective Global datastore iD + prefixes, see Using the Amazon CLI with Global datastores (http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastores-CLI.html). + type: string + x-kubernetes-validations: + - message: Value is immutable once set + rule: self == oldSelf + primaryReplicationGroupID: + description: |- + The name of the primary cluster that accepts writes and will replicate updates + to the secondary cluster. + type: string + x-kubernetes-validations: + - message: Value is immutable once set + rule: self == oldSelf + primaryReplicationGroupRef: + description: "AWSResourceReferenceWrapper provides a wrapper around + *AWSResourceReference\ntype to provide more user friendly syntax + for references using 'from' field\nEx:\nAPIIDRef:\n\n\tfrom:\n\t + \ name: my-api" + properties: + from: + description: |- + AWSResourceReference provides all the values necessary to reference another + k8s resource for finding the identifier(Id/ARN/Name) + properties: + name: + type: string + namespace: + type: string + type: object + type: object + required: + - globalReplicationGroupIDSuffix + type: object + status: + description: GlobalReplicationGroupStatus defines the observed state of + GlobalReplicationGroup + 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. + 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 + region: + description: Region is the AWS region in which the resource exists + or will exist. + type: string + required: + - ownerAccountID + - region + type: object + atRestEncryptionEnabled: + description: |- + A flag that enables encryption at rest when set to true. + + You cannot modify the value of AtRestEncryptionEnabled after the replication + group is created. To enable encryption at rest on a replication group you + must set AtRestEncryptionEnabled to true when you create the replication + group. + + Required: Only available when creating a replication group in an Amazon VPC + using Redis OSS version 3.2.6, 4.x or later. + type: boolean + authTokenEnabled: + description: |- + A flag that enables using an AuthToken (password) when issuing Valkey or + Redis OSS commands. + + Default: false + type: boolean + cacheNodeType: + description: The cache node type of the Global datastore + type: string + clusterEnabled: + description: A flag that indicates whether the Global datastore is + cluster enabled. + type: boolean + 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 + engine: + description: The ElastiCache engine. For Valkey or Redis OSS only. + type: string + engineVersion: + description: The ElastiCache engine version. + type: string + globalNodeGroups: + description: Indicates the slot configuration and global identifier + for each slice group. + items: + description: Indicates the slot configuration and global identifier + for a slice group. + properties: + globalNodeGroupID: + type: string + slots: + type: string + type: object + type: array + globalReplicationGroupID: + description: The name of the Global datastore + type: string + members: + description: The replication groups that comprise the Global datastore. + items: + description: |- + A member of a Global datastore. It contains the Replication Group Id, the + Amazon region and the role of the replication group. + properties: + automaticFailover: + type: string + replicationGroupID: + type: string + replicationGroupRegion: + type: string + role: + type: string + status: + type: string + type: object + type: array + status: + description: The status of the Global datastore + type: string + transitEncryptionEnabled: + description: |- + A flag that enables in-transit encryption when set to true. + + Required: Only available when creating a replication group in an Amazon VPC + using Redis OSS version 3.2.6, 4.x or later. + type: boolean + type: object + type: object + served: true + storage: true + subresources: + status: {} diff --git a/helm/templates/_helpers.tpl b/helm/templates/_helpers.tpl index f08a46d..cf64928 100644 --- a/helm/templates/_helpers.tpl +++ b/helm/templates/_helpers.tpl @@ -85,6 +85,7 @@ rules: - cacheclusters - cacheparametergroups - cachesubnetgroups + - globalreplicationgroups - replicationgroups - serverlesscaches - serverlesscachesnapshots @@ -105,6 +106,7 @@ rules: - cacheclusters/status - cacheparametergroups/status - cachesubnetgroups/status + - globalreplicationgroups/status - replicationgroups/status - serverlesscaches/status - serverlesscachesnapshots/status diff --git a/helm/templates/role-reader.yaml b/helm/templates/role-reader.yaml index acc0827..e09c77f 100644 --- a/helm/templates/role-reader.yaml +++ b/helm/templates/role-reader.yaml @@ -19,6 +19,7 @@ rules: - cacheclusters - cacheparametergroups - cachesubnetgroups + - globalreplicationgroups - replicationgroups - serverlesscaches - serverlesscachesnapshots diff --git a/helm/templates/role-writer.yaml b/helm/templates/role-writer.yaml index 5e8f19b..6ab5058 100644 --- a/helm/templates/role-writer.yaml +++ b/helm/templates/role-writer.yaml @@ -19,6 +19,7 @@ rules: - cacheclusters - cacheparametergroups - cachesubnetgroups + - globalreplicationgroups - replicationgroups - serverlesscaches - serverlesscachesnapshots @@ -39,6 +40,7 @@ rules: - cacheclusters - cacheparametergroups - cachesubnetgroups + - globalreplicationgroups - replicationgroups - serverlesscaches - serverlesscachesnapshots diff --git a/helm/values.yaml b/helm/values.yaml index df7e8a9..7089426 100644 --- a/helm/values.yaml +++ b/helm/values.yaml @@ -148,6 +148,7 @@ reconcile: - CacheCluster - CacheParameterGroup - CacheSubnetGroup + - GlobalReplicationGroup - ReplicationGroup - ServerlessCache - ServerlessCacheSnapshot diff --git a/main b/main new file mode 100755 index 0000000..3fd533f Binary files /dev/null and b/main differ diff --git a/pkg/resource/global_replication_group/delta.go b/pkg/resource/global_replication_group/delta.go new file mode 100644 index 0000000..b10d8b3 --- /dev/null +++ b/pkg/resource/global_replication_group/delta.go @@ -0,0 +1,72 @@ +// 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 global_replication_group + +import ( + "bytes" + "reflect" + + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" + acktags "github.com/aws-controllers-k8s/runtime/pkg/tags" +) + +// Hack to avoid import errors during build... +var ( + _ = &bytes.Buffer{} + _ = &reflect.Method{} + _ = &acktags.Tags{} +) + +// 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.GlobalReplicationGroupDescription, b.ko.Spec.GlobalReplicationGroupDescription) { + delta.Add("Spec.GlobalReplicationGroupDescription", a.ko.Spec.GlobalReplicationGroupDescription, b.ko.Spec.GlobalReplicationGroupDescription) + } else if a.ko.Spec.GlobalReplicationGroupDescription != nil && b.ko.Spec.GlobalReplicationGroupDescription != nil { + if *a.ko.Spec.GlobalReplicationGroupDescription != *b.ko.Spec.GlobalReplicationGroupDescription { + delta.Add("Spec.GlobalReplicationGroupDescription", a.ko.Spec.GlobalReplicationGroupDescription, b.ko.Spec.GlobalReplicationGroupDescription) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.GlobalReplicationGroupIDSuffix, b.ko.Spec.GlobalReplicationGroupIDSuffix) { + delta.Add("Spec.GlobalReplicationGroupIDSuffix", a.ko.Spec.GlobalReplicationGroupIDSuffix, b.ko.Spec.GlobalReplicationGroupIDSuffix) + } else if a.ko.Spec.GlobalReplicationGroupIDSuffix != nil && b.ko.Spec.GlobalReplicationGroupIDSuffix != nil { + if *a.ko.Spec.GlobalReplicationGroupIDSuffix != *b.ko.Spec.GlobalReplicationGroupIDSuffix { + delta.Add("Spec.GlobalReplicationGroupIDSuffix", a.ko.Spec.GlobalReplicationGroupIDSuffix, b.ko.Spec.GlobalReplicationGroupIDSuffix) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.PrimaryReplicationGroupID, b.ko.Spec.PrimaryReplicationGroupID) { + delta.Add("Spec.PrimaryReplicationGroupID", a.ko.Spec.PrimaryReplicationGroupID, b.ko.Spec.PrimaryReplicationGroupID) + } else if a.ko.Spec.PrimaryReplicationGroupID != nil && b.ko.Spec.PrimaryReplicationGroupID != nil { + if *a.ko.Spec.PrimaryReplicationGroupID != *b.ko.Spec.PrimaryReplicationGroupID { + delta.Add("Spec.PrimaryReplicationGroupID", a.ko.Spec.PrimaryReplicationGroupID, b.ko.Spec.PrimaryReplicationGroupID) + } + } + if !reflect.DeepEqual(a.ko.Spec.PrimaryReplicationGroupRef, b.ko.Spec.PrimaryReplicationGroupRef) { + delta.Add("Spec.PrimaryReplicationGroupRef", a.ko.Spec.PrimaryReplicationGroupRef, b.ko.Spec.PrimaryReplicationGroupRef) + } + + return delta +} diff --git a/pkg/resource/global_replication_group/descriptor.go b/pkg/resource/global_replication_group/descriptor.go new file mode 100644 index 0000000..5d28e5d --- /dev/null +++ b/pkg/resource/global_replication_group/descriptor.go @@ -0,0 +1,155 @@ +// 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 global_replication_group + +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" + "k8s.io/apimachinery/pkg/runtime/schema" + rtclient "sigs.k8s.io/controller-runtime/pkg/client" + k8sctrlutil "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" + + svcapitypes "github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1" +) + +const ( + FinalizerString = "finalizers.elasticache.services.k8s.aws/GlobalReplicationGroup" +) + +var ( + GroupVersionResource = svcapitypes.GroupVersion.WithResource("globalreplicationgroups") + GroupKind = metav1.GroupKind{ + Group: "elasticache.services.k8s.aws", + Kind: "GlobalReplicationGroup", + } +) + +// resourceDescriptor implements the +// `aws-service-operator-k8s/pkg/types.AWSResourceDescriptor` interface +type resourceDescriptor struct { +} + +// GroupVersionKind returns a Kubernetes schema.GroupVersionKind struct that +// describes the API Group, Version and Kind of CRs described by the descriptor +func (d *resourceDescriptor) GroupVersionKind() schema.GroupVersionKind { + return svcapitypes.GroupVersion.WithKind(GroupKind.Kind) +} + +// EmptyRuntimeObject returns an empty object prototype that may be used in +// apimachinery and k8s client operations +func (d *resourceDescriptor) EmptyRuntimeObject() rtclient.Object { + return &svcapitypes.GlobalReplicationGroup{} +} + +// ResourceFromRuntimeObject returns an AWSResource that has been initialized +// with the supplied runtime.Object +func (d *resourceDescriptor) ResourceFromRuntimeObject( + obj rtclient.Object, +) acktypes.AWSResource { + return &resource{ + ko: obj.(*svcapitypes.GlobalReplicationGroup), + } +} + +// 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.RuntimeObject() + 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 rtclient.Object, 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.RuntimeObject() + 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.RuntimeObject() + 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.RuntimeObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeObject 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/global_replication_group/hooks.go b/pkg/resource/global_replication_group/hooks.go new file mode 100644 index 0000000..dbab844 --- /dev/null +++ b/pkg/resource/global_replication_group/hooks.go @@ -0,0 +1,38 @@ +// 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 global_replication_group + +import ( + "context" + + svcapitypes "github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1" + "github.com/aws-controllers-k8s/elasticache-controller/pkg/util" +) + +// getTags retrieves the resource's associated tags. +func (rm *resourceManager) getTags( + ctx context.Context, + resourceARN string, +) ([]*svcapitypes.Tag, error) { + return util.GetTags(ctx, rm.sdkapi, rm.metrics, resourceARN) +} + +// syncTags keeps the resource's tags in sync. +func (rm *resourceManager) syncTags( + ctx context.Context, + desired *resource, + latest *resource, +) (err error) { + return util.SyncTags(ctx, desired.ko.Spec.Tags, latest.ko.Spec.Tags, latest.ko.Status.ACKResourceMetadata, util.ConvertToOrderedACKTags, rm.sdkapi, rm.metrics) +} diff --git a/pkg/resource/global_replication_group/identifiers.go b/pkg/resource/global_replication_group/identifiers.go new file mode 100644 index 0000000..25b42e4 --- /dev/null +++ b/pkg/resource/global_replication_group/identifiers.go @@ -0,0 +1,55 @@ +// 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 global_replication_group + +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 +} + +// Region returns the AWS region in which the resource exists, or +// nil if this information is not known. +func (ri *resourceIdentifiers) Region() *ackv1alpha1.AWSRegion { + if ri.meta != nil { + return ri.meta.Region + } + return nil +} diff --git a/pkg/resource/global_replication_group/manager.go b/pkg/resource/global_replication_group/manager.go new file mode 100644 index 0000000..1e69008 --- /dev/null +++ b/pkg/resource/global_replication_group/manager.go @@ -0,0 +1,376 @@ +// 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 global_replication_group + +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" + ackrt "github.com/aws-controllers-k8s/runtime/pkg/runtime" + ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" + acktags "github.com/aws-controllers-k8s/runtime/pkg/tags" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + ackutil "github.com/aws-controllers-k8s/runtime/pkg/util" + "github.com/aws/aws-sdk-go-v2/aws" + svcsdk "github.com/aws/aws-sdk-go-v2/service/elasticache" + "github.com/go-logr/logr" + corev1 "k8s.io/api/core/v1" + + svcapitypes "github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1" +) + +var ( + _ = ackutil.InStrings + _ = acktags.NewTags() + _ = ackrt.MissingImageTagValue + _ = svcapitypes.GlobalReplicationGroup{} +) + +// +kubebuilder:rbac:groups=elasticache.services.k8s.aws,resources=globalreplicationgroups,verbs=get;list;watch;create;update;patch;delete +// +kubebuilder:rbac:groups=elasticache.services.k8s.aws,resources=globalreplicationgroups/status,verbs=get;update;patch + +var lateInitializeFieldNames = []string{} + +// 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 + // clientcfg is a copy of the client configuration passed on start of the + // service controller + clientcfg aws.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 + // sdk is a pointer to the AWS service API client exposed by the + // aws-sdk-go-v2/services/{alias} package. + sdkapi *svcsdk.Client +} + +// 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) + mirrorAWSTags(r, observed) + 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 { + if created != nil { + return rm.onError(created, err) + } + 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 { + if updated != nil { + return rm.onError(updated, err) + } + 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:elasticache:%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) + ackcondition.SetSynced(latestCopy, corev1.ConditionFalse, nil, nil) + 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) + ackcondition.SetSynced(lateInitializedRes, corev1.ConditionFalse, nil, nil) + 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 { + 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 { + return latest +} + +// IsSynced returns true if the resource is synced. +func (rm *resourceManager) IsSynced(ctx context.Context, res acktypes.AWSResource) (bool, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's IsSynced() method received resource with nil CR object") + } + + return true, nil +} + +// EnsureTags ensures that tags are present inside the AWSResource. +// If the AWSResource does not have any existing resource tags, the 'tags' +// field is initialized and the controller tags are added. +// If the AWSResource has existing resource tags, then controller tags are +// added to the existing resource tags without overriding them. +// If the AWSResource does not support tags, only then the controller tags +// will not be added to the AWSResource. +func (rm *resourceManager) EnsureTags( + ctx context.Context, + res acktypes.AWSResource, + md acktypes.ServiceControllerMetadata, +) error { + + return nil +} + +// FilterAWSTags ignores tags that have keys that start with "aws:" +// is needed to ensure the controller does not attempt to remove +// tags set by AWS. This function needs to be called after each Read +// operation. +// Eg. resources created with cloudformation have tags that cannot be +// removed by an ACK controller +func (rm *resourceManager) FilterSystemTags(res acktypes.AWSResource) { + +} + +// mirrorAWSTags ensures that AWS tags are included in the desired resource +// if they are present in the latest resource. This will ensure that the +// aws tags are not present in a diff. The logic of the controller will +// ensure these tags aren't patched to the resource in the cluster, and +// will only be present to make sure we don't try to remove these tags. +// +// Although there are a lot of similarities between this function and +// EnsureTags, they are very much different. +// While EnsureTags tries to make sure the resource contains the controller +// tags, mirrowAWSTags tries to make sure tags injected by AWS are mirrored +// from the latest resoruce to the desired resource. +func mirrorAWSTags(a *resource, b *resource) { + +} + +// newResourceManager returns a new struct implementing +// acktypes.AWSResourceManager +// This is for AWS-SDK-GO-V2 - Created newResourceManager With AWS sdk-Go-ClientV2 +func newResourceManager( + cfg ackcfg.Config, + clientcfg aws.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, +) (*resourceManager, error) { + return &resourceManager{ + cfg: cfg, + clientcfg: clientcfg, + log: log, + metrics: metrics, + rr: rr, + awsAccountID: id, + awsRegion: region, + sdkapi: svcsdk.NewFromConfig(clientcfg), + }, 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/global_replication_group/manager_factory.go b/pkg/resource/global_replication_group/manager_factory.go new file mode 100644 index 0000000..bcdf549 --- /dev/null +++ b/pkg/resource/global_replication_group/manager_factory.go @@ -0,0 +1,100 @@ +// 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 global_replication_group + +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-v2/aws" + "github.com/go-logr/logr" + + svcresource "github.com/aws-controllers-k8s/elasticache-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, + clientcfg aws.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, + roleARN ackv1alpha1.AWSResourceName, +) (acktypes.AWSResourceManager, error) { + // We use the account ID, region, and role ARN to uniquely identify a + // resource manager. This helps us to avoid creating multiple resource + // managers for the same account/region/roleARN combination. + rmId := fmt.Sprintf("%s/%s/%s", id, region, roleARN) + f.RLock() + rm, found := f.rmCache[rmId] + f.RUnlock() + + if found { + return rm, nil + } + + f.Lock() + defer f.Unlock() + + rm, err := newResourceManager(cfg, clientcfg, log, metrics, rr, 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/global_replication_group/references.go b/pkg/resource/global_replication_group/references.go new file mode 100644 index 0000000..b5363c7 --- /dev/null +++ b/pkg/resource/global_replication_group/references.go @@ -0,0 +1,166 @@ +// 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 global_replication_group + +import ( + "context" + "fmt" + + corev1 "k8s.io/api/core/v1" + "k8s.io/apimachinery/pkg/types" + "sigs.k8s.io/controller-runtime/pkg/client" + + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackerr "github.com/aws-controllers-k8s/runtime/pkg/errors" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + + svcapitypes "github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1" +) + +// ClearResolvedReferences removes any reference values that were made +// concrete in the spec. It returns a copy of the input AWSResource which +// contains the original *Ref values, but none of their respective concrete +// values. +func (rm *resourceManager) ClearResolvedReferences(res acktypes.AWSResource) acktypes.AWSResource { + ko := rm.concreteResource(res).ko.DeepCopy() + + if ko.Spec.PrimaryReplicationGroupRef != nil { + ko.Spec.PrimaryReplicationGroupID = nil + } + + return &resource{ko} +} + +// ResolveReferences finds if there are any Reference field(s) present +// inside AWSResource passed in the parameter and attempts to resolve those +// reference field(s) into their respective target field(s). It returns a +// copy of the input AWSResource with resolved reference(s), a boolean which +// is set to true if the resource contains any references (regardless of if +// they are resolved successfully) and an error if the passed AWSResource's +// reference field(s) could not be resolved. +func (rm *resourceManager) ResolveReferences( + ctx context.Context, + apiReader client.Reader, + res acktypes.AWSResource, +) (acktypes.AWSResource, bool, error) { + ko := rm.concreteResource(res).ko + + resourceHasReferences := false + err := validateReferenceFields(ko) + if fieldHasReferences, err := rm.resolveReferenceForPrimaryReplicationGroupID(ctx, apiReader, ko); err != nil { + return &resource{ko}, (resourceHasReferences || fieldHasReferences), err + } else { + resourceHasReferences = resourceHasReferences || fieldHasReferences + } + + return &resource{ko}, resourceHasReferences, err +} + +// validateReferenceFields validates the reference field and corresponding +// identifier field. +func validateReferenceFields(ko *svcapitypes.GlobalReplicationGroup) error { + + if ko.Spec.PrimaryReplicationGroupRef != nil && ko.Spec.PrimaryReplicationGroupID != nil { + return ackerr.ResourceReferenceAndIDNotSupportedFor("PrimaryReplicationGroupID", "PrimaryReplicationGroupRef") + } + if ko.Spec.PrimaryReplicationGroupRef == nil && ko.Spec.PrimaryReplicationGroupID == nil { + return ackerr.ResourceReferenceOrIDRequiredFor("PrimaryReplicationGroupID", "PrimaryReplicationGroupRef") + } + return nil +} + +// resolveReferenceForPrimaryReplicationGroupID reads the resource referenced +// from PrimaryReplicationGroupRef field and sets the PrimaryReplicationGroupID +// from referenced resource. Returns a boolean indicating whether a reference +// contains references, or an error +func (rm *resourceManager) resolveReferenceForPrimaryReplicationGroupID( + ctx context.Context, + apiReader client.Reader, + ko *svcapitypes.GlobalReplicationGroup, +) (hasReferences bool, err error) { + if ko.Spec.PrimaryReplicationGroupRef != nil && ko.Spec.PrimaryReplicationGroupRef.From != nil { + hasReferences = true + arr := ko.Spec.PrimaryReplicationGroupRef.From + if arr.Name == nil || *arr.Name == "" { + return hasReferences, fmt.Errorf("provided resource reference is nil or empty: PrimaryReplicationGroupRef") + } + namespace := ko.ObjectMeta.GetNamespace() + if arr.Namespace != nil && *arr.Namespace != "" { + namespace = *arr.Namespace + } + obj := &svcapitypes.ReplicationGroup{} + if err := getReferencedResourceState_ReplicationGroup(ctx, apiReader, obj, *arr.Name, namespace); err != nil { + return hasReferences, err + } + ko.Spec.PrimaryReplicationGroupID = (*string)(obj.Spec.ReplicationGroupID) + } + + return hasReferences, nil +} + +// getReferencedResourceState_ReplicationGroup looks up whether a referenced resource +// exists and is in a ACK.ResourceSynced=True state. If the referenced resource does exist and is +// in a Synced state, returns nil, otherwise returns `ackerr.ResourceReferenceTerminalFor` or +// `ResourceReferenceNotSyncedFor` depending on if the resource is in a Terminal state. +func getReferencedResourceState_ReplicationGroup( + ctx context.Context, + apiReader client.Reader, + obj *svcapitypes.ReplicationGroup, + name string, // the Kubernetes name of the referenced resource + namespace string, // the Kubernetes namespace of the referenced resource +) error { + namespacedName := types.NamespacedName{ + Namespace: namespace, + Name: name, + } + err := apiReader.Get(ctx, namespacedName, obj) + if err != nil { + return err + } + var refResourceTerminal bool + for _, cond := range obj.Status.Conditions { + if cond.Type == ackv1alpha1.ConditionTypeTerminal && + cond.Status == corev1.ConditionTrue { + return ackerr.ResourceReferenceTerminalFor( + "ReplicationGroup", + namespace, name) + } + } + if refResourceTerminal { + return ackerr.ResourceReferenceTerminalFor( + "ReplicationGroup", + namespace, name) + } + var refResourceSynced bool + for _, cond := range obj.Status.Conditions { + if cond.Type == ackv1alpha1.ConditionTypeResourceSynced && + cond.Status == corev1.ConditionTrue { + refResourceSynced = true + } + } + if !refResourceSynced { + return ackerr.ResourceReferenceNotSyncedFor( + "ReplicationGroup", + namespace, name) + } + if obj.Spec.ReplicationGroupID == nil { + return ackerr.ResourceReferenceMissingTargetFieldFor( + "ReplicationGroup", + namespace, name, + "Spec.ReplicationGroupID") + } + return nil +} diff --git a/pkg/resource/global_replication_group/resource.go b/pkg/resource/global_replication_group/resource.go new file mode 100644 index 0000000..880fbd7 --- /dev/null +++ b/pkg/resource/global_replication_group/resource.go @@ -0,0 +1,113 @@ +// 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 global_replication_group + +import ( + "fmt" + + 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" + rtclient "sigs.k8s.io/controller-runtime/pkg/client" + + svcapitypes "github.com/aws-controllers-k8s/elasticache-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.GlobalReplicationGroup +} + +// 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 timestamp +func (r *resource) IsBeingDeleted() bool { + return !r.ko.DeletionTimestamp.IsZero() +} + +// RuntimeObject returns the Kubernetes apimachinery/runtime representation of +// the AWSResource +func (r *resource) RuntimeObject() rtclient.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() +} + +// 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.Status.GlobalReplicationGroupID = &identifier.NameOrID + + return nil +} + +// PopulateResourceFromAnnotation populates the fields passed from adoption annotation +func (r *resource) PopulateResourceFromAnnotation(fields map[string]string) error { + tmp, ok := fields["globalReplicationGroupID"] + if !ok { + return ackerrors.NewTerminalError(fmt.Errorf("required field missing: globalReplicationGroupID")) + } + r.ko.Status.GlobalReplicationGroupID = &tmp + + 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/global_replication_group/sdk.go b/pkg/resource/global_replication_group/sdk.go new file mode 100644 index 0000000..1f71b02 --- /dev/null +++ b/pkg/resource/global_replication_group/sdk.go @@ -0,0 +1,690 @@ +// 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 global_replication_group + +import ( + "context" + "errors" + "fmt" + "reflect" + "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" + ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue" + ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" + "github.com/aws/aws-sdk-go-v2/aws" + svcsdk "github.com/aws/aws-sdk-go-v2/service/elasticache" + smithy "github.com/aws/smithy-go" + corev1 "k8s.io/api/core/v1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + + svcapitypes "github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1" +) + +// Hack to avoid import errors during build... +var ( + _ = &metav1.Time{} + _ = strings.ToLower("") + _ = &svcsdk.Client{} + _ = &svcapitypes.GlobalReplicationGroup{} + _ = ackv1alpha1.AWSAccountID("") + _ = &ackerr.NotFound + _ = &ackcondition.NotManagedMessage + _ = &reflect.Value{} + _ = fmt.Sprintf("") + _ = &ackrequeue.NoRequeue{} + _ = &aws.Config{} +) + +// 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 func() { + 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.requiredFieldsMissingFromReadManyInput(r) { + return nil, ackerr.NotFound + } + + input, err := rm.newListRequestPayload(r) + if err != nil { + return nil, err + } + var resp *svcsdk.DescribeGlobalReplicationGroupsOutput + resp, err = rm.sdkapi.DescribeGlobalReplicationGroups(ctx, input) + rm.metrics.RecordAPICall("READ_MANY", "DescribeGlobalReplicationGroups", err) + if err != nil { + var awsErr smithy.APIError + if errors.As(err, &awsErr) && awsErr.ErrorCode() == "GlobalReplicationGroupNotFoundFault" { + 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() + + found := false + for _, elem := range resp.GlobalReplicationGroups { + if elem.ARN != nil { + if ko.Status.ACKResourceMetadata == nil { + ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{} + } + tmpARN := ackv1alpha1.AWSResourceName(*elem.ARN) + ko.Status.ACKResourceMetadata.ARN = &tmpARN + } + if elem.AtRestEncryptionEnabled != nil { + ko.Status.AtRestEncryptionEnabled = elem.AtRestEncryptionEnabled + } else { + ko.Status.AtRestEncryptionEnabled = nil + } + if elem.AuthTokenEnabled != nil { + ko.Status.AuthTokenEnabled = elem.AuthTokenEnabled + } else { + ko.Status.AuthTokenEnabled = nil + } + if elem.CacheNodeType != nil { + ko.Status.CacheNodeType = elem.CacheNodeType + } else { + ko.Status.CacheNodeType = nil + } + if elem.ClusterEnabled != nil { + ko.Status.ClusterEnabled = elem.ClusterEnabled + } else { + ko.Status.ClusterEnabled = nil + } + if elem.Engine != nil { + ko.Status.Engine = elem.Engine + } else { + ko.Status.Engine = nil + } + if elem.EngineVersion != nil { + ko.Status.EngineVersion = elem.EngineVersion + } else { + ko.Status.EngineVersion = nil + } + if elem.GlobalNodeGroups != nil { + f7 := []*svcapitypes.GlobalNodeGroup{} + for _, f7iter := range elem.GlobalNodeGroups { + f7elem := &svcapitypes.GlobalNodeGroup{} + if f7iter.GlobalNodeGroupId != nil { + f7elem.GlobalNodeGroupID = f7iter.GlobalNodeGroupId + } + if f7iter.Slots != nil { + f7elem.Slots = f7iter.Slots + } + f7 = append(f7, f7elem) + } + ko.Status.GlobalNodeGroups = f7 + } else { + ko.Status.GlobalNodeGroups = nil + } + if elem.GlobalReplicationGroupDescription != nil { + ko.Spec.GlobalReplicationGroupDescription = elem.GlobalReplicationGroupDescription + } else { + ko.Spec.GlobalReplicationGroupDescription = nil + } + if elem.GlobalReplicationGroupId != nil { + ko.Status.GlobalReplicationGroupID = elem.GlobalReplicationGroupId + } else { + ko.Status.GlobalReplicationGroupID = nil + } + if elem.Members != nil { + f10 := []*svcapitypes.GlobalReplicationGroupMember{} + for _, f10iter := range elem.Members { + f10elem := &svcapitypes.GlobalReplicationGroupMember{} + if f10iter.AutomaticFailover != "" { + f10elem.AutomaticFailover = aws.String(string(f10iter.AutomaticFailover)) + } + if f10iter.ReplicationGroupId != nil { + f10elem.ReplicationGroupID = f10iter.ReplicationGroupId + } + if f10iter.ReplicationGroupRegion != nil { + f10elem.ReplicationGroupRegion = f10iter.ReplicationGroupRegion + } + if f10iter.Role != nil { + f10elem.Role = f10iter.Role + } + if f10iter.Status != nil { + f10elem.Status = f10iter.Status + } + f10 = append(f10, f10elem) + } + ko.Status.Members = f10 + } else { + ko.Status.Members = nil + } + if elem.Status != nil { + ko.Status.Status = elem.Status + } else { + ko.Status.Status = nil + } + if elem.TransitEncryptionEnabled != nil { + ko.Status.TransitEncryptionEnabled = elem.TransitEncryptionEnabled + } else { + ko.Status.TransitEncryptionEnabled = nil + } + found = true + break + } + if !found { + return nil, ackerr.NotFound + } + + rm.setStatusDefaults(ko) + return &resource{ko}, nil +} + +// requiredFieldsMissingFromReadManyInput returns true if there are any fields +// for the ReadMany Input shape that are required but not present in the +// resource's Spec or Status +func (rm *resourceManager) requiredFieldsMissingFromReadManyInput( + r *resource, +) bool { + return r.ko.Status.GlobalReplicationGroupID == nil + +} + +// newListRequestPayload returns SDK-specific struct for the HTTP request +// payload of the List API call for the resource +func (rm *resourceManager) newListRequestPayload( + r *resource, +) (*svcsdk.DescribeGlobalReplicationGroupsInput, error) { + res := &svcsdk.DescribeGlobalReplicationGroupsInput{} + + if r.ko.Status.GlobalReplicationGroupID != nil { + res.GlobalReplicationGroupId = r.ko.Status.GlobalReplicationGroupID + } + + 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 func() { + exit(err) + }() + input, err := rm.newCreateRequestPayload(ctx, desired) + if err != nil { + return nil, err + } + + var resp *svcsdk.CreateGlobalReplicationGroupOutput + _ = resp + resp, err = rm.sdkapi.CreateGlobalReplicationGroup(ctx, input) + rm.metrics.RecordAPICall("CREATE", "CreateGlobalReplicationGroup", 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.GlobalReplicationGroup.ARN != nil { + arn := ackv1alpha1.AWSResourceName(*resp.GlobalReplicationGroup.ARN) + ko.Status.ACKResourceMetadata.ARN = &arn + } + if resp.GlobalReplicationGroup.AtRestEncryptionEnabled != nil { + ko.Status.AtRestEncryptionEnabled = resp.GlobalReplicationGroup.AtRestEncryptionEnabled + } else { + ko.Status.AtRestEncryptionEnabled = nil + } + if resp.GlobalReplicationGroup.AuthTokenEnabled != nil { + ko.Status.AuthTokenEnabled = resp.GlobalReplicationGroup.AuthTokenEnabled + } else { + ko.Status.AuthTokenEnabled = nil + } + if resp.GlobalReplicationGroup.CacheNodeType != nil { + ko.Status.CacheNodeType = resp.GlobalReplicationGroup.CacheNodeType + } else { + ko.Status.CacheNodeType = nil + } + if resp.GlobalReplicationGroup.ClusterEnabled != nil { + ko.Status.ClusterEnabled = resp.GlobalReplicationGroup.ClusterEnabled + } else { + ko.Status.ClusterEnabled = nil + } + if resp.GlobalReplicationGroup.Engine != nil { + ko.Status.Engine = resp.GlobalReplicationGroup.Engine + } else { + ko.Status.Engine = nil + } + if resp.GlobalReplicationGroup.EngineVersion != nil { + ko.Status.EngineVersion = resp.GlobalReplicationGroup.EngineVersion + } else { + ko.Status.EngineVersion = nil + } + if resp.GlobalReplicationGroup.GlobalNodeGroups != nil { + f7 := []*svcapitypes.GlobalNodeGroup{} + for _, f7iter := range resp.GlobalReplicationGroup.GlobalNodeGroups { + f7elem := &svcapitypes.GlobalNodeGroup{} + if f7iter.GlobalNodeGroupId != nil { + f7elem.GlobalNodeGroupID = f7iter.GlobalNodeGroupId + } + if f7iter.Slots != nil { + f7elem.Slots = f7iter.Slots + } + f7 = append(f7, f7elem) + } + ko.Status.GlobalNodeGroups = f7 + } else { + ko.Status.GlobalNodeGroups = nil + } + if resp.GlobalReplicationGroup.GlobalReplicationGroupDescription != nil { + ko.Spec.GlobalReplicationGroupDescription = resp.GlobalReplicationGroup.GlobalReplicationGroupDescription + } else { + ko.Spec.GlobalReplicationGroupDescription = nil + } + if resp.GlobalReplicationGroup.GlobalReplicationGroupId != nil { + ko.Status.GlobalReplicationGroupID = resp.GlobalReplicationGroup.GlobalReplicationGroupId + } else { + ko.Status.GlobalReplicationGroupID = nil + } + if resp.GlobalReplicationGroup.Members != nil { + f10 := []*svcapitypes.GlobalReplicationGroupMember{} + for _, f10iter := range resp.GlobalReplicationGroup.Members { + f10elem := &svcapitypes.GlobalReplicationGroupMember{} + if f10iter.AutomaticFailover != "" { + f10elem.AutomaticFailover = aws.String(string(f10iter.AutomaticFailover)) + } + if f10iter.ReplicationGroupId != nil { + f10elem.ReplicationGroupID = f10iter.ReplicationGroupId + } + if f10iter.ReplicationGroupRegion != nil { + f10elem.ReplicationGroupRegion = f10iter.ReplicationGroupRegion + } + if f10iter.Role != nil { + f10elem.Role = f10iter.Role + } + if f10iter.Status != nil { + f10elem.Status = f10iter.Status + } + f10 = append(f10, f10elem) + } + ko.Status.Members = f10 + } else { + ko.Status.Members = nil + } + if resp.GlobalReplicationGroup.Status != nil { + ko.Status.Status = resp.GlobalReplicationGroup.Status + } else { + ko.Status.Status = nil + } + if resp.GlobalReplicationGroup.TransitEncryptionEnabled != nil { + ko.Status.TransitEncryptionEnabled = resp.GlobalReplicationGroup.TransitEncryptionEnabled + } else { + ko.Status.TransitEncryptionEnabled = nil + } + + 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.CreateGlobalReplicationGroupInput, error) { + res := &svcsdk.CreateGlobalReplicationGroupInput{} + + if r.ko.Spec.GlobalReplicationGroupDescription != nil { + res.GlobalReplicationGroupDescription = r.ko.Spec.GlobalReplicationGroupDescription + } + if r.ko.Spec.GlobalReplicationGroupIDSuffix != nil { + res.GlobalReplicationGroupIdSuffix = r.ko.Spec.GlobalReplicationGroupIDSuffix + } + if r.ko.Spec.PrimaryReplicationGroupID != nil { + res.PrimaryReplicationGroupId = r.ko.Spec.PrimaryReplicationGroupID + } + + 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, +) (updated *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkUpdate") + defer func() { + exit(err) + }() + input, err := rm.newUpdateRequestPayload(ctx, desired, delta) + if err != nil { + return nil, err + } + + var resp *svcsdk.ModifyGlobalReplicationGroupOutput + _ = resp + resp, err = rm.sdkapi.ModifyGlobalReplicationGroup(ctx, input) + rm.metrics.RecordAPICall("UPDATE", "ModifyGlobalReplicationGroup", 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.GlobalReplicationGroup.ARN != nil { + arn := ackv1alpha1.AWSResourceName(*resp.GlobalReplicationGroup.ARN) + ko.Status.ACKResourceMetadata.ARN = &arn + } + if resp.GlobalReplicationGroup.AtRestEncryptionEnabled != nil { + ko.Status.AtRestEncryptionEnabled = resp.GlobalReplicationGroup.AtRestEncryptionEnabled + } else { + ko.Status.AtRestEncryptionEnabled = nil + } + if resp.GlobalReplicationGroup.AuthTokenEnabled != nil { + ko.Status.AuthTokenEnabled = resp.GlobalReplicationGroup.AuthTokenEnabled + } else { + ko.Status.AuthTokenEnabled = nil + } + if resp.GlobalReplicationGroup.CacheNodeType != nil { + ko.Status.CacheNodeType = resp.GlobalReplicationGroup.CacheNodeType + } else { + ko.Status.CacheNodeType = nil + } + if resp.GlobalReplicationGroup.ClusterEnabled != nil { + ko.Status.ClusterEnabled = resp.GlobalReplicationGroup.ClusterEnabled + } else { + ko.Status.ClusterEnabled = nil + } + if resp.GlobalReplicationGroup.Engine != nil { + ko.Status.Engine = resp.GlobalReplicationGroup.Engine + } else { + ko.Status.Engine = nil + } + if resp.GlobalReplicationGroup.EngineVersion != nil { + ko.Status.EngineVersion = resp.GlobalReplicationGroup.EngineVersion + } else { + ko.Status.EngineVersion = nil + } + if resp.GlobalReplicationGroup.GlobalNodeGroups != nil { + f7 := []*svcapitypes.GlobalNodeGroup{} + for _, f7iter := range resp.GlobalReplicationGroup.GlobalNodeGroups { + f7elem := &svcapitypes.GlobalNodeGroup{} + if f7iter.GlobalNodeGroupId != nil { + f7elem.GlobalNodeGroupID = f7iter.GlobalNodeGroupId + } + if f7iter.Slots != nil { + f7elem.Slots = f7iter.Slots + } + f7 = append(f7, f7elem) + } + ko.Status.GlobalNodeGroups = f7 + } else { + ko.Status.GlobalNodeGroups = nil + } + if resp.GlobalReplicationGroup.GlobalReplicationGroupDescription != nil { + ko.Spec.GlobalReplicationGroupDescription = resp.GlobalReplicationGroup.GlobalReplicationGroupDescription + } else { + ko.Spec.GlobalReplicationGroupDescription = nil + } + if resp.GlobalReplicationGroup.GlobalReplicationGroupId != nil { + ko.Status.GlobalReplicationGroupID = resp.GlobalReplicationGroup.GlobalReplicationGroupId + } else { + ko.Status.GlobalReplicationGroupID = nil + } + if resp.GlobalReplicationGroup.Members != nil { + f10 := []*svcapitypes.GlobalReplicationGroupMember{} + for _, f10iter := range resp.GlobalReplicationGroup.Members { + f10elem := &svcapitypes.GlobalReplicationGroupMember{} + if f10iter.AutomaticFailover != "" { + f10elem.AutomaticFailover = aws.String(string(f10iter.AutomaticFailover)) + } + if f10iter.ReplicationGroupId != nil { + f10elem.ReplicationGroupID = f10iter.ReplicationGroupId + } + if f10iter.ReplicationGroupRegion != nil { + f10elem.ReplicationGroupRegion = f10iter.ReplicationGroupRegion + } + if f10iter.Role != nil { + f10elem.Role = f10iter.Role + } + if f10iter.Status != nil { + f10elem.Status = f10iter.Status + } + f10 = append(f10, f10elem) + } + ko.Status.Members = f10 + } else { + ko.Status.Members = nil + } + if resp.GlobalReplicationGroup.Status != nil { + ko.Status.Status = resp.GlobalReplicationGroup.Status + } else { + ko.Status.Status = nil + } + if resp.GlobalReplicationGroup.TransitEncryptionEnabled != nil { + ko.Status.TransitEncryptionEnabled = resp.GlobalReplicationGroup.TransitEncryptionEnabled + } else { + ko.Status.TransitEncryptionEnabled = nil + } + + rm.setStatusDefaults(ko) + return &resource{ko}, nil +} + +// newUpdateRequestPayload returns an SDK-specific struct for the HTTP request +// payload of the Update API call for the resource +func (rm *resourceManager) newUpdateRequestPayload( + ctx context.Context, + r *resource, + delta *ackcompare.Delta, +) (*svcsdk.ModifyGlobalReplicationGroupInput, error) { + res := &svcsdk.ModifyGlobalReplicationGroupInput{} + + res.ApplyImmediately = aws.Bool(true) + if r.ko.Status.CacheNodeType != nil { + res.CacheNodeType = r.ko.Status.CacheNodeType + } + if r.ko.Status.Engine != nil { + res.Engine = r.ko.Status.Engine + } + if r.ko.Status.EngineVersion != nil { + res.EngineVersion = r.ko.Status.EngineVersion + } + if r.ko.Spec.GlobalReplicationGroupDescription != nil { + res.GlobalReplicationGroupDescription = r.ko.Spec.GlobalReplicationGroupDescription + } + if r.ko.Status.GlobalReplicationGroupID != nil { + res.GlobalReplicationGroupId = r.ko.Status.GlobalReplicationGroupID + } + + return res, nil +} + +// 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 func() { + exit(err) + }() + input, err := rm.newDeleteRequestPayload(r) + if err != nil { + return nil, err + } + var resp *svcsdk.DeleteGlobalReplicationGroupOutput + _ = resp + resp, err = rm.sdkapi.DeleteGlobalReplicationGroup(ctx, input) + rm.metrics.RecordAPICall("DELETE", "DeleteGlobalReplicationGroup", err) + 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.DeleteGlobalReplicationGroupInput, error) { + res := &svcsdk.DeleteGlobalReplicationGroupInput{} + + if r.ko.Status.GlobalReplicationGroupID != nil { + res.GlobalReplicationGroupId = r.ko.Status.GlobalReplicationGroupID + } + + return res, nil +} + +// setStatusDefaults sets default properties into supplied custom resource +func (rm *resourceManager) setStatusDefaults( + ko *svcapitypes.GlobalReplicationGroup, +) { + if ko.Status.ACKResourceMetadata == nil { + ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{} + } + if ko.Status.ACKResourceMetadata.Region == nil { + ko.Status.ACKResourceMetadata.Region = &rm.awsRegion + } + 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 + } + } + var termError *ackerr.TerminalError + if rm.terminalAWSError(err) || err == ackerr.SecretTypeNotSupported || err == ackerr.SecretNotFound || errors.As(err, &termError) { + 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 || errors.As(err, &termError) { + 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 + } + + var terminalErr smithy.APIError + if !errors.As(err, &terminalErr) { + return false + } + switch terminalErr.ErrorCode() { + case "GlobalReplicationGroupAlreadyExistsFault", + "InvalidParameterValueException", + "InvalidGlobalReplicationGroupStateFault", + "ServiceLinkedRoleNotFoundFault": + return true + default: + return false + } +} diff --git a/pkg/resource/global_replication_group/tags.go b/pkg/resource/global_replication_group/tags.go new file mode 100644 index 0000000..4f11544 --- /dev/null +++ b/pkg/resource/global_replication_group/tags.go @@ -0,0 +1,119 @@ +// 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 global_replication_group + +import ( + "slices" + "strings" + + acktags "github.com/aws-controllers-k8s/runtime/pkg/tags" + + svcapitypes "github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1" +) + +var ( + _ = svcapitypes.GlobalReplicationGroup{} + _ = acktags.NewTags() + ACKSystemTags = []string{"services.k8s.aws/namespace", "services.k8s.aws/controller-version"} +) + +// convertToOrderedACKTags converts the tags parameter into 'acktags.Tags' shape. +// This method helps in creating the hub(acktags.Tags) for merging +// default controller tags with existing resource tags. It also returns a slice +// of keys maintaining the original key Order when the tags are a list +func convertToOrderedACKTags(tags []*svcapitypes.Tag) (acktags.Tags, []string) { + result := acktags.NewTags() + keyOrder := []string{} + + if len(tags) == 0 { + return result, keyOrder + } + for _, t := range tags { + if t.Key != nil { + keyOrder = append(keyOrder, *t.Key) + if t.Value != nil { + result[*t.Key] = *t.Value + } else { + result[*t.Key] = "" + } + } + } + + return result, keyOrder +} + +// fromACKTags converts the tags parameter into []*svcapitypes.Tag shape. +// This method helps in setting the tags back inside AWSResource after merging +// default controller tags with existing resource tags. When a list, +// it maintains the order from original +func fromACKTags(tags acktags.Tags, keyOrder []string) []*svcapitypes.Tag { + result := []*svcapitypes.Tag{} + + for _, k := range keyOrder { + v, ok := tags[k] + if ok { + tag := svcapitypes.Tag{Key: &k, Value: &v} + result = append(result, &tag) + delete(tags, k) + } + } + for k, v := range tags { + tag := svcapitypes.Tag{Key: &k, Value: &v} + result = append(result, &tag) + } + + return result +} + +// ignoreSystemTags ignores tags that have keys that start with "aws:" +// and ACKSystemTags, to avoid patching them to the resourceSpec. +// Eg. resources created with cloudformation have tags that cannot be +// removed by an ACK controller +func ignoreSystemTags(tags acktags.Tags) { + for k := range tags { + if strings.HasPrefix(k, "aws:") || + slices.Contains(ACKSystemTags, k) { + delete(tags, k) + } + } +} + +// syncAWSTags ensures AWS-managed tags (prefixed with "aws:") from the latest resource state +// are preserved in the desired state. This prevents the controller from attempting to +// modify AWS-managed tags, which would result in an error. +// +// AWS-managed tags are automatically added by AWS services (e.g., CloudFormation, Service Catalog) +// and cannot be modified or deleted through normal tag operations. Common examples include: +// - aws:cloudformation:stack-name +// - aws:servicecatalog:productArn +// +// Parameters: +// - a: The target Tags map to be updated (typically desired state) +// - b: The source Tags map containing AWS-managed tags (typically latest state) +// +// Example: +// +// latest := Tags{"aws:cloudformation:stack-name": "my-stack", "environment": "prod"} +// desired := Tags{"environment": "dev"} +// SyncAWSTags(desired, latest) +// desired now contains {"aws:cloudformation:stack-name": "my-stack", "environment": "dev"} +func syncAWSTags(a acktags.Tags, b acktags.Tags) { + for k := range b { + if strings.HasPrefix(k, "aws:") { + a[k] = b[k] + } + } +} diff --git a/pkg/resource/serverless_cache/sdk.go b/pkg/resource/serverless_cache/sdk.go index d05f84b..0dda8a0 100644 --- a/pkg/resource/serverless_cache/sdk.go +++ b/pkg/resource/serverless_cache/sdk.go @@ -237,9 +237,10 @@ func (rm *resourceManager) sdkFind( // Retrieve the tags for the resource resourceARN := string(*ko.Status.ACKResourceMetadata.ARN) tags, err := rm.getTags(ctx, resourceARN) - if err == nil { - ko.Spec.Tags = tags + if err != nil { + return nil, err } + ko.Spec.Tags = tags } return &resource{ko}, nil } diff --git a/pkg/util/tags.go b/pkg/util/tags.go index ae81352..e89d409 100644 --- a/pkg/util/tags.go +++ b/pkg/util/tags.go @@ -61,6 +61,25 @@ func GetTags( return tags, nil } +// ConvertToOrderedACKTags converts a list of Tag objects to a map of key/value pairs +// and a slice of keys in the order they appeared in the original list +func ConvertToOrderedACKTags( + tags []*svcapitypes.Tag, +) (acktags.Tags, []string) { + if len(tags) == 0 { + return acktags.Tags{}, []string{} + } + res := acktags.Tags{} + order := []string{} + for _, t := range tags { + if t.Key != nil && t.Value != nil { + res[*t.Key] = *t.Value + order = append(order, *t.Key) + } + } + return res, order +} + // SyncTags keeps the resource's tags in sync // // NOTE(jaypipes): Elasticache's Tagging APIs differ from other AWS APIs in the diff --git a/templates/hooks/serverless_cache/sdk_read_many_post_set_output.go.tpl b/templates/hooks/serverless_cache/sdk_read_many_post_set_output.go.tpl index e05a001..97a7e75 100644 --- a/templates/hooks/serverless_cache/sdk_read_many_post_set_output.go.tpl +++ b/templates/hooks/serverless_cache/sdk_read_many_post_set_output.go.tpl @@ -3,7 +3,8 @@ if ko.Status.ACKResourceMetadata != nil && ko.Status.ACKResourceMetadata.ARN != // Retrieve the tags for the resource resourceARN := string(*ko.Status.ACKResourceMetadata.ARN) tags, err := rm.getTags(ctx, resourceARN) - if err == nil { - ko.Spec.Tags = tags + if err != nil { + return nil, err } + ko.Spec.Tags = tags } \ No newline at end of file