Skip to content

Commit

Permalink
Updated documentation of limitations on the newly implemented features.
Browse files Browse the repository at this point in the history
  • Loading branch information
Danidite committed Nov 1, 2024
1 parent 8d6ee4c commit 7d2b5b7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/metrics_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,8 @@ Below is an example of the `workflow_instance_table` output for a workflow with
}
```

**Note:** Both the Workflow collector input (produced by the log syncer) and the Workflow collector output (used later by the deployment manager) are compressed using zStandard to reduce file size and comply with the 400KB item size limit in DynamoDB tables. While this approach minimizes file size, very complex functions with numerous invocations across multiple regions may encounter issues with log sync when output size exceeds the limit. A possible mitigation is to reduce the maximum number of logs in constants or to implement new features to address this limitation.

## Deployment Solver Input

Solver Input is a subcomponent of Deployment Solver responsible for providing input to the Solver.
Expand Down
4 changes: 4 additions & 0 deletions docs/remote_cli_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@
For most users, this may not be necessary, as they can invoke remote CLI components by simply using the `-r` or `--remote` flag with applicable commands.
This information is primarily intended for internal documentation useful to Caribou developers.

**Note:** Remote CLI features, including all remote CLI commands and timer functionalities, are experimental. Please use them with caution and at your own risk.

**Note:** Exercise caution when developing or modifying source code related to such events to prevent the risk of infinite or recurring loops!

**Note:** Many commands in the Remote CLI are designed to separate and concurrently execute different workflows on distinct AWS Lambda function instances of the Caribou Remote CLI to address the 15-minute Lambda time limit. However, this approach has limitations: complex workflows with numerous regions or frequent invocations may encounter issues with log syncing that exceeds the time limit or with the deployment migrator taking too long to complete a full migration. This is a current limitation of the Remote CLI.

## How to Invoke the AWS Remote CLI Through events
After deploying the `AWS Remote CLI`, you can run Caribou components by invoking the deployed lambda function using the returned Lambda ARN with the following event parameters.

Expand Down

0 comments on commit 7d2b5b7

Please sign in to comment.