Extend the description of sourceCodeHash

Signed-off-by: Fatih Türken <[email protected]>
crossplane-contrib · Apr 24, 2024 · 7b22448 · 7b22448
1 parent 5199951
commit 7b22448
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 22 deletions.
diff --git a/apis/lambda/v1beta1/zz_function_types.go b/apis/lambda/v1beta1/zz_function_types.go
diff --git a/config/lambda/config.go b/config/lambda/config.go
@@ -64,6 +64,10 @@ func Configure(p *config.Provider) {
 		r.LateInitializer = config.LateInitializer{
 			IgnoredFields: []string{"source_code_hash"},
 		}
+		r.MetaResource.ArgumentDocs["source_code_hash"] = "Used to trigger updates. Must be set to " +
+			"a base64 encoded SHA256 hash of the package file specified with either filename or s3_key. " +
+			"If you have specified this field manually, it should be the actual (computed) hash of the " +
+			"underlying lambda function specified in the filename, image_uri, s3_bucket fields."
 	})
 
 	p.AddResourceConfigurator("aws_lambda_function_event_invoke_config", func(r *config.Resource) {

diff --git a/examples/lambda/v1beta1/function.yaml b/examples/lambda/v1beta1/function.yaml
@@ -13,7 +13,7 @@ metadata:
   name: example
 spec:
   forProvider:
-    s3Bucket: upbound-provider-test-data
+    s3Bucket: official-provider-test-data
     s3Key: hello-python.zip
     handler: index.py
     packageType: Zip

diff --git a/package/crds/lambda.aws.upbound.io_functions.yaml b/package/crds/lambda.aws.upbound.io_functions.yaml
@@ -644,12 +644,11 @@ spec:
                       type: object
                     type: array
                   sourceCodeHash:
-                    description: Used to trigger updates. Must be set to a base64-encoded
-                      SHA256 hash of the package file specified with either filename
-                      or s3_key. The usual way to set this is filebase64sha256("file.11.12
-                      and later) or base64sha256(file("file.11.11 and earlier), where
-                      "file.zip" is the local filename of the lambda function source
-                      archive.
+                    description: Used to trigger updates. Must be set to a base64
+                      encoded SHA256 hash of the package file specified with either
+                      filename or s3_key. If you have specified this field manually,
+                      it should be the actual (computed) hash of the underlying lambda
+                      function specified in the filename, image_uri, s3_bucket fields.
                     type: string
                   tags:
                     additionalProperties:
@@ -1439,12 +1438,11 @@ spec:
                       type: object
                     type: array
                   sourceCodeHash:
-                    description: Used to trigger updates. Must be set to a base64-encoded
-                      SHA256 hash of the package file specified with either filename
-                      or s3_key. The usual way to set this is filebase64sha256("file.11.12
-                      and later) or base64sha256(file("file.11.11 and earlier), where
-                      "file.zip" is the local filename of the lambda function source
-                      archive.
+                    description: Used to trigger updates. Must be set to a base64
+                      encoded SHA256 hash of the package file specified with either
+                      filename or s3_key. If you have specified this field manually,
+                      it should be the actual (computed) hash of the underlying lambda
+                      function specified in the filename, image_uri, s3_bucket fields.
                     type: string
                   tags:
                     additionalProperties:
@@ -2047,12 +2045,11 @@ spec:
                       type: object
                     type: array
                   sourceCodeHash:
-                    description: Used to trigger updates. Must be set to a base64-encoded
-                      SHA256 hash of the package file specified with either filename
-                      or s3_key. The usual way to set this is filebase64sha256("file.11.12
-                      and later) or base64sha256(file("file.11.11 and earlier), where
-                      "file.zip" is the local filename of the lambda function source
-                      archive.
+                    description: Used to trigger updates. Must be set to a base64
+                      encoded SHA256 hash of the package file specified with either
+                      filename or s3_key. If you have specified this field manually,
+                      it should be the actual (computed) hash of the underlying lambda
+                      function specified in the filename, image_uri, s3_bucket fields.
                     type: string
                   sourceCodeSize:
                     description: Size in bytes of the function .zip file.