Merge pull request #951 from crossplane/backport-950-to-release-0.21

[Backport release-0.21] Key alias fix
crossplane-contrib · Nov 17, 2021 · bf339b6 · bf339b6
2 parents 892b7a0 + 6410d9e
commit bf339b6
Show file tree

Hide file tree

Showing 12 changed files with 119 additions and 155 deletions.
diff --git a/apis/kms/v1alpha1/zz_alias.go → apis/kms/v1alpha1/alias.go b/apis/kms/v1alpha1/zz_alias.go → apis/kms/v1alpha1/alias.go
@@ -14,7 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Code generated by ack-generate. DO NOT EDIT.
+// NOTE(muvaf): This code ported from ACK-generated code. See details here:
+// https://github.com/crossplane/provider-aws/pull/950#issue-1055573793
 
 package v1alpha1
 
@@ -29,16 +30,35 @@ type AliasParameters struct {
 	// Region is which region the Alias will be created.
 	// +kubebuilder:validation:Required
 	Region string `json:"region"`
-	// Specifies the alias name. This value must begin with alias/ followed by a
-	// name, such as alias/ExampleAlias.
+
+	// Associates the alias with the specified customer managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk).
+	// The CMK must be in the same AWS Region.
 	//
-	// The AliasName value must be string of 1-256 characters. It can contain only
-	// alphanumeric characters, forward slashes (/), underscores (_), and dashes
-	// (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is
-	// reserved for AWS managed CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
-	// +kubebuilder:validation:Required
-	AliasName             *string `json:"aliasName"`
-	CustomAliasParameters `json:",inline"`
+	// A valid CMK ID is required. If you supply a null or empty string value, this
+	// operation returns an error.
+	//
+	// For help finding the key ID and ARN, see Finding the Key ID and ARN (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn)
+	// in the AWS Key Management Service Developer Guide.
+	//
+	// Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
+	//
+	// For example:
+	//
+	//    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
+	//
+	//    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
+	//
+	// To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
+	// +crossplane:generate:reference:type=Key
+	TargetKeyID *string `json:"targetKeyId,omitempty"`
+
+	// TargetKeyIDRef is a reference to a KMS Key used to set TargetKeyID.
+	// +optional
+	TargetKeyIDRef *xpv1.Reference `json:"targetKeyIdRef,omitempty"`
+
+	// TargetKeyIDSelector selects a reference to a KMS Key used to set TargetKeyID.
+	// +optional
+	TargetKeyIDSelector *xpv1.Selector `json:"targetKeyIdSelector,omitempty"`
 }
 
 // AliasSpec defines the desired state of Alias

diff --git a/apis/kms/v1alpha1/custom_types.go b/apis/kms/v1alpha1/custom_types.go
@@ -1,7 +1,5 @@
 package v1alpha1
 
-import xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
-
 // CustomKeyParameters are custom parameters for Key.
 type CustomKeyParameters struct {
 	// Specifies whether the CMK is enabled.
@@ -10,18 +8,3 @@ type CustomKeyParameters struct {
 	// Specifies how many days the Key is retained when scheduled for deletion. Defaults to 30 days.
 	PendingWindowInDays *int64 `json:"pendingWindowInDays,omitempty"`
 }
-
-// CustomAliasParameters are custom parameters for Alias.
-type CustomAliasParameters struct {
-	// Associates the alias with the specified customer managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The CMK must be in the same AWS Region. \n A valid CMK ID is required. If you supply a null or empty string value, this operation returns an error. \n For help finding the key ID and ARN, see Finding the Key ID and ARN (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the AWS Key Management Service Developer Guide. \n Specify the key ID or the Amazon Resource Name (ARN) of the CMK. \n For example: \n    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab \n    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab \n To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
-	// +optional
-	TargetKeyID *string `json:"targetKeyID,omitempty"`
-
-	// TargetKeyIDRef is a reference to a KMS Key used to set TargetKeyID.
-	// +optional
-	TargetKeyIDRef *xpv1.Reference `json:"targetKeyIDRef,omitempty"`
-
-	// TargetKeyIDSelector selects a reference to a KMS Key used to set TargetKeyID.
-	// +optional
-	TargetKeyIDSelector *xpv1.Selector `json:"targetKeyIDSelector,omitempty"`
-}
diff --git a/apis/kms/v1alpha1/generator-config.yaml b/apis/kms/v1alpha1/generator-config.yaml
@@ -2,8 +2,7 @@ ignore:
   resource_names:
     - CustomKeyStore
     - Grant
-  field_paths:
-    - CreateAliasInput.TargetKeyId
+    - Alias
 resources:
   Key:
     exceptions:
@@ -12,8 +11,3 @@ resources:
         # so the IsNotFound() function is generated correctly
         404:
           code: NotFoundException
-  Alias:
-    exceptions:
-      errors:
-        404:
-          code: NotFoundException
diff --git a/apis/kms/v1alpha1/zz_generated.deepcopy.go b/apis/kms/v1alpha1/zz_generated.deepcopy.go
diff --git a/apis/kms/v1alpha1/referencers.go → apis/kms/v1alpha1/zz_generated.resolvers.go b/apis/kms/v1alpha1/referencers.go → apis/kms/v1alpha1/zz_generated.resolvers.go
diff --git a/apis/kms/v1alpha1/zz_types.go b/apis/kms/v1alpha1/zz_types.go
diff --git a/examples/kms/alias.yaml b/examples/kms/alias.yaml
@@ -1,12 +1,11 @@
 apiVersion: kms.aws.crossplane.io/v1alpha1
 kind: Alias
 metadata:
-  name: dev-key
+  name: dev-alias
 spec:
   forProvider:
     region: us-east-1
-    aliasName: alias/dev-key
-    targetKeyIDRef:
+    targetKeyIdRef:
       name: dev-key
   providerConfigRef:
     name: example
diff --git a/package/crds/kms.aws.crossplane.io_aliases.yaml b/package/crds/kms.aws.crossplane.io_aliases.yaml
@@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.4.0
+    controller-gen.kubebuilder.io/version: v0.6.2
   creationTimestamp: null
   name: aliases.kms.aws.crossplane.io
 spec:
@@ -60,20 +60,11 @@ spec:
               forProvider:
                 description: AliasParameters defines the desired state of Alias
                 properties:
-                  aliasName:
-                    description: "Specifies the alias name. This value must begin
-                      with alias/ followed by a name, such as alias/ExampleAlias.
-                      \n The AliasName value must be string of 1-256 characters. It
-                      can contain only alphanumeric characters, forward slashes (/),
-                      underscores (_), and dashes (-). The alias name cannot begin
-                      with alias/aws/. The alias/aws/ prefix is reserved for AWS managed
-                      CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)."
-                    type: string
                   region:
                     description: Region is which region the Alias will be created.
                     type: string
-                  targetKeyID:
-                    description: 'Associates the alias with the specified customer
+                  targetKeyId:
+                    description: "Associates the alias with the specified customer
                       managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk).
                       The CMK must be in the same AWS Region. \n A valid CMK ID is
                       required. If you supply a null or empty string value, this operation
@@ -84,9 +75,9 @@ spec:
                       For example: \n    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
                       \n    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
                       \n To get the key ID and key ARN for a CMK, use ListKeys or
-                      DescribeKey.'
+                      DescribeKey."
                     type: string
-                  targetKeyIDRef:
+                  targetKeyIdRef:
                     description: TargetKeyIDRef is a reference to a KMS Key used to
                       set TargetKeyID.
                     properties:
@@ -96,7 +87,7 @@ spec:
                     required:
                     - name
                     type: object
-                  targetKeyIDSelector:
+                  targetKeyIdSelector:
                     description: TargetKeyIDSelector selects a reference to a KMS
                       Key used to set TargetKeyID.
                     properties:
@@ -112,7 +103,6 @@ spec:
                         type: object
                     type: object
                 required:
-                - aliasName
                 - region
                 type: object
               providerConfigRef:

diff --git a/pkg/controller/kms/alias/zz_controller.go → pkg/controller/kms/alias/controller.go b/pkg/controller/kms/alias/zz_controller.go → pkg/controller/kms/alias/controller.go
@@ -14,7 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Code generated by ack-generate. DO NOT EDIT.
+// NOTE(muvaf): This code ported from ACK-generated code. See details here:
+// https://github.com/crossplane/provider-aws/pull/950#issue-1055573793
 
 package alias