Skip to content
This repository was archived by the owner on Dec 9, 2024. It is now read-only.

Commit 4f42176

Browse files
committed
Update readme with description of specific resources required
1 parent c855901 commit 4f42176

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,40 @@ Serverless Desktop is currently in beta and we are seeking customer feedback. To
2323
<br />
2424

2525
## How does it work?
26+
2627
Serverless Desktop will list your AWS Cloudformation stacks that are deployed via the [Serverless Framework](https://github.com/serverless/serverless), and create convenient views to work with the underlying AWS resources. Cloudformation stacks created outside of the Serverless Framework are currently not supported by Desktop.
2728

2829
Desktop will prompt you to connect your AWS Account. This will create an IAM Role in your account, that will give Desktop periodic, temporary access credentials to perform a `list` operation on your Cloudformation Stacks, and associated AWS resources. These same credentials will be used to invoke your functions, access your DynamoDB tables, S3 buckets, and work with other resources associated with your Serverless project.
2930

30-
Please note that while in beta, Serverless Desktop requires an AWS IAM Role with Admin permissions for your AWS account, which it assumes to periodically perform server-side operations. Desktop does not use long-lasting credentials. Instead, Desktop assumes the IAM Role you provide it, creates temporary credentials via AWS STS, and uses those for each opeartion. You control the IAM Role and can remove Desktop's access at any time. Within the upcoming weeks, Desktop will request specific permissions, rather than Admin access. Until then, please be aware of this behavior.
31+
Please note that while in beta, Serverless Desktop requires an AWS IAM Role with permissions for your AWS account, which it assumes to periodically perform server-side operations.
32+
Specifically:
33+
34+
- S3
35+
- Dynamo
36+
- Lambda
37+
- API Gateway
38+
- CloudFormation
39+
- CloudWatch
40+
- IAM (only ListRolePolicies and GetRolePolicy)
41+
42+
Desktop does not use long-lasting credentials. Instead, Desktop assumes the IAM Role you provide it, creates temporary credentials via AWS STS, and uses those for each operation. You control the IAM Role and can remove Desktop's access at any time. Within the upcoming weeks, Desktop will request specific permissions, rather than full read/write access. Until then, please be aware of this behavior.
3143

3244
Log streaming is enabled for NodeJS Lambda functions via the [AWS Lambda Extensions API](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-extensions-api.html). When you navigate to a function event trigger (HTTP, direct invocation, etc.) Desktop will add a [Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to your function to capture log output. Additionally, the following environment variables are added to your Lambda:
45+
3346
- `AWS_LAMBDA_EXEC_WRAPPER` - The path to the Extension entrypoint
3447
- `SERVERLESS_PLATFORM_CONFIG` - Configuration for your Serverless user and org
3548
- `SERVERLESS_PLATFORM_DEV_MODE` - Toggles on/off log streaming
3649

37-
3850
<br />
3951

40-
4152
## Supported platforms
53+
4254
- MacOS
4355

4456
<br />
4557

4658
## Supported resources
59+
4760
- AWS Lambda
4861
- AWS API Gateway
4962
- AWS DynamoDB
@@ -53,11 +66,13 @@ Log streaming is enabled for NodeJS Lambda functions via the [AWS Lambda Extensi
5366
<br />
5467

5568
## Limitations
69+
5670
- AWS only
5771
- The AWS Role provisioned for Desktop is currently set to Administrative permissions. This will be scoped down in the future.
5872
- Log streaming is only supported for NodeJS runtimes
5973

6074
<br />
6175

6276
## Feedback
77+
6378
Feel free to create an [issue](https://github.com/serverless/desktop/issues/new) to report bugs, or request features.

0 commit comments

Comments
 (0)