Add function.yaml spec docs (pipe-cd#4779)

* Add function.yaml spec docs Signed-off-by: uncle <[email protected]> * Fix link Signed-off-by: uncle <[email protected]> * Fix link lambda doc Signed-off-by: uncle <[email protected]> * Remove unused .md Signed-off-by: uncle <[email protected]> --------- Signed-off-by: uncle <[email protected]>
sZma5a · Feb 7, 2024 · 4285674 · 4285674
1 parent 49627aa
commit 4285674
Show file tree

Hide file tree

Showing 2 changed files with 104 additions and 0 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
@@ -443,6 +443,58 @@ One of `yamlField` or `regex` is required.
 | functionManifestFile | string | The name of function manifest file placing in application directory. Default is `function.yaml`. | No |
 | autoRollback | bool | Automatically reverts to the previous state when the deployment is failed. Default is `true`. | No |
 
+### Specific function.yaml
+
+| 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       |
+
+### SourceCode
+
+| Field | Type   | Description              | Required |
+|-------|--------|--------------------------|----------|
+| Git   | string | Git repository URL       | Yes      |
+| Ref   | string | Git branch/tag/reference| Yes      |
+| Path  | string | Path within the repository | Yes    |
+
+### Architecture
+
+| Field | Type   | Description            | Required |
+|-------|--------|------------------------|----------|
+| Name  | string | Name of the architecture | Yes     |
+
+### EphemeralStorage
+
+| Field | Type  | Description                  | Required |
+|-------|-------|------------------------------|----------|
+| Size  | int32 | Size of the ephemeral storage| No       |
+
+### VPCConfig
+
+| Field           | Type     | Description                 | Required |
+|-----------------|----------|-----------------------------|----------|
+| 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
 
 | Field | Type | Description | Required |

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
@@ -443,6 +443,58 @@ One of `yamlField` or `regex` is required.
 | functionManifestFile | string | The name of function manifest file placing in application directory. Default is `function.yaml`. | No |
 | autoRollback | bool | Automatically reverts to the previous state when the deployment is failed. Default is `true`. | No |
 
+### Specific function.yaml
+
+| 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       |
+
+### SourceCode
+
+| Field | Type   | Description              | Required |
+|-------|--------|--------------------------|----------|
+| Git   | string | Git repository URL       | Yes      |
+| Ref   | string | Git branch/tag/reference| Yes      |
+| Path  | string | Path within the repository | Yes    |
+
+### Architecture
+
+| Field | Type   | Description            | Required |
+|-------|--------|------------------------|----------|
+| Name  | string | Name of the architecture | Yes     |
+
+### EphemeralStorage
+
+| Field | Type  | Description                  | Required |
+|-------|-------|------------------------------|----------|
+| Size  | int32 | Size of the ephemeral storage| No       |
+
+### VPCConfig
+
+| Field           | Type     | Description                 | Required |
+|-----------------|----------|-----------------------------|----------|
+| 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
 
 | Field | Type | Description | Required |