Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix Lambda config docs #5087

Merged
merged 11 commits into from
Jul 31, 2024
Merged

Fix Lambda config docs #5087

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4f47193
Fix 'ImageURI' -> 'Image'
t-kikuc Jul 28, 2024
78d2e98
Fix field names from UpperCamelCase to lowerCamelCase
t-kikuc Jul 28, 2024
9776fce
Fix link title: 'Configuration' -> 'Configuring'
t-kikuc Jul 28, 2024
13020e2
Move link of 'Configuring Lambda application' to function.yaml area
t-kikuc Jul 28, 2024
b25b911
Fix field names from UpperCamelCase to lowerCamelCase: v0.46.x
t-kikuc Jul 28, 2024
0629945
fix 'IDs' -> 'Ids'
t-kikuc Jul 28, 2024
cc06037
Fix Required values and add explanation
t-kikuc Jul 28, 2024
cb5b9f1
Fix header levels under function.yaml
t-kikuc Jul 28, 2024
f1ae2d3
fix '[[]Architecture]' to '[][Architecture]'
t-kikuc Jul 28, 2024
709ac39
Fix 'sourceCode' to 'source', although its type name is SourceCode in…
t-kikuc Jul 28, 2024
d5a5217
fix '#sourcecode' -> '#source'
t-kikuc Jul 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 37 additions & 32 deletions docs/content/en/docs-dev/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,56 +448,61 @@ One of `yamlField` or `regex` is required.

### Specific function.yaml

One of `image`, `s3Bucket`, or `sourceCode` is required.

- If you use `s3Bucket`, `s3Key` and `s3ObjectVersion` are required.

- If you use `s3Bucket` or `sourceCode`, `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 |
| sourceCode | [SourceCode](#sourcecode) | 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 |

#### 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 |
| 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

Expand Down
69 changes: 37 additions & 32 deletions docs/content/en/docs-v0.46.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,56 +445,61 @@ One of `yamlField` or `regex` is required.

### Specific function.yaml

One of `image`, `s3Bucket`, or `sourceCode` is required.

- If you use `s3Bucket`, `s3Key` and `s3ObjectVersion` are required.

- If you use `s3Bucket` or `sourceCode`, `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 |
| sourceCode | [SourceCode](#sourcecode) | 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 |

#### 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 |
| 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

Expand Down
69 changes: 37 additions & 32 deletions docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,56 +446,61 @@ One of `yamlField` or `regex` is required.

### Specific function.yaml

One of `image`, `s3Bucket`, or `sourceCode` is required.

- If you use `s3Bucket`, `s3Key` and `s3ObjectVersion` are required.

- If you use `s3Bucket` or `sourceCode`, `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 |
| sourceCode | [SourceCode](#sourcecode) | 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 |

#### 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 |
| 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

Expand Down
Loading
Loading