Fix Lambda config docs (#5087)

* Fix 'ImageURI' -> 'Image' Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Fix field names from UpperCamelCase to lowerCamelCase Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Fix link title: 'Configuration' -> 'Configuring' Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Move link of 'Configuring Lambda application' to function.yaml area Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Fix field names from UpperCamelCase to lowerCamelCase: v0.46.x Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * fix 'IDs' -> 'Ids' Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Fix Required values and add explanation Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Fix header levels under function.yaml Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * fix '[[]Architecture]' to '[][Architecture]' Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Fix 'sourceCode' to 'source', although its type name is SourceCode in function.go Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> --------- Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
pipe-cd · Jul 31, 2024 · edebc9f · edebc9f
1 parent 8944de2
commit edebc9f
Show file tree

Hide file tree

Showing 4 changed files with 148 additions and 128 deletions.
diff --git a/docs/content/en/docs-dev/user-guide/configuration-reference.md b/docs/content/en/docs-dev/user-guide/configuration-reference.md
@@ -448,56 +448,61 @@ One of `yamlField` or `regex` is required.
 
 ### Specific function.yaml
 
+One of `image`, `s3Bucket`, or `source` is required.
+
+- If you use `s3Bucket`, `s3Key` and `s3ObjectVersion` are required.
+
+- If you use `s3Bucket` or `source`, `handler` and `runtime` are required.
+
+See [Configuring Lambda application](../managing-application/defining-app-configuration/lambda) for more details.
+
 | Field            | Type             | Description                        | Required |
 |------------------|------------------|------------------------------------|----------|
-| Name             | string           | Name of the Lambda function        | Yes      |
-| Role             | string           | IAM role ARN                       | Yes      |
-| ImageURI         | string           | URI of the container image         | Yes      |
-| S3Bucket         | string           | S3 bucket name for code package   | Yes      |
-| S3Key            | string           | S3 key for code package            | Yes      |
-| S3ObjectVersion  | string           | S3 object version for code package | Yes      |
-| SourceCode       | [SourceCode](#sourcecode)       | Git settings                | Yes      |
-| Handler          | string           | Lambda function handler            | Yes      |
-| Architectures    | [[]Architecture](#architecture)   | Supported architectures            | No       |
-| EphemeralStorage | [EphemeralStorage](#ephemeralstorage)| Ephemeral storage configuration    | No       |
-| Runtime          | string           | Runtime environment                | Yes      |
-| Memory           | int32            | Memory allocation (in MB)          | Yes      |
-| Timeout          | int32            | Function timeout (in seconds)      | Yes      |
-| Tags             | map[string]string| Key-value pairs for tags           | No       |
-| Environments     | map[string]string| Environment variables              | No       |
-| VPCConfig        | [VPCConfig](#vpcconfig)       | VPC configuration                  | No       |
-| Layers        | []string       | ARNs of [layers](https://docs.aws.amazon.com/lambda/latest/dg/chapter-layers.html) to depend on                | No       |
-
-### SourceCode
+| name             | string           | Name of the Lambda function        | Yes      |
+| role             | string           | IAM role ARN                       | Yes      |
+| image            | string           | URI of the container image         | No      |
+| s3Bucket         | string           | S3 bucket name for code package   | No      |
+| s3Key            | string           | S3 key for code package            | No      |
+| s3ObjectVersion  | string           | S3 object version for code package | No      |
+| source       | [source](#source)       | Git settings                | No      |
+| handler          | string           | Lambda function handler            | No      |
+| runtime          | string           | Runtime environment                | No      |
+| architectures    | [][Architecture](#architecture)   | Supported architectures            | No       |
+| ephemeralStorage | [EphemeralStorage](#ephemeralstorage)| Ephemeral storage configuration    | No       |
+| memory           | int32            | Memory allocation (in MB)          | Yes      |
+| timeout          | int32            | Function timeout (in seconds)      | Yes      |
+| tags             | map[string]string| Key-value pairs for tags           | No       |
+| environments     | map[string]string| Environment variables              | No       |
+| vpcConfig        | [VPCConfig](#vpcconfig)       | VPC configuration                  | No       |
+| layers        | []string       | ARNs of [layers](https://docs.aws.amazon.com/lambda/latest/dg/chapter-layers.html) to depend on                | No       |
+
+#### Source
 
 | Field | Type   | Description              | Required |
 |-------|--------|--------------------------|----------|
-| Git   | string | Git repository URL       | Yes      |
-| Ref   | string | Git branch/tag/reference| Yes      |
-| Path  | string | Path within the repository | Yes    |
+| git   | string | Git repository URL       | Yes      |
+| ref   | string | Git branch/tag/reference| Yes      |
+| path  | string | Path within the repository | Yes    |
 
-### Architecture
+#### Architecture
 
 | Field | Type   | Description            | Required |
 |-------|--------|------------------------|----------|
-| Name  | string | Name of the architecture | Yes     |
+| name  | string | Name of the architecture | Yes     |
 
-### EphemeralStorage
+#### EphemeralStorage
 
 | Field | Type  | Description                  | Required |
 |-------|-------|------------------------------|----------|
-| Size  | int32 | Size of the ephemeral storage| No       |
+| size  | int32 | Size of the ephemeral storage| Yes       |
 
-### VPCConfig
+#### VPCConfig
 
 | Field           | Type     | Description                 | Required |
 |-----------------|----------|-----------------------------|----------|
-| SecurityGroupIDs| []string | List of security group IDs  | No       |
-| SubnetIDs       | []string | List of subnet IDs          | No       |
+| securityGroupIds| []string | List of security group IDs  | No       |
+| subnetIds       | []string | List of subnet IDs          | No       |
 
-- Note
-    - See more Details
-        - [Configuration Lambda application](../managing-application/defining-app-configuration/lambda)
 
 ## LambdaQuickSync
 

diff --git a/docs/content/en/docs-v0.46.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.46.x/user-guide/configuration-reference.md
@@ -445,56 +445,61 @@ One of `yamlField` or `regex` is required.
 
 ### Specific function.yaml
 
+One of `image`, `s3Bucket`, or `source` is required.
+
+- If you use `s3Bucket`, `s3Key` and `s3ObjectVersion` are required.
+
+- If you use `s3Bucket` or `source`, `handler` and `runtime` are required.
+
+See [Configuring Lambda application](../managing-application/defining-app-configuration/lambda) for more details.
+
 | Field            | Type             | Description                        | Required |
 |------------------|------------------|------------------------------------|----------|
-| Name             | string           | Name of the Lambda function        | Yes      |
-| Role             | string           | IAM role ARN                       | Yes      |
-| ImageURI         | string           | URI of the container image         | Yes      |
-| S3Bucket         | string           | S3 bucket name for code package   | Yes      |
-| S3Key            | string           | S3 key for code package            | Yes      |
-| S3ObjectVersion  | string           | S3 object version for code package | Yes      |
-| SourceCode       | [SourceCode](#sourcecode)       | Git settings                | Yes      |
-| Handler          | string           | Lambda function handler            | Yes      |
-| Architectures    | [[]Architecture](#architecture)   | Supported architectures            | No       |
-| EphemeralStorage | [EphemeralStorage](#ephemeralstorage)| Ephemeral storage configuration    | No       |
-| Runtime          | string           | Runtime environment                | Yes      |
-| Memory           | int32            | Memory allocation (in MB)          | Yes      |
-| Timeout          | int32            | Function timeout (in seconds)      | Yes      |
-| Tags             | map[string]string| Key-value pairs for tags           | No       |
-| Environments     | map[string]string| Environment variables              | No       |
-| VPCConfig        | [VPCConfig](#vpcconfig)       | VPC configuration                  | No       |
-| Layers        | []string       | ARNs of [layers](https://docs.aws.amazon.com/lambda/latest/dg/chapter-layers.html) to depend on                | No       |
-
-### SourceCode
+| name             | string           | Name of the Lambda function        | Yes      |
+| role             | string           | IAM role ARN                       | Yes      |
+| image            | string           | URI of the container image         | No      |
+| s3Bucket         | string           | S3 bucket name for code package   | No      |
+| s3Key            | string           | S3 key for code package            | No      |
+| s3ObjectVersion  | string           | S3 object version for code package | No      |
+| source       | [Source](#source)       | Git settings                | No      |
+| handler          | string           | Lambda function handler            | No      |
+| runtime          | string           | Runtime environment                | No      |
+| architectures    | [][Architecture](#architecture)   | Supported architectures            | No       |
+| ephemeralStorage | [EphemeralStorage](#ephemeralstorage)| Ephemeral storage configuration    | No       |
+| memory           | int32            | Memory allocation (in MB)          | Yes      |
+| timeout          | int32            | Function timeout (in seconds)      | Yes      |
+| tags             | map[string]string| Key-value pairs for tags           | No       |
+| environments     | map[string]string| Environment variables              | No       |
+| vpcConfig        | [VPCConfig](#vpcconfig)       | VPC configuration                  | No       |
+| layers        | []string       | ARNs of [layers](https://docs.aws.amazon.com/lambda/latest/dg/chapter-layers.html) to depend on                | No       |
+
+#### Source
 
 | Field | Type   | Description              | Required |
 |-------|--------|--------------------------|----------|
-| Git   | string | Git repository URL       | Yes      |
-| Ref   | string | Git branch/tag/reference| Yes      |
-| Path  | string | Path within the repository | Yes    |
+| git   | string | Git repository URL       | Yes      |
+| ref   | string | Git branch/tag/reference| Yes      |
+| path  | string | Path within the repository | Yes    |
 
-### Architecture
+#### Architecture
 
 | Field | Type   | Description            | Required |
 |-------|--------|------------------------|----------|
-| Name  | string | Name of the architecture | Yes     |
+| name  | string | Name of the architecture | Yes     |
 
-### EphemeralStorage
+#### EphemeralStorage
 
 | Field | Type  | Description                  | Required |
 |-------|-------|------------------------------|----------|
-| Size  | int32 | Size of the ephemeral storage| No       |
+| size  | int32 | Size of the ephemeral storage| Yes       |
 
-### VPCConfig
+#### VPCConfig
 
 | Field           | Type     | Description                 | Required |
 |-----------------|----------|-----------------------------|----------|
-| SecurityGroupIDs| []string | List of security group IDs  | No       |
-| SubnetIDs       | []string | List of subnet IDs          | No       |
+| securityGroupIds| []string | List of security group IDs  | No       |
+| subnetIds       | []string | List of subnet IDs          | No       |
 
-- Note
-    - See more Details
-        - [Configuration Lambda application](../managing-application/defining-app-configuration/lambda)
 
 ## LambdaQuickSync
 

diff --git a/docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md
@@ -446,56 +446,61 @@ One of `yamlField` or `regex` is required.
 
 ### Specific function.yaml
 
+One of `image`, `s3Bucket`, or `source` is required.
+
+- If you use `s3Bucket`, `s3Key` and `s3ObjectVersion` are required.
+
+- If you use `s3Bucket` or `source`, `handler` and `runtime` are required.
+
+See [Configuring Lambda application](../managing-application/defining-app-configuration/lambda) for more details.
+
 | Field            | Type             | Description                        | Required |
 |------------------|------------------|------------------------------------|----------|
-| Name             | string           | Name of the Lambda function        | Yes      |
-| Role             | string           | IAM role ARN                       | Yes      |
-| ImageURI         | string           | URI of the container image         | Yes      |
-| S3Bucket         | string           | S3 bucket name for code package   | Yes      |
-| S3Key            | string           | S3 key for code package            | Yes      |
-| S3ObjectVersion  | string           | S3 object version for code package | Yes      |
-| SourceCode       | [SourceCode](#sourcecode)       | Git settings                | Yes      |
-| Handler          | string           | Lambda function handler            | Yes      |
-| Architectures    | [[]Architecture](#architecture)   | Supported architectures            | No       |
-| EphemeralStorage | [EphemeralStorage](#ephemeralstorage)| Ephemeral storage configuration    | No       |
-| Runtime          | string           | Runtime environment                | Yes      |
-| Memory           | int32            | Memory allocation (in MB)          | Yes      |
-| Timeout          | int32            | Function timeout (in seconds)      | Yes      |
-| Tags             | map[string]string| Key-value pairs for tags           | No       |
-| Environments     | map[string]string| Environment variables              | No       |
-| VPCConfig        | [VPCConfig](#vpcconfig)       | VPC configuration                  | No       |
-| Layers        | []string       | ARNs of [layers](https://docs.aws.amazon.com/lambda/latest/dg/chapter-layers.html) to depend on                | No       |
-
-### SourceCode
+| name             | string           | Name of the Lambda function        | Yes      |
+| role             | string           | IAM role ARN                       | Yes      |
+| image            | string           | URI of the container image         | No      |
+| s3Bucket         | string           | S3 bucket name for code package   | No      |
+| s3Key            | string           | S3 key for code package            | No      |
+| s3ObjectVersion  | string           | S3 object version for code package | No      |
+| source       | [Source](#source)       | Git settings                | No      |
+| handler          | string           | Lambda function handler            | No      |
+| runtime          | string           | Runtime environment                | No      |
+| architectures    | [][Architecture](#architecture)   | Supported architectures            | No       |
+| ephemeralStorage | [EphemeralStorage](#ephemeralstorage)| Ephemeral storage configuration    | No       |
+| memory           | int32            | Memory allocation (in MB)          | Yes      |
+| timeout          | int32            | Function timeout (in seconds)      | Yes      |
+| tags             | map[string]string| Key-value pairs for tags           | No       |
+| environments     | map[string]string| Environment variables              | No       |
+| vpcConfig        | [VPCConfig](#vpcconfig)       | VPC configuration                  | No       |
+| layers        | []string       | ARNs of [layers](https://docs.aws.amazon.com/lambda/latest/dg/chapter-layers.html) to depend on                | No       |
+
+#### Source
 
 | Field | Type   | Description              | Required |
 |-------|--------|--------------------------|----------|
-| Git   | string | Git repository URL       | Yes      |
-| Ref   | string | Git branch/tag/reference| Yes      |
-| Path  | string | Path within the repository | Yes    |
+| git   | string | Git repository URL       | Yes      |
+| ref   | string | Git branch/tag/reference| Yes      |
+| path  | string | Path within the repository | Yes    |
 
-### Architecture
+#### Architecture
 
 | Field | Type   | Description            | Required |
 |-------|--------|------------------------|----------|
-| Name  | string | Name of the architecture | Yes     |
+| name  | string | Name of the architecture | Yes     |
 
-### EphemeralStorage
+#### EphemeralStorage
 
 | Field | Type  | Description                  | Required |
 |-------|-------|------------------------------|----------|
-| Size  | int32 | Size of the ephemeral storage| No       |
+| size  | int32 | Size of the ephemeral storage| Yes       |
 
-### VPCConfig
+#### VPCConfig
 
 | Field           | Type     | Description                 | Required |
 |-----------------|----------|-----------------------------|----------|
-| SecurityGroupIDs| []string | List of security group IDs  | No       |
-| SubnetIDs       | []string | List of subnet IDs          | No       |
+| securityGroupIds| []string | List of security group IDs  | No       |
+| subnetIds       | []string | List of subnet IDs          | No       |
 
-- Note
-    - See more Details
-        - [Configuration Lambda application](../managing-application/defining-app-configuration/lambda)
 
 ## LambdaQuickSync