diff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml index c6342dfa..51a63d76 100755 --- a/apis/v1alpha1/ack-generate-metadata.yaml +++ b/apis/v1alpha1/ack-generate-metadata.yaml @@ -1,13 +1,13 @@ ack_generate_info: - build_date: "2021-10-27T21:06:25Z" - build_hash: d2b063806d25cfcae4f2d4eb44f8e3f713b23e8e - go_version: go1.15 + build_date: "2021-11-08T20:16:44Z" + build_hash: 6ce1a672eabd3908bdaa4ace356e1b58ee3e80ba + go_version: go1.17 version: v0.15.2 -api_directory_checksum: c42ae0549361b86a2d5c112b556b6a715ee976ab +api_directory_checksum: 231335e65c729f31ac368b1483a38c2964b3219a api_version: v1alpha1 aws_sdk_go_version: v1.37.10 generator_config_info: - file_checksum: ed3e48785dc25e784dee76fa7b20248fdc1a170d + file_checksum: 438c2600566029a9ab883076d641246f0a8fbb88 original_file_name: generator.yaml last_modification: reason: API generation diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml index 3636e11c..46e2c362 100644 --- a/apis/v1alpha1/generator.yaml +++ b/apis/v1alpha1/generator.yaml @@ -3,12 +3,15 @@ ignore: - ModifyTransitGateway - ModifyVpcEndpoint field_paths: - - CreateVpcEndpointInput.DryRun - - CreateVpcInput.DryRun - - CreateSubnetInput.DryRun - - CreateRouteTableInput.DryRun - CreateInternetGatewayInput.DryRun + - CreateRouteTableInput.DryRun + - CreateSecurityGroupInput.DryRun + - CreateSubnetInput.DryRun - CreateTransitGatewayInput.DryRun + - CreateVpcInput.DryRun + - CreateVpcEndpointInput.DryRun + # support EC2-VPC only + - DeleteSecurityGroupInput.GroupName resource_names: - AccountAttribute - CapacityReservation @@ -41,7 +44,7 @@ ignore: - ReservedInstancesListing #- RouteTable - Route - - SecurityGroup + #- SecurityGroup - Snapshot - SpotDatafeedSubscription #- Subnet @@ -78,12 +81,39 @@ operations: resource_name: VpcEndpoint resources: - Subnet: + RouteTable: exceptions: terminal_codes: - InvalidVpcID.Malformed - InvalidVpcID.NotFound - RouteTable: + SecurityGroup: + fields: + # support EC2-VPC only + Id: + is_primary_key: true + VpcId: + is_required: true + renames: + operations: + CreateSecurityGroup: + input_fields: + GroupName: Name + output_fields: + GroupId: Id + DeleteSecurityGroup: + input_fields: + GroupId: Id + GroupName: Name + DescribeSecurityGroups: + input_fields: + GroupIds: Ids + GroupNames: Names + exceptions: + terminal_codes: + - InvalidVpcID.Malformed + - InvalidVpcID.NotFound + - VPCIdNotSpecified + Subnet: exceptions: terminal_codes: - InvalidVpcID.Malformed diff --git a/apis/v1alpha1/security_group.go b/apis/v1alpha1/security_group.go new file mode 100644 index 00000000..f36c890f --- /dev/null +++ b/apis/v1alpha1/security_group.go @@ -0,0 +1,93 @@ +// 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" +) + +// SecurityGroupSpec defines the desired state of SecurityGroup. +// +// Describes a security group +type SecurityGroupSpec struct { + // A description for the security group. This is informational only. + // + // Constraints: Up to 255 characters in length + // + // Constraints for EC2-Classic: ASCII characters + // + // Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* + // +kubebuilder:validation:Required + Description *string `json:"description"` + // The name of the security group. + // + // Constraints: Up to 255 characters in length. Cannot start with sg-. + // + // Constraints for EC2-Classic: ASCII characters + // + // Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* + // +kubebuilder:validation:Required + Name *string `json:"name"` + // The tags to assign to the security group. + TagSpecifications []*TagSpecification `json:"tagSpecifications,omitempty"` + // [EC2-VPC] The ID of the VPC. Required for EC2-VPC. + // +kubebuilder:validation:Required + VPCID *string `json:"vpcID"` +} + +// SecurityGroupStatus defines the observed state of SecurityGroup +type SecurityGroupStatus struct { + // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member + // that is used to contain resource sync state, account ownership, + // constructed ARN for the resource + // +kubebuilder:validation:Optional + ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` + // All CRS managed by ACK have a common `Status.Conditions` member that + // contains a collection of `ackv1alpha1.Condition` objects that describe + // the various terminal states of the CR and its backend AWS service API + // resource + // +kubebuilder:validation:Optional + Conditions []*ackv1alpha1.Condition `json:"conditions"` + // The ID of the security group. + // +kubebuilder:validation:Optional + ID *string `json:"id,omitempty"` + // The tags assigned to the security group. + // +kubebuilder:validation:Optional + Tags []*Tag `json:"tags,omitempty"` +} + +// SecurityGroup is the Schema for the SecurityGroups API +// +kubebuilder:object:root=true +// +kubebuilder:subresource:status +type SecurityGroup struct { + metav1.TypeMeta `json:",inline"` + metav1.ObjectMeta `json:"metadata,omitempty"` + Spec SecurityGroupSpec `json:"spec,omitempty"` + Status SecurityGroupStatus `json:"status,omitempty"` +} + +// SecurityGroupList contains a list of SecurityGroup +// +kubebuilder:object:root=true +type SecurityGroupList struct { + metav1.TypeMeta `json:",inline"` + metav1.ListMeta `json:"metadata,omitempty"` + Items []SecurityGroup `json:"items"` +} + +func init() { + SchemeBuilder.Register(&SecurityGroup{}, &SecurityGroupList{}) +} diff --git a/apis/v1alpha1/types.go b/apis/v1alpha1/types.go index 84f39363..e45f97a7 100644 --- a/apis/v1alpha1/types.go +++ b/apis/v1alpha1/types.go @@ -1114,9 +1114,13 @@ type IKEVersionsRequestListValue struct { // Describes a set of permissions for a security group rule. type IPPermission struct { - FromPort *int64 `json:"fromPort,omitempty"` - IPProtocol *string `json:"ipProtocol,omitempty"` - ToPort *int64 `json:"toPort,omitempty"` + FromPort *int64 `json:"fromPort,omitempty"` + IPProtocol *string `json:"ipProtocol,omitempty"` + IPRanges []*IPRange `json:"ipRanges,omitempty"` + IPv6Ranges []*IPv6Range `json:"ipv6Ranges,omitempty"` + PrefixListIDs []*PrefixListID `json:"prefixListIDs,omitempty"` + ToPort *int64 `json:"toPort,omitempty"` + UserIDGroupPairs []*UserIDGroupPair `json:"userIDGroupPairs,omitempty"` } // Describes an IPv4 range. @@ -1605,17 +1609,18 @@ type LaunchTemplateInstanceMetadataOptionsRequest struct { // Describes a network interface. type LaunchTemplateInstanceNetworkInterfaceSpecification struct { - AssociateCarrierIPAddress *bool `json:"associateCarrierIPAddress,omitempty"` - AssociatePublicIPAddress *bool `json:"associatePublicIPAddress,omitempty"` - DeleteOnTermination *bool `json:"deleteOnTermination,omitempty"` - Description *string `json:"description,omitempty"` - DeviceIndex *int64 `json:"deviceIndex,omitempty"` - InterfaceType *string `json:"interfaceType,omitempty"` - IPv6AddressCount *int64 `json:"ipv6AddressCount,omitempty"` - NetworkCardIndex *int64 `json:"networkCardIndex,omitempty"` - PrivateIPAddress *string `json:"privateIPAddress,omitempty"` - SecondaryPrivateIPAddressCount *int64 `json:"secondaryPrivateIPAddressCount,omitempty"` - SubnetID *string `json:"subnetID,omitempty"` + AssociateCarrierIPAddress *bool `json:"associateCarrierIPAddress,omitempty"` + AssociatePublicIPAddress *bool `json:"associatePublicIPAddress,omitempty"` + DeleteOnTermination *bool `json:"deleteOnTermination,omitempty"` + Description *string `json:"description,omitempty"` + DeviceIndex *int64 `json:"deviceIndex,omitempty"` + Groups []*string `json:"groups,omitempty"` + InterfaceType *string `json:"interfaceType,omitempty"` + IPv6AddressCount *int64 `json:"ipv6AddressCount,omitempty"` + NetworkCardIndex *int64 `json:"networkCardIndex,omitempty"` + PrivateIPAddress *string `json:"privateIPAddress,omitempty"` + SecondaryPrivateIPAddressCount *int64 `json:"secondaryPrivateIPAddressCount,omitempty"` + SubnetID *string `json:"subnetID,omitempty"` } // The parameters for a network interface. @@ -2576,16 +2581,6 @@ type ScheduledInstancesPrivateIPAddressConfig struct { PrivateIPAddress *string `json:"privateIPAddress,omitempty"` } -// Describes a security group -type SecurityGroup struct { - Description *string `json:"description,omitempty"` - GroupID *string `json:"groupID,omitempty"` - GroupName *string `json:"groupName,omitempty"` - OwnerID *string `json:"ownerID,omitempty"` - Tags []*Tag `json:"tags,omitempty"` - VPCID *string `json:"vpcID,omitempty"` -} - // Describes a security group. type SecurityGroupIdentifier struct { GroupID *string `json:"groupID,omitempty"` @@ -2599,6 +2594,18 @@ type SecurityGroupReference struct { VPCPeeringConnectionID *string `json:"vpcPeeringConnectionID,omitempty"` } +// Describes a security group +type SecurityGroup_SDK struct { + Description *string `json:"description,omitempty"` + GroupID *string `json:"groupID,omitempty"` + GroupName *string `json:"groupName,omitempty"` + IPPermissions []*IPPermission `json:"ipPermissions,omitempty"` + IPPermissionsEgress []*IPPermission `json:"ipPermissionsEgress,omitempty"` + OwnerID *string `json:"ownerID,omitempty"` + Tags []*Tag `json:"tags,omitempty"` + VPCID *string `json:"vpcID,omitempty"` +} + // Describes a service configuration for a VPC endpoint service. type ServiceConfiguration struct { AcceptanceRequired *bool `json:"acceptanceRequired,omitempty"` diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go index 8011b60d..265a2f8c 100644 --- a/apis/v1alpha1/zz_generated.deepcopy.go +++ b/apis/v1alpha1/zz_generated.deepcopy.go @@ -1,3 +1,4 @@ +//go:build !ignore_autogenerated // +build !ignore_autogenerated // Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. @@ -4536,11 +4537,55 @@ func (in *IPPermission) DeepCopyInto(out *IPPermission) { *out = new(string) **out = **in } + if in.IPRanges != nil { + in, out := &in.IPRanges, &out.IPRanges + *out = make([]*IPRange, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(IPRange) + (*in).DeepCopyInto(*out) + } + } + } + if in.IPv6Ranges != nil { + in, out := &in.IPv6Ranges, &out.IPv6Ranges + *out = make([]*IPv6Range, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(IPv6Range) + (*in).DeepCopyInto(*out) + } + } + } + if in.PrefixListIDs != nil { + in, out := &in.PrefixListIDs, &out.PrefixListIDs + *out = make([]*PrefixListID, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(PrefixListID) + (*in).DeepCopyInto(*out) + } + } + } if in.ToPort != nil { in, out := &in.ToPort, &out.ToPort *out = new(int64) **out = **in } + if in.UserIDGroupPairs != nil { + in, out := &in.UserIDGroupPairs, &out.UserIDGroupPairs + *out = make([]*UserIDGroupPair, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(UserIDGroupPair) + (*in).DeepCopyInto(*out) + } + } + } } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPPermission. @@ -6816,6 +6861,17 @@ func (in *LaunchTemplateInstanceNetworkInterfaceSpecification) DeepCopyInto(out *out = new(int64) **out = **in } + if in.Groups != nil { + in, out := &in.Groups, &out.Groups + *out = make([]*string, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(string) + **out = **in + } + } + } if in.InterfaceType != nil { in, out := &in.InterfaceType, &out.InterfaceType *out = new(string) @@ -11236,11 +11292,33 @@ func (in *ScheduledInstancesPrivateIPAddressConfig) DeepCopy() *ScheduledInstanc // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *SecurityGroup) DeepCopyInto(out *SecurityGroup) { *out = *in - if in.Description != nil { - in, out := &in.Description, &out.Description - *out = new(string) - **out = **in + out.TypeMeta = in.TypeMeta + in.ObjectMeta.DeepCopyInto(&out.ObjectMeta) + in.Spec.DeepCopyInto(&out.Spec) + in.Status.DeepCopyInto(&out.Status) +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroup. +func (in *SecurityGroup) DeepCopy() *SecurityGroup { + if in == nil { + return nil + } + out := new(SecurityGroup) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *SecurityGroup) 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 *SecurityGroupIdentifier) DeepCopyInto(out *SecurityGroupIdentifier) { + *out = *in if in.GroupID != nil { in, out := &in.GroupID, &out.GroupID *out = new(string) @@ -11251,18 +11329,100 @@ func (in *SecurityGroup) DeepCopyInto(out *SecurityGroup) { *out = new(string) **out = **in } - if in.OwnerID != nil { - in, out := &in.OwnerID, &out.OwnerID +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroupIdentifier. +func (in *SecurityGroupIdentifier) DeepCopy() *SecurityGroupIdentifier { + if in == nil { + return nil + } + out := new(SecurityGroupIdentifier) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *SecurityGroupList) DeepCopyInto(out *SecurityGroupList) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ListMeta.DeepCopyInto(&out.ListMeta) + if in.Items != nil { + in, out := &in.Items, &out.Items + *out = make([]SecurityGroup, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroupList. +func (in *SecurityGroupList) DeepCopy() *SecurityGroupList { + if in == nil { + return nil + } + out := new(SecurityGroupList) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *SecurityGroupList) 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 *SecurityGroupReference) DeepCopyInto(out *SecurityGroupReference) { + *out = *in + if in.GroupID != nil { + in, out := &in.GroupID, &out.GroupID *out = new(string) **out = **in } - if in.Tags != nil { - in, out := &in.Tags, &out.Tags - *out = make([]*Tag, len(*in)) + if in.ReferencingVPCID != nil { + in, out := &in.ReferencingVPCID, &out.ReferencingVPCID + *out = new(string) + **out = **in + } + if in.VPCPeeringConnectionID != nil { + in, out := &in.VPCPeeringConnectionID, &out.VPCPeeringConnectionID + *out = new(string) + **out = **in + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroupReference. +func (in *SecurityGroupReference) DeepCopy() *SecurityGroupReference { + if in == nil { + return nil + } + out := new(SecurityGroupReference) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *SecurityGroupSpec) DeepCopyInto(out *SecurityGroupSpec) { + *out = *in + if in.Description != nil { + in, out := &in.Description, &out.Description + *out = new(string) + **out = **in + } + if in.Name != nil { + in, out := &in.Name, &out.Name + *out = new(string) + **out = **in + } + if in.TagSpecifications != nil { + in, out := &in.TagSpecifications, &out.TagSpecifications + *out = make([]*TagSpecification, len(*in)) for i := range *in { if (*in)[i] != nil { in, out := &(*in)[i], &(*out)[i] - *out = new(Tag) + *out = new(TagSpecification) (*in).DeepCopyInto(*out) } } @@ -11274,67 +11434,132 @@ func (in *SecurityGroup) DeepCopyInto(out *SecurityGroup) { } } -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroup. -func (in *SecurityGroup) DeepCopy() *SecurityGroup { +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroupSpec. +func (in *SecurityGroupSpec) DeepCopy() *SecurityGroupSpec { if in == nil { return nil } - out := new(SecurityGroup) + out := new(SecurityGroupSpec) in.DeepCopyInto(out) return out } // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *SecurityGroupIdentifier) DeepCopyInto(out *SecurityGroupIdentifier) { +func (in *SecurityGroupStatus) DeepCopyInto(out *SecurityGroupStatus) { *out = *in - if in.GroupID != nil { - in, out := &in.GroupID, &out.GroupID - *out = new(string) - **out = **in + if in.ACKResourceMetadata != nil { + in, out := &in.ACKResourceMetadata, &out.ACKResourceMetadata + *out = new(corev1alpha1.ResourceMetadata) + (*in).DeepCopyInto(*out) } - if in.GroupName != nil { - in, out := &in.GroupName, &out.GroupName + 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.ID != nil { + in, out := &in.ID, &out.ID *out = new(string) **out = **in } + if in.Tags != nil { + in, out := &in.Tags, &out.Tags + *out = make([]*Tag, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(Tag) + (*in).DeepCopyInto(*out) + } + } + } } -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroupIdentifier. -func (in *SecurityGroupIdentifier) DeepCopy() *SecurityGroupIdentifier { +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroupStatus. +func (in *SecurityGroupStatus) DeepCopy() *SecurityGroupStatus { if in == nil { return nil } - out := new(SecurityGroupIdentifier) + out := new(SecurityGroupStatus) in.DeepCopyInto(out) return out } // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *SecurityGroupReference) DeepCopyInto(out *SecurityGroupReference) { +func (in *SecurityGroup_SDK) DeepCopyInto(out *SecurityGroup_SDK) { *out = *in + if in.Description != nil { + in, out := &in.Description, &out.Description + *out = new(string) + **out = **in + } if in.GroupID != nil { in, out := &in.GroupID, &out.GroupID *out = new(string) **out = **in } - if in.ReferencingVPCID != nil { - in, out := &in.ReferencingVPCID, &out.ReferencingVPCID + if in.GroupName != nil { + in, out := &in.GroupName, &out.GroupName *out = new(string) **out = **in } - if in.VPCPeeringConnectionID != nil { - in, out := &in.VPCPeeringConnectionID, &out.VPCPeeringConnectionID + if in.IPPermissions != nil { + in, out := &in.IPPermissions, &out.IPPermissions + *out = make([]*IPPermission, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(IPPermission) + (*in).DeepCopyInto(*out) + } + } + } + if in.IPPermissionsEgress != nil { + in, out := &in.IPPermissionsEgress, &out.IPPermissionsEgress + *out = make([]*IPPermission, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(IPPermission) + (*in).DeepCopyInto(*out) + } + } + } + if in.OwnerID != nil { + in, out := &in.OwnerID, &out.OwnerID + *out = new(string) + **out = **in + } + if in.Tags != nil { + in, out := &in.Tags, &out.Tags + *out = make([]*Tag, len(*in)) + for i := range *in { + if (*in)[i] != nil { + in, out := &(*in)[i], &(*out)[i] + *out = new(Tag) + (*in).DeepCopyInto(*out) + } + } + } + if in.VPCID != nil { + in, out := &in.VPCID, &out.VPCID *out = new(string) **out = **in } } -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroupReference. -func (in *SecurityGroupReference) DeepCopy() *SecurityGroupReference { +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroup_SDK. +func (in *SecurityGroup_SDK) DeepCopy() *SecurityGroup_SDK { if in == nil { return nil } - out := new(SecurityGroupReference) + out := new(SecurityGroup_SDK) in.DeepCopyInto(out) return out } diff --git a/cmd/controller/main.go b/cmd/controller/main.go index 93297977..03a4f702 100644 --- a/cmd/controller/main.go +++ b/cmd/controller/main.go @@ -35,6 +35,7 @@ import ( _ "github.com/aws-controllers-k8s/ec2-controller/pkg/resource/internet_gateway" _ "github.com/aws-controllers-k8s/ec2-controller/pkg/resource/route_table" + _ "github.com/aws-controllers-k8s/ec2-controller/pkg/resource/security_group" _ "github.com/aws-controllers-k8s/ec2-controller/pkg/resource/subnet" _ "github.com/aws-controllers-k8s/ec2-controller/pkg/resource/transit_gateway" _ "github.com/aws-controllers-k8s/ec2-controller/pkg/resource/vpc" diff --git a/config/crd/bases/ec2.services.k8s.aws_securitygroups.yaml b/config/crd/bases/ec2.services.k8s.aws_securitygroups.yaml new file mode 100644 index 00000000..97bd4286 --- /dev/null +++ b/config/crd/bases/ec2.services.k8s.aws_securitygroups.yaml @@ -0,0 +1,164 @@ + +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.7.0 + creationTimestamp: null + name: securitygroups.ec2.services.k8s.aws +spec: + group: ec2.services.k8s.aws + names: + kind: SecurityGroup + listKind: SecurityGroupList + plural: securitygroups + singular: securitygroup + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: SecurityGroup is the Schema for the SecurityGroups 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: "SecurityGroupSpec defines the desired state of SecurityGroup. + \n Describes a security group" + properties: + description: + description: "A description for the security group. This is informational + only. \n Constraints: Up to 255 characters in length \n Constraints + for EC2-Classic: ASCII characters \n Constraints for EC2-VPC: a-z, + A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*" + type: string + name: + description: "The name of the security group. \n Constraints: Up to + 255 characters in length. Cannot start with sg-. \n Constraints + for EC2-Classic: ASCII characters \n Constraints for EC2-VPC: a-z, + A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*" + type: string + tagSpecifications: + description: The tags to assign to the security group. + items: + description: The tags to apply to a resource when the resource is + being created. + properties: + resourceType: + type: string + tags: + items: + description: Describes a tag. + properties: + key: + type: string + value: + type: string + type: object + type: array + type: object + type: array + vpcID: + description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.' + type: string + required: + - description + - name + - vpcID + type: object + status: + description: SecurityGroupStatus defines the observed state of SecurityGroup + properties: + ackResourceMetadata: + description: All CRs managed by ACK have a common `Status.ACKResourceMetadata` + member that is used to contain resource sync state, account ownership, + constructed ARN for the resource + properties: + arn: + description: 'ARN is the Amazon Resource Name for the resource. + This is a globally-unique identifier and is set only by the + ACK service controller once the controller has orchestrated + the creation of the resource OR when it has verified that an + "adopted" resource (a resource where the ARN annotation was + set by the Kubernetes user on the CR) exists and matches the + supplied CR''s Spec field values. TODO(vijat@): Find a better + strategy for resources that do not have ARN in CreateOutputResponse + https://github.com/aws/aws-controllers-k8s/issues/270' + type: string + ownerAccountID: + description: OwnerAccountID is the AWS Account ID of the account + that owns the backend AWS service API resource. + type: string + required: + - ownerAccountID + type: object + conditions: + description: All CRS managed by ACK have a common `Status.Conditions` + member that contains a collection of `ackv1alpha1.Condition` objects + that describe the various terminal states of the CR and its backend + AWS service API resource + items: + description: Condition is the common struct used by all CRDs managed + by ACK service controllers to indicate terminal states of the + CR and its backend AWS service API resource + properties: + lastTransitionTime: + description: Last time the condition transitioned from one status + to another. + format: date-time + type: string + message: + description: A human readable message indicating details about + the transition. + type: string + reason: + description: The reason for the condition's last transition. + type: string + status: + description: Status of the condition, one of True, False, Unknown. + type: string + type: + description: Type is the type of the Condition + type: string + required: + - status + - type + type: object + type: array + id: + description: The ID of the security group. + type: string + tags: + description: The tags assigned to the security group. + items: + description: Describes a tag. + properties: + key: + type: string + value: + type: string + type: object + type: array + type: object + type: object + served: true + storage: true + subresources: + status: {} +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml index 51dcfe86..a79d3613 100644 --- a/config/crd/kustomization.yaml +++ b/config/crd/kustomization.yaml @@ -5,6 +5,7 @@ bases: resources: - bases/ec2.services.k8s.aws_internetgateways.yaml - bases/ec2.services.k8s.aws_routetables.yaml + - bases/ec2.services.k8s.aws_securitygroups.yaml - bases/ec2.services.k8s.aws_subnets.yaml - bases/ec2.services.k8s.aws_transitgateways.yaml - bases/ec2.services.k8s.aws_vpcs.yaml diff --git a/config/rbac/cluster-role-controller.yaml b/config/rbac/cluster-role-controller.yaml index 7d8d3eb4..7facd78d 100644 --- a/config/rbac/cluster-role-controller.yaml +++ b/config/rbac/cluster-role-controller.yaml @@ -62,6 +62,26 @@ rules: - get - patch - update +- apiGroups: + - ec2.services.k8s.aws + resources: + - securitygroups + verbs: + - create + - delete + - get + - list + - patch + - update + - watch +- apiGroups: + - ec2.services.k8s.aws + resources: + - securitygroups/status + verbs: + - get + - patch + - update - apiGroups: - ec2.services.k8s.aws resources: diff --git a/config/rbac/role-reader.yaml b/config/rbac/role-reader.yaml index 0c944ed4..b39412ee 100644 --- a/config/rbac/role-reader.yaml +++ b/config/rbac/role-reader.yaml @@ -11,6 +11,7 @@ rules: resources: - internetgateways - routetables + - securitygroups - subnets - transitgateways - vpcs diff --git a/config/rbac/role-writer.yaml b/config/rbac/role-writer.yaml index 4718e584..eda07d85 100644 --- a/config/rbac/role-writer.yaml +++ b/config/rbac/role-writer.yaml @@ -11,6 +11,7 @@ rules: resources: - internetgateways - routetables + - securitygroups - subnets - transitgateways - vpcs @@ -28,6 +29,7 @@ rules: resources: - internetgateways - routetables + - securitygroups - subnets - transitgateways - vpcs diff --git a/generator.yaml b/generator.yaml index 3636e11c..46e2c362 100644 --- a/generator.yaml +++ b/generator.yaml @@ -3,12 +3,15 @@ ignore: - ModifyTransitGateway - ModifyVpcEndpoint field_paths: - - CreateVpcEndpointInput.DryRun - - CreateVpcInput.DryRun - - CreateSubnetInput.DryRun - - CreateRouteTableInput.DryRun - CreateInternetGatewayInput.DryRun + - CreateRouteTableInput.DryRun + - CreateSecurityGroupInput.DryRun + - CreateSubnetInput.DryRun - CreateTransitGatewayInput.DryRun + - CreateVpcInput.DryRun + - CreateVpcEndpointInput.DryRun + # support EC2-VPC only + - DeleteSecurityGroupInput.GroupName resource_names: - AccountAttribute - CapacityReservation @@ -41,7 +44,7 @@ ignore: - ReservedInstancesListing #- RouteTable - Route - - SecurityGroup + #- SecurityGroup - Snapshot - SpotDatafeedSubscription #- Subnet @@ -78,12 +81,39 @@ operations: resource_name: VpcEndpoint resources: - Subnet: + RouteTable: exceptions: terminal_codes: - InvalidVpcID.Malformed - InvalidVpcID.NotFound - RouteTable: + SecurityGroup: + fields: + # support EC2-VPC only + Id: + is_primary_key: true + VpcId: + is_required: true + renames: + operations: + CreateSecurityGroup: + input_fields: + GroupName: Name + output_fields: + GroupId: Id + DeleteSecurityGroup: + input_fields: + GroupId: Id + GroupName: Name + DescribeSecurityGroups: + input_fields: + GroupIds: Ids + GroupNames: Names + exceptions: + terminal_codes: + - InvalidVpcID.Malformed + - InvalidVpcID.NotFound + - VPCIdNotSpecified + Subnet: exceptions: terminal_codes: - InvalidVpcID.Malformed diff --git a/helm/crds/ec2.services.k8s.aws_securitygroups.yaml b/helm/crds/ec2.services.k8s.aws_securitygroups.yaml new file mode 100644 index 00000000..97bd4286 --- /dev/null +++ b/helm/crds/ec2.services.k8s.aws_securitygroups.yaml @@ -0,0 +1,164 @@ + +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.7.0 + creationTimestamp: null + name: securitygroups.ec2.services.k8s.aws +spec: + group: ec2.services.k8s.aws + names: + kind: SecurityGroup + listKind: SecurityGroupList + plural: securitygroups + singular: securitygroup + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: SecurityGroup is the Schema for the SecurityGroups 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: "SecurityGroupSpec defines the desired state of SecurityGroup. + \n Describes a security group" + properties: + description: + description: "A description for the security group. This is informational + only. \n Constraints: Up to 255 characters in length \n Constraints + for EC2-Classic: ASCII characters \n Constraints for EC2-VPC: a-z, + A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*" + type: string + name: + description: "The name of the security group. \n Constraints: Up to + 255 characters in length. Cannot start with sg-. \n Constraints + for EC2-Classic: ASCII characters \n Constraints for EC2-VPC: a-z, + A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*" + type: string + tagSpecifications: + description: The tags to assign to the security group. + items: + description: The tags to apply to a resource when the resource is + being created. + properties: + resourceType: + type: string + tags: + items: + description: Describes a tag. + properties: + key: + type: string + value: + type: string + type: object + type: array + type: object + type: array + vpcID: + description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.' + type: string + required: + - description + - name + - vpcID + type: object + status: + description: SecurityGroupStatus defines the observed state of SecurityGroup + properties: + ackResourceMetadata: + description: All CRs managed by ACK have a common `Status.ACKResourceMetadata` + member that is used to contain resource sync state, account ownership, + constructed ARN for the resource + properties: + arn: + description: 'ARN is the Amazon Resource Name for the resource. + This is a globally-unique identifier and is set only by the + ACK service controller once the controller has orchestrated + the creation of the resource OR when it has verified that an + "adopted" resource (a resource where the ARN annotation was + set by the Kubernetes user on the CR) exists and matches the + supplied CR''s Spec field values. TODO(vijat@): Find a better + strategy for resources that do not have ARN in CreateOutputResponse + https://github.com/aws/aws-controllers-k8s/issues/270' + type: string + ownerAccountID: + description: OwnerAccountID is the AWS Account ID of the account + that owns the backend AWS service API resource. + type: string + required: + - ownerAccountID + type: object + conditions: + description: All CRS managed by ACK have a common `Status.Conditions` + member that contains a collection of `ackv1alpha1.Condition` objects + that describe the various terminal states of the CR and its backend + AWS service API resource + items: + description: Condition is the common struct used by all CRDs managed + by ACK service controllers to indicate terminal states of the + CR and its backend AWS service API resource + properties: + lastTransitionTime: + description: Last time the condition transitioned from one status + to another. + format: date-time + type: string + message: + description: A human readable message indicating details about + the transition. + type: string + reason: + description: The reason for the condition's last transition. + type: string + status: + description: Status of the condition, one of True, False, Unknown. + type: string + type: + description: Type is the type of the Condition + type: string + required: + - status + - type + type: object + type: array + id: + description: The ID of the security group. + type: string + tags: + description: The tags assigned to the security group. + items: + description: Describes a tag. + properties: + key: + type: string + value: + type: string + type: object + type: array + type: object + type: object + served: true + storage: true + subresources: + status: {} +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] diff --git a/helm/templates/cluster-role-controller.yaml b/helm/templates/cluster-role-controller.yaml index bebe2879..810f8fa7 100644 --- a/helm/templates/cluster-role-controller.yaml +++ b/helm/templates/cluster-role-controller.yaml @@ -68,6 +68,26 @@ rules: - get - patch - update +- apiGroups: + - ec2.services.k8s.aws + resources: + - securitygroups + verbs: + - create + - delete + - get + - list + - patch + - update + - watch +- apiGroups: + - ec2.services.k8s.aws + resources: + - securitygroups/status + verbs: + - get + - patch + - update - apiGroups: - ec2.services.k8s.aws resources: diff --git a/helm/templates/role-reader.yaml b/helm/templates/role-reader.yaml index c7ef685c..1770ff53 100644 --- a/helm/templates/role-reader.yaml +++ b/helm/templates/role-reader.yaml @@ -11,6 +11,7 @@ rules: resources: - internetgateways - routetables + - securitygroups - subnets - transitgateways - vpcs diff --git a/helm/templates/role-writer.yaml b/helm/templates/role-writer.yaml index 002d0f38..94a097b6 100644 --- a/helm/templates/role-writer.yaml +++ b/helm/templates/role-writer.yaml @@ -13,6 +13,8 @@ rules: - routetables + - securitygroups + - subnets - transitgateways @@ -34,6 +36,7 @@ rules: resources: - internetgateways - routetables + - securitygroups - subnets - transitgateways - vpcs diff --git a/pkg/resource/security_group/delta.go b/pkg/resource/security_group/delta.go new file mode 100644 index 00000000..7b915bfd --- /dev/null +++ b/pkg/resource/security_group/delta.go @@ -0,0 +1,70 @@ +// 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 security_group + +import ( + "bytes" + "reflect" + + ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare" +) + +// Hack to avoid import errors during build... +var ( + _ = &bytes.Buffer{} + _ = &reflect.Method{} +) + +// newResourceDelta returns a new `ackcompare.Delta` used to compare two +// resources +func newResourceDelta( + a *resource, + b *resource, +) *ackcompare.Delta { + delta := ackcompare.NewDelta() + if (a == nil && b != nil) || + (a != nil && b == nil) { + delta.Add("", a, b) + return delta + } + + if ackcompare.HasNilDifference(a.ko.Spec.Description, b.ko.Spec.Description) { + delta.Add("Spec.Description", a.ko.Spec.Description, b.ko.Spec.Description) + } else if a.ko.Spec.Description != nil && b.ko.Spec.Description != nil { + if *a.ko.Spec.Description != *b.ko.Spec.Description { + delta.Add("Spec.Description", a.ko.Spec.Description, b.ko.Spec.Description) + } + } + if ackcompare.HasNilDifference(a.ko.Spec.Name, b.ko.Spec.Name) { + delta.Add("Spec.Name", a.ko.Spec.Name, b.ko.Spec.Name) + } else if a.ko.Spec.Name != nil && b.ko.Spec.Name != nil { + if *a.ko.Spec.Name != *b.ko.Spec.Name { + delta.Add("Spec.Name", a.ko.Spec.Name, b.ko.Spec.Name) + } + } + if !reflect.DeepEqual(a.ko.Spec.TagSpecifications, b.ko.Spec.TagSpecifications) { + delta.Add("Spec.TagSpecifications", a.ko.Spec.TagSpecifications, b.ko.Spec.TagSpecifications) + } + if ackcompare.HasNilDifference(a.ko.Spec.VPCID, b.ko.Spec.VPCID) { + delta.Add("Spec.VPCID", a.ko.Spec.VPCID, b.ko.Spec.VPCID) + } else if a.ko.Spec.VPCID != nil && b.ko.Spec.VPCID != nil { + if *a.ko.Spec.VPCID != *b.ko.Spec.VPCID { + delta.Add("Spec.VPCID", a.ko.Spec.VPCID, b.ko.Spec.VPCID) + } + } + + return delta +} diff --git a/pkg/resource/security_group/descriptor.go b/pkg/resource/security_group/descriptor.go new file mode 100644 index 00000000..32917b02 --- /dev/null +++ b/pkg/resource/security_group/descriptor.go @@ -0,0 +1,154 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package security_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" + k8sapirt "k8s.io/apimachinery/pkg/runtime" + k8sctrlutil "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" + + svcapitypes "github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1" +) + +const ( + finalizerString = "finalizers.ec2.services.k8s.aws/SecurityGroup" +) + +var ( + GroupVersionResource = svcapitypes.GroupVersion.WithResource("securitygroups") + GroupKind = metav1.GroupKind{ + Group: "ec2.services.k8s.aws", + Kind: "SecurityGroup", + } +) + +// resourceDescriptor implements the +// `aws-service-operator-k8s/pkg/types.AWSResourceDescriptor` interface +type resourceDescriptor struct { +} + +// GroupKind returns a Kubernetes metav1.GroupKind struct that describes the +// API Group and Kind of CRs described by the descriptor +func (d *resourceDescriptor) GroupKind() *metav1.GroupKind { + return &GroupKind +} + +// EmptyRuntimeObject returns an empty object prototype that may be used in +// apimachinery and k8s client operations +func (d *resourceDescriptor) EmptyRuntimeObject() k8sapirt.Object { + return &svcapitypes.SecurityGroup{} +} + +// ResourceFromRuntimeObject returns an AWSResource that has been initialized +// with the supplied runtime.Object +func (d *resourceDescriptor) ResourceFromRuntimeObject( + obj k8sapirt.Object, +) acktypes.AWSResource { + return &resource{ + ko: obj.(*svcapitypes.SecurityGroup), + } +} + +// Delta returns an `ackcompare.Delta` object containing the difference between +// one `AWSResource` and another. +func (d *resourceDescriptor) Delta(a, b acktypes.AWSResource) *ackcompare.Delta { + return newResourceDelta(a.(*resource), b.(*resource)) +} + +// IsManaged returns true if the supplied AWSResource is under the management +// of an ACK service controller. What this means in practice is that the +// underlying custom resource (CR) in the AWSResource has had a +// resource-specific finalizer associated with it. +func (d *resourceDescriptor) IsManaged( + res acktypes.AWSResource, +) bool { + obj := res.RuntimeMetaObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + // Remove use of custom code once + // https://github.com/kubernetes-sigs/controller-runtime/issues/994 is + // fixed. This should be able to be: + // + // return k8sctrlutil.ContainsFinalizer(obj, finalizerString) + return containsFinalizer(obj, finalizerString) +} + +// Remove once https://github.com/kubernetes-sigs/controller-runtime/issues/994 +// is fixed. +func containsFinalizer(obj acktypes.RuntimeMetaObject, finalizer string) bool { + f := obj.GetFinalizers() + for _, e := range f { + if e == finalizer { + return true + } + } + return false +} + +// MarkManaged places the supplied resource under the management of ACK. What +// this typically means is that the resource manager will decorate the +// underlying custom resource (CR) with a finalizer that indicates ACK is +// managing the resource and the underlying CR may not be deleted until ACK is +// finished cleaning up any backend AWS service resources associated with the +// CR. +func (d *resourceDescriptor) MarkManaged( + res acktypes.AWSResource, +) { + obj := res.RuntimeMetaObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + k8sctrlutil.AddFinalizer(obj, finalizerString) +} + +// MarkUnmanaged removes the supplied resource from management by ACK. What +// this typically means is that the resource manager will remove a finalizer +// underlying custom resource (CR) that indicates ACK is managing the resource. +// This will allow the Kubernetes API server to delete the underlying CR. +func (d *resourceDescriptor) MarkUnmanaged( + res acktypes.AWSResource, +) { + obj := res.RuntimeMetaObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + k8sctrlutil.RemoveFinalizer(obj, finalizerString) +} + +// MarkAdopted places descriptors on the custom resource that indicate the +// resource was not created from within ACK. +func (d *resourceDescriptor) MarkAdopted( + res acktypes.AWSResource, +) { + obj := res.RuntimeMetaObject() + if obj == nil { + // Should not happen. If it does, there is a bug in the code + panic("nil RuntimeMetaObject in AWSResource") + } + curr := obj.GetAnnotations() + if curr == nil { + curr = make(map[string]string) + } + curr[ackv1alpha1.AnnotationAdopted] = "true" + obj.SetAnnotations(curr) +} diff --git a/pkg/resource/security_group/identifiers.go b/pkg/resource/security_group/identifiers.go new file mode 100644 index 00000000..13a1e6ed --- /dev/null +++ b/pkg/resource/security_group/identifiers.go @@ -0,0 +1,46 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package security_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 +} diff --git a/pkg/resource/security_group/manager.go b/pkg/resource/security_group/manager.go new file mode 100644 index 00000000..16ff1b08 --- /dev/null +++ b/pkg/resource/security_group/manager.go @@ -0,0 +1,304 @@ +// 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 security_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" + ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/go-logr/logr" + corev1 "k8s.io/api/core/v1" + + svcsdk "github.com/aws/aws-sdk-go/service/ec2" + svcsdkapi "github.com/aws/aws-sdk-go/service/ec2/ec2iface" +) + +// +kubebuilder:rbac:groups=ec2.services.k8s.aws,resources=securitygroups,verbs=get;list;watch;create;update;patch;delete +// +kubebuilder:rbac:groups=ec2.services.k8s.aws,resources=securitygroups/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 + // log refers to the logr.Logger object handling logging for the service + // controller + log logr.Logger + // metrics contains a collection of Prometheus metric objects that the + // service controller and its reconcilers track + metrics *ackmetrics.Metrics + // rr is the Reconciler which can be used for various utility + // functions such as querying for Secret values given a SecretReference + rr acktypes.Reconciler + // awsAccountID is the AWS account identifier that contains the resources + // managed by this resource manager + awsAccountID ackv1alpha1.AWSAccountID + // The AWS Region that this resource manager targets + awsRegion ackv1alpha1.AWSRegion + // sess is the AWS SDK Session object used to communicate with the backend + // AWS service API + sess *session.Session + // sdk is a pointer to the AWS service API interface exposed by the + // aws-sdk-go/services/{alias}/{alias}iface package. + sdkapi svcsdkapi.EC2API +} + +// concreteResource returns a pointer to a resource from the supplied +// generic AWSResource interface +func (rm *resourceManager) concreteResource( + res acktypes.AWSResource, +) *resource { + // cast the generic interface into a pointer type specific to the concrete + // implementing resource type managed by this resource manager + return res.(*resource) +} + +// ReadOne returns the currently-observed state of the supplied AWSResource in +// the backend AWS service API. +func (rm *resourceManager) ReadOne( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's ReadOne() method received resource with nil CR object") + } + observed, err := rm.sdkFind(ctx, r) + if err != nil { + if observed != nil { + return rm.onError(observed, err) + } + return rm.onError(r, err) + } + return rm.onSuccess(observed) +} + +// Create attempts to create the supplied AWSResource in the backend AWS +// service API, returning an AWSResource representing the newly-created +// resource +func (rm *resourceManager) Create( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Create() method received resource with nil CR object") + } + created, err := rm.sdkCreate(ctx, r) + if err != nil { + return rm.onError(r, err) + } + return rm.onSuccess(created) +} + +// Update attempts to mutate the supplied desired AWSResource in the backend AWS +// service API, returning an AWSResource representing the newly-mutated +// resource. +// Note for specialized logic implementers can check to see how the latest +// observed resource differs from the supplied desired state. The +// higher-level reonciler determines whether or not the desired differs +// from the latest observed and decides whether to call the resource +// manager's Update method +func (rm *resourceManager) Update( + ctx context.Context, + resDesired acktypes.AWSResource, + resLatest acktypes.AWSResource, + delta *ackcompare.Delta, +) (acktypes.AWSResource, error) { + desired := rm.concreteResource(resDesired) + latest := rm.concreteResource(resLatest) + if desired.ko == nil || latest.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Update() method received resource with nil CR object") + } + updated, err := rm.sdkUpdate(ctx, desired, latest, delta) + if err != nil { + return rm.onError(latest, err) + } + return rm.onSuccess(updated) +} + +// Delete attempts to destroy the supplied AWSResource in the backend AWS +// service API, returning an AWSResource representing the +// resource being deleted (if delete is asynchronous and takes time) +func (rm *resourceManager) Delete( + ctx context.Context, + res acktypes.AWSResource, +) (acktypes.AWSResource, error) { + r := rm.concreteResource(res) + if r.ko == nil { + // Should never happen... if it does, it's buggy code. + panic("resource manager's Update() method received resource with nil CR object") + } + observed, err := rm.sdkDelete(ctx, r) + if err != nil { + if observed != nil { + return rm.onError(observed, err) + } + return rm.onError(r, err) + } + + return rm.onSuccess(observed) +} + +// ARNFromName returns an AWS Resource Name from a given string name. This +// is useful for constructing ARNs for APIs that require ARNs in their +// GetAttributes operations but all we have (for new CRs at least) is a +// name for the resource +func (rm *resourceManager) ARNFromName(name string) string { + return fmt.Sprintf( + "arn:aws:ec2:%s:%s:%s", + rm.awsRegion, + rm.awsAccountID, + name, + ) +} + +// LateInitialize returns an acktypes.AWSResource after setting the late initialized +// fields from the readOne call. This method will initialize the optional fields +// which were not provided by the k8s user but were defaulted by the AWS service. +// If there are no such fields to be initialized, the returned object is similar to +// object passed in the parameter. +func (rm *resourceManager) LateInitialize( + ctx context.Context, + latest acktypes.AWSResource, +) (acktypes.AWSResource, error) { + rlog := ackrtlog.FromContext(ctx) + // If there are no fields to late initialize, do nothing + if len(lateInitializeFieldNames) == 0 { + rlog.Debug("no late initialization required.") + return latest, nil + } + latestCopy := latest.DeepCopy() + lateInitConditionReason := "" + lateInitConditionMessage := "" + observed, err := rm.ReadOne(ctx, latestCopy) + if err != nil { + lateInitConditionMessage = "Unable to complete Read operation required for late initialization" + lateInitConditionReason = "Late Initialization Failure" + ackcondition.SetLateInitialized(latestCopy, corev1.ConditionFalse, &lateInitConditionMessage, &lateInitConditionReason) + return latestCopy, err + } + lateInitializedRes := rm.lateInitializeFromReadOneOutput(observed, latestCopy) + incompleteInitialization := rm.incompleteLateInitialization(lateInitializedRes) + if incompleteInitialization { + // Add the condition with LateInitialized=False + lateInitConditionMessage = "Late initialization did not complete, requeuing with delay of 5 seconds" + lateInitConditionReason = "Delayed Late Initialization" + ackcondition.SetLateInitialized(lateInitializedRes, corev1.ConditionFalse, &lateInitConditionMessage, &lateInitConditionReason) + return lateInitializedRes, ackrequeue.NeededAfter(nil, time.Duration(5)*time.Second) + } + // Set LateInitialized condition to True + lateInitConditionMessage = "Late initialization successful" + lateInitConditionReason = "Late initialization successful" + ackcondition.SetLateInitialized(lateInitializedRes, corev1.ConditionTrue, &lateInitConditionMessage, &lateInitConditionReason) + return lateInitializedRes, nil +} + +// incompleteLateInitialization return true if there are fields which were supposed to be +// late initialized but are not. If all the fields are late initialized, false is returned +func (rm *resourceManager) incompleteLateInitialization( + res acktypes.AWSResource, +) bool { + 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 +} + +// newResourceManager returns a new struct implementing +// acktypes.AWSResourceManager +func newResourceManager( + cfg ackcfg.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + sess *session.Session, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, +) (*resourceManager, error) { + return &resourceManager{ + cfg: cfg, + log: log, + metrics: metrics, + rr: rr, + awsAccountID: id, + awsRegion: region, + sess: sess, + sdkapi: svcsdk.New(sess), + }, nil +} + +// onError updates resource conditions and returns updated resource +// it returns nil if no condition is updated. +func (rm *resourceManager) onError( + r *resource, + err error, +) (acktypes.AWSResource, error) { + if r == nil { + return nil, err + } + r1, updated := rm.updateConditions(r, false, err) + if !updated { + return r, err + } + for _, condition := range r1.Conditions() { + if condition.Type == ackv1alpha1.ConditionTypeTerminal && + condition.Status == corev1.ConditionTrue { + // resource is in Terminal condition + // return Terminal error + return r1, ackerr.Terminal + } + } + return r1, err +} + +// onSuccess updates resource conditions and returns updated resource +// it returns the supplied resource if no condition is updated. +func (rm *resourceManager) onSuccess( + r *resource, +) (acktypes.AWSResource, error) { + if r == nil { + return nil, nil + } + r1, updated := rm.updateConditions(r, true, nil) + if !updated { + return r, nil + } + return r1, nil +} diff --git a/pkg/resource/security_group/manager_factory.go b/pkg/resource/security_group/manager_factory.go new file mode 100644 index 00000000..29e12429 --- /dev/null +++ b/pkg/resource/security_group/manager_factory.go @@ -0,0 +1,96 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"). You may +// not use this file except in compliance with the License. A copy of the +// License is located at +// +// http://aws.amazon.com/apache2.0/ +// +// or in the "license" file accompanying this file. This file is distributed +// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +// express or implied. See the License for the specific language governing +// permissions and limitations under the License. + +// Code generated by ack-generate. DO NOT EDIT. + +package security_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/aws/session" + "github.com/go-logr/logr" + + svcresource "github.com/aws-controllers-k8s/ec2-controller/pkg/resource" +) + +// resourceManagerFactory produces resourceManager objects. It implements the +// `types.AWSResourceManagerFactory` interface. +type resourceManagerFactory struct { + sync.RWMutex + // rmCache contains resource managers for a particular AWS account ID + rmCache map[string]*resourceManager +} + +// ResourcePrototype returns an AWSResource that resource managers produced by +// this factory will handle +func (f *resourceManagerFactory) ResourceDescriptor() acktypes.AWSResourceDescriptor { + return &resourceDescriptor{} +} + +// ManagerFor returns a resource manager object that can manage resources for a +// supplied AWS account +func (f *resourceManagerFactory) ManagerFor( + cfg ackcfg.Config, + log logr.Logger, + metrics *ackmetrics.Metrics, + rr acktypes.Reconciler, + sess *session.Session, + id ackv1alpha1.AWSAccountID, + region ackv1alpha1.AWSRegion, +) (acktypes.AWSResourceManager, error) { + rmId := fmt.Sprintf("%s/%s", id, region) + f.RLock() + rm, found := f.rmCache[rmId] + f.RUnlock() + + if found { + return rm, nil + } + + f.Lock() + defer f.Unlock() + + rm, err := newResourceManager(cfg, log, metrics, rr, sess, id, region) + if err != nil { + return nil, err + } + f.rmCache[rmId] = rm + return rm, nil +} + +// IsAdoptable returns true if the resource is able to be adopted +func (f *resourceManagerFactory) IsAdoptable() bool { + return true +} + +// RequeueOnSuccessSeconds returns true if the resource should be requeued after specified seconds +// Default is false which means resource will not be requeued after success. +func (f *resourceManagerFactory) RequeueOnSuccessSeconds() int { + return 0 +} + +func newResourceManagerFactory() *resourceManagerFactory { + return &resourceManagerFactory{ + rmCache: map[string]*resourceManager{}, + } +} + +func init() { + svcresource.RegisterManagerFactory(newResourceManagerFactory()) +} diff --git a/pkg/resource/security_group/resource.go b/pkg/resource/security_group/resource.go new file mode 100644 index 00000000..fb0b24c3 --- /dev/null +++ b/pkg/resource/security_group/resource.go @@ -0,0 +1,107 @@ +// 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 security_group + +import ( + ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1" + ackerrors "github.com/aws-controllers-k8s/runtime/pkg/errors" + acktypes "github.com/aws-controllers-k8s/runtime/pkg/types" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + k8srt "k8s.io/apimachinery/pkg/runtime" + + svcapitypes "github.com/aws-controllers-k8s/ec2-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.SecurityGroup +} + +// Identifiers returns an AWSResourceIdentifiers object containing various +// identifying information, including the AWS account ID that owns the +// resource, the resource's AWS Resource Name (ARN) +func (r *resource) Identifiers() acktypes.AWSResourceIdentifiers { + return &resourceIdentifiers{r.ko.Status.ACKResourceMetadata} +} + +// IsBeingDeleted returns true if the Kubernetes resource has a non-zero +// deletion timestemp +func (r *resource) IsBeingDeleted() bool { + return !r.ko.DeletionTimestamp.IsZero() +} + +// RuntimeObject returns the Kubernetes apimachinery/runtime representation of +// the AWSResource +func (r *resource) RuntimeObject() k8srt.Object { + return r.ko +} + +// MetaObject returns the Kubernetes apimachinery/apis/meta/v1.Object +// representation of the AWSResource +func (r *resource) MetaObject() metav1.Object { + return r.ko.GetObjectMeta() +} + +// RuntimeMetaObject returns an object that implements both the Kubernetes +// apimachinery/runtime.Object and the Kubernetes +// apimachinery/apis/meta/v1.Object interfaces +func (r *resource) RuntimeMetaObject() acktypes.RuntimeMetaObject { + return r.ko +} + +// Conditions returns the ACK Conditions collection for the AWSResource +func (r *resource) Conditions() []*ackv1alpha1.Condition { + return r.ko.Status.Conditions +} + +// ReplaceConditions sets the Conditions status field for the resource +func (r *resource) ReplaceConditions(conditions []*ackv1alpha1.Condition) { + r.ko.Status.Conditions = conditions +} + +// SetObjectMeta sets the ObjectMeta field for the resource +func (r *resource) SetObjectMeta(meta metav1.ObjectMeta) { + r.ko.ObjectMeta = meta +} + +// SetStatus will set the Status field for the resource +func (r *resource) SetStatus(desired acktypes.AWSResource) { + r.ko.Status = desired.(*resource).ko.Status +} + +// SetIdentifiers sets the Spec or Status field that is referenced as the unique +// resource identifier +func (r *resource) SetIdentifiers(identifier *ackv1alpha1.AWSIdentifiers) error { + if identifier.NameOrID == "" { + return ackerrors.MissingNameIdentifier + } + r.ko.Status.ID = &identifier.NameOrID + + 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/security_group/sdk.go b/pkg/resource/security_group/sdk.go new file mode 100644 index 00000000..96ea71a6 --- /dev/null +++ b/pkg/resource/security_group/sdk.go @@ -0,0 +1,401 @@ +// 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 security_group + +import ( + "context" + "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" + ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log" + "github.com/aws/aws-sdk-go/aws" + svcsdk "github.com/aws/aws-sdk-go/service/ec2" + corev1 "k8s.io/api/core/v1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + + svcapitypes "github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1" +) + +// Hack to avoid import errors during build... +var ( + _ = &metav1.Time{} + _ = strings.ToLower("") + _ = &aws.JSONValue{} + _ = &svcsdk.EC2{} + _ = &svcapitypes.SecurityGroup{} + _ = ackv1alpha1.AWSAccountID("") + _ = &ackerr.NotFound + _ = &ackcondition.NotManagedMessage + _ = &reflect.Value{} +) + +// sdkFind returns SDK-specific information about a supplied resource +func (rm *resourceManager) sdkFind( + ctx context.Context, + r *resource, +) (latest *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkFind") + defer exit(err) + // If any required fields in the input shape are missing, AWS resource is + // not created yet. Return NotFound here to indicate to callers that the + // resource isn't yet created. + if rm.requiredFieldsMissingFromReadManyInput(r) { + return nil, ackerr.NotFound + } + + input, err := rm.newListRequestPayload(r) + if err != nil { + return nil, err + } + var resp *svcsdk.DescribeSecurityGroupsOutput + resp, err = rm.sdkapi.DescribeSecurityGroupsWithContext(ctx, input) + rm.metrics.RecordAPICall("READ_MANY", "DescribeSecurityGroups", err) + if err != nil { + if awsErr, ok := ackerr.AWSError(err); ok && awsErr.Code() == "UNKNOWN" { + 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.SecurityGroups { + if elem.Description != nil { + ko.Spec.Description = elem.Description + } else { + ko.Spec.Description = nil + } + if elem.Tags != nil { + f6 := []*svcapitypes.Tag{} + for _, f6iter := range elem.Tags { + f6elem := &svcapitypes.Tag{} + if f6iter.Key != nil { + f6elem.Key = f6iter.Key + } + if f6iter.Value != nil { + f6elem.Value = f6iter.Value + } + f6 = append(f6, f6elem) + } + ko.Status.Tags = f6 + } else { + ko.Status.Tags = nil + } + if elem.VpcId != nil { + ko.Spec.VPCID = elem.VpcId + } else { + ko.Spec.VPCID = 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.ID == 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.DescribeSecurityGroupsInput, error) { + res := &svcsdk.DescribeSecurityGroupsInput{} + + if r.ko.Status.ID != nil { + f2 := []*string{} + f2 = append(f2, r.ko.Status.ID) + res.SetGroupIds(f2) + } + + return res, nil +} + +// sdkCreate creates the supplied resource in the backend AWS service API and +// returns a copy of the resource with resource fields (in both Spec and +// Status) filled in with values from the CREATE API operation's Output shape. +func (rm *resourceManager) sdkCreate( + ctx context.Context, + desired *resource, +) (created *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkCreate") + defer exit(err) + input, err := rm.newCreateRequestPayload(ctx, desired) + if err != nil { + return nil, err + } + + var resp *svcsdk.CreateSecurityGroupOutput + _ = resp + resp, err = rm.sdkapi.CreateSecurityGroupWithContext(ctx, input) + rm.metrics.RecordAPICall("CREATE", "CreateSecurityGroup", 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 resp.GroupId != nil { + ko.Status.ID = resp.GroupId + } else { + ko.Status.ID = nil + } + if resp.Tags != nil { + f1 := []*svcapitypes.Tag{} + for _, f1iter := range resp.Tags { + f1elem := &svcapitypes.Tag{} + if f1iter.Key != nil { + f1elem.Key = f1iter.Key + } + if f1iter.Value != nil { + f1elem.Value = f1iter.Value + } + f1 = append(f1, f1elem) + } + ko.Status.Tags = f1 + } else { + ko.Status.Tags = 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.CreateSecurityGroupInput, error) { + res := &svcsdk.CreateSecurityGroupInput{} + + if r.ko.Spec.Description != nil { + res.SetDescription(*r.ko.Spec.Description) + } + if r.ko.Spec.Name != nil { + res.SetGroupName(*r.ko.Spec.Name) + } + if r.ko.Spec.TagSpecifications != nil { + f2 := []*svcsdk.TagSpecification{} + for _, f2iter := range r.ko.Spec.TagSpecifications { + f2elem := &svcsdk.TagSpecification{} + if f2iter.ResourceType != nil { + f2elem.SetResourceType(*f2iter.ResourceType) + } + if f2iter.Tags != nil { + f2elemf1 := []*svcsdk.Tag{} + for _, f2elemf1iter := range f2iter.Tags { + f2elemf1elem := &svcsdk.Tag{} + if f2elemf1iter.Key != nil { + f2elemf1elem.SetKey(*f2elemf1iter.Key) + } + if f2elemf1iter.Value != nil { + f2elemf1elem.SetValue(*f2elemf1iter.Value) + } + f2elemf1 = append(f2elemf1, f2elemf1elem) + } + f2elem.SetTags(f2elemf1) + } + f2 = append(f2, f2elem) + } + res.SetTagSpecifications(f2) + } + if r.ko.Spec.VPCID != nil { + res.SetVpcId(*r.ko.Spec.VPCID) + } + + return res, nil +} + +// sdkUpdate patches the supplied resource in the backend AWS service API and +// returns a new resource with updated fields. +func (rm *resourceManager) sdkUpdate( + ctx context.Context, + desired *resource, + latest *resource, + delta *ackcompare.Delta, +) (*resource, error) { + // TODO(jaypipes): Figure this out... + return nil, ackerr.NotImplemented +} + +// sdkDelete deletes the supplied resource in the backend AWS service API +func (rm *resourceManager) sdkDelete( + ctx context.Context, + r *resource, +) (latest *resource, err error) { + rlog := ackrtlog.FromContext(ctx) + exit := rlog.Trace("rm.sdkDelete") + defer exit(err) + input, err := rm.newDeleteRequestPayload(r) + if err != nil { + return nil, err + } + var resp *svcsdk.DeleteSecurityGroupOutput + _ = resp + resp, err = rm.sdkapi.DeleteSecurityGroupWithContext(ctx, input) + rm.metrics.RecordAPICall("DELETE", "DeleteSecurityGroup", 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.DeleteSecurityGroupInput, error) { + res := &svcsdk.DeleteSecurityGroupInput{} + + if r.ko.Status.ID != nil { + res.SetGroupId(*r.ko.Status.ID) + } + + return res, nil +} + +// setStatusDefaults sets default properties into supplied custom resource +func (rm *resourceManager) setStatusDefaults( + ko *svcapitypes.SecurityGroup, +) { + if ko.Status.ACKResourceMetadata == nil { + ko.Status.ACKResourceMetadata = &ackv1alpha1.ResourceMetadata{} + } + if ko.Status.ACKResourceMetadata.OwnerAccountID == nil { + ko.Status.ACKResourceMetadata.OwnerAccountID = &rm.awsAccountID + } + if ko.Status.Conditions == nil { + ko.Status.Conditions = []*ackv1alpha1.Condition{} + } +} + +// updateConditions returns updated resource, true; if conditions were updated +// else it returns nil, false +func (rm *resourceManager) updateConditions( + r *resource, + onSuccess bool, + err error, +) (*resource, bool) { + ko := r.ko.DeepCopy() + rm.setStatusDefaults(ko) + + // Terminal condition + var terminalCondition *ackv1alpha1.Condition = nil + var recoverableCondition *ackv1alpha1.Condition = nil + var syncCondition *ackv1alpha1.Condition = nil + for _, condition := range ko.Status.Conditions { + if condition.Type == ackv1alpha1.ConditionTypeTerminal { + terminalCondition = condition + } + if condition.Type == ackv1alpha1.ConditionTypeRecoverable { + recoverableCondition = condition + } + if condition.Type == ackv1alpha1.ConditionTypeResourceSynced { + syncCondition = condition + } + } + + if rm.terminalAWSError(err) || err == ackerr.SecretTypeNotSupported || err == ackerr.SecretNotFound { + if terminalCondition == nil { + terminalCondition = &ackv1alpha1.Condition{ + Type: ackv1alpha1.ConditionTypeTerminal, + } + ko.Status.Conditions = append(ko.Status.Conditions, terminalCondition) + } + var errorMessage = "" + if err == ackerr.SecretTypeNotSupported || err == ackerr.SecretNotFound { + errorMessage = err.Error() + } else { + awsErr, _ := ackerr.AWSError(err) + errorMessage = awsErr.Error() + } + terminalCondition.Status = corev1.ConditionTrue + terminalCondition.Message = &errorMessage + } else { + // Clear the terminal condition if no longer present + if terminalCondition != nil { + terminalCondition.Status = corev1.ConditionFalse + terminalCondition.Message = nil + } + // Handling Recoverable Conditions + if err != nil { + if recoverableCondition == nil { + // Add a new Condition containing a non-terminal error + recoverableCondition = &ackv1alpha1.Condition{ + Type: ackv1alpha1.ConditionTypeRecoverable, + } + ko.Status.Conditions = append(ko.Status.Conditions, recoverableCondition) + } + recoverableCondition.Status = corev1.ConditionTrue + awsErr, _ := ackerr.AWSError(err) + errorMessage := err.Error() + if awsErr != nil { + errorMessage = awsErr.Error() + } + recoverableCondition.Message = &errorMessage + } else if recoverableCondition != nil { + recoverableCondition.Status = corev1.ConditionFalse + recoverableCondition.Message = nil + } + } + // Required to avoid the "declared but not used" error in the default case + _ = syncCondition + if terminalCondition != nil || recoverableCondition != nil || syncCondition != nil { + return &resource{ko}, true // updated + } + return nil, false // not updated +} + +// terminalAWSError returns awserr, true; if the supplied error is an aws Error type +// and if the exception indicates that it is a Terminal exception +// 'Terminal' exception are specified in generator configuration +func (rm *resourceManager) terminalAWSError(err error) bool { + if err == nil { + return false + } + awsErr, ok := ackerr.AWSError(err) + if !ok { + return false + } + switch awsErr.Code() { + case "InvalidVpcID.Malformed", + "InvalidVpcID.NotFound", + "VPCIdNotSpecified": + return true + default: + return false + } +} diff --git a/test/e2e/resources/security_group.yaml b/test/e2e/resources/security_group.yaml new file mode 100644 index 00000000..7da32cf8 --- /dev/null +++ b/test/e2e/resources/security_group.yaml @@ -0,0 +1,8 @@ +apiVersion: ec2.services.k8s.aws/v1alpha1 +kind: SecurityGroup +metadata: + name: $SECURITY_GROUP_NAME +spec: + description: $SECURITY_GROUP_DESCRIPTION + name: $SECURITY_GROUP_NAME + vpcID: $VPC_ID \ No newline at end of file diff --git a/test/e2e/tests/test_security_group.py b/test/e2e/tests/test_security_group.py new file mode 100644 index 00000000..d69f08a5 --- /dev/null +++ b/test/e2e/tests/test_security_group.py @@ -0,0 +1,131 @@ +# 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. + +"""Integration tests for the SecurityGroup API. +""" + +import pytest +import time +import logging + +from acktest.resources import random_suffix_name +from acktest.k8s import resource as k8s +from e2e import service_marker, CRD_GROUP, CRD_VERSION, load_ec2_resource +from e2e.replacement_values import REPLACEMENT_VALUES +from e2e.bootstrap_resources import get_bootstrap_resources + +RESOURCE_PLURAL = "securitygroups" + +CREATE_WAIT_AFTER_SECONDS = 10 +DELETE_WAIT_AFTER_SECONDS = 10 + + +def get_security_group(ec2_client, sg_id: str) -> dict: + try: + resp = ec2_client.describe_security_groups( + GroupIds=[sg_id] + ) + except Exception as e: + logging.debug(e) + return None + + if len(resp["SecurityGroups"]) == 0: + return None + return resp["SecurityGroups"][0] + + +def security_group_exists(ec2_client, sg_id: str) -> bool: + return get_security_group(ec2_client, sg_id) is not None + + +@service_marker +@pytest.mark.canary +class TestSecurityGroup: + def test_create_delete(self, ec2_client): + test_resource_values = REPLACEMENT_VALUES.copy() + resource_name = random_suffix_name("security-group-test", 24) + test_vpc = get_bootstrap_resources().SharedTestVPC + vpc_id = test_vpc.vpc_id + + test_resource_values["SECURITY_GROUP_NAME"] = resource_name + test_resource_values["VPC_ID"] = vpc_id + test_resource_values["SECURITY_GROUP_DESCRIPTION"] = "TestSecurityGroup-create-delete" + + # Load Security Group CR + resource_data = load_ec2_resource( + "security_group", + additional_replacements=test_resource_values, + ) + logging.debug(resource_data) + + # Create k8s resource + ref = k8s.CustomResourceReference( + CRD_GROUP, CRD_VERSION, RESOURCE_PLURAL, + resource_name, namespace="default", + ) + k8s.create_custom_resource(ref, resource_data) + cr = k8s.wait_resource_consumed_by_controller(ref) + + assert cr is not None + assert k8s.get_resource_exists(ref) + + resource = k8s.get_resource(ref) + resource_id = resource["status"]["id"] + + time.sleep(CREATE_WAIT_AFTER_SECONDS) + + # Check Security Group exists + assert security_group_exists(ec2_client, resource_id) + + # Delete k8s resource + _, deleted = k8s.delete_custom_resource(ref) + assert deleted is True + + time.sleep(DELETE_WAIT_AFTER_SECONDS) + + # Check Security Group doesn't exist + assert not security_group_exists(ec2_client, resource_id) + + def test_terminal_condition(self): + test_resource_values = REPLACEMENT_VALUES.copy() + resource_name = random_suffix_name("security-group-fail", 24) + + test_resource_values["SECURITY_GROUP_NAME"] = resource_name + test_resource_values["VPC_ID"] = "InvalidVpcId" + test_resource_values["SECURITY_GROUP_DESCRIPTION"] = "TestSecurityGroup-terminal" + + # Load Security Group CR + resource_data = load_ec2_resource( + "security_group", + additional_replacements=test_resource_values, + ) + logging.debug(resource_data) + + # Create k8s resource + ref = k8s.CustomResourceReference( + CRD_GROUP, CRD_VERSION, RESOURCE_PLURAL, + resource_name, namespace="default", + ) + k8s.create_custom_resource(ref, resource_data) + cr = k8s.wait_resource_consumed_by_controller(ref) + + assert cr is not None + assert k8s.get_resource_exists(ref) + + expected_msg = "InvalidVpcID.NotFound: The vpc ID 'InvalidVpcId' does not exist" + terminal_condition = k8s.get_resource_condition(ref, "ACK.Terminal") + # Example condition message: + # InvalidVpcID.NotFound: The vpc ID 'InvalidVpcId' does not exist + # status code: 400, request id: 5801fc80-67cf-465f-8b83-5e02d517d554 + # This check only verifies the error message; the request hash is irrelevant and therefore can be ignored. + assert expected_msg in terminal_condition['message'] \ No newline at end of file