Enabled to configure the interval of livestate store for Lambda (#5269)

* add liveStateInterval for Lambda Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * add docs of liveStateInterval Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * fix a test Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Rename to 'awsAPIPollingInterval' Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> --------- Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com>
pipe-cd · Oct 9, 2024 · 086f001 · 086f001
1 parent c3361ab
commit 086f001
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/docs/content/en/docs-dev/user-guide/managing-piped/configuration-reference.md b/docs/content/en/docs-dev/user-guide/managing-piped/configuration-reference.md
@@ -130,6 +130,7 @@ Must be one of the following structs:
 | roleARN | string | The IAM role arn to use when assuming an role. Required if you want to use the AWS SecurityTokenService. | No |
 | tokenFile | string | The path to the WebIdentity token the SDK should use to assume a role with. Required if you want to use the AWS SecurityTokenService. | No |
 | profile | string | The profile to use for logging into AWS cluster. The default value is `default`. | No |
+| awsAPIPollingInterval | duration | The interval of periodical calls of AWS APIs. Currently, this is an interval of refreshing the live state of Lambda functions. Default is 15s. | No |
 
 ### PlatformProviderECSConfig
 

diff --git a/pkg/app/piped/livestatestore/lambda/lambda.go b/pkg/app/piped/livestatestore/lambda/lambda.go
@@ -58,7 +58,7 @@ func NewStore(cfg *config.PlatformProviderLambdaConfig, platformProvider string,
 			client: client,
 			logger: logger.Named("store"),
 		},
-		interval:      15 * time.Second,
+		interval:      time.Duration(cfg.AwsAPIPollingInterval),
 		logger:        logger,
 		firstSyncedCh: make(chan error, 1),
 	}

diff --git a/pkg/config/piped.go b/pkg/config/piped.go
@@ -712,6 +712,12 @@ type PlatformProviderLambdaConfig struct {
 	// If empty, the environment variable "AWS_PROFILE" is used.
 	// "default" is populated if the environment variable is also not set.
 	Profile string `json:"profile,omitempty"`
+	// The interval of periodical calls of AWS APIs.
+	// Currently this is used for live state of Lambda functions,
+	// but in the future, this might also be used for other polling features.
+	// Default is 15s.
+	// To reduce AWS API calls, this interval should be larger.
+	AwsAPIPollingInterval Duration `json:"awsAPIPollingInterval,omitempty" default:"15s"`
 }
 
 func (c *PlatformProviderLambdaConfig) Mask() {

diff --git a/pkg/config/piped_test.go b/pkg/config/piped_test.go
@@ -146,7 +146,8 @@ func TestPipedConfig(t *testing.T) {
 						Name: "lambda",
 						Type: model.PlatformProviderLambda,
 						LambdaConfig: &PlatformProviderLambdaConfig{
-							Region: "us-east-1",
+							Region:                "us-east-1",
+							AwsAPIPollingInterval: Duration(15 * time.Second),
 						},
 					},
 				},