You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*Issue #, if available:*
*Description of changes:*
By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.
Copy file name to clipboardExpand all lines: README.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -304,14 +304,27 @@ After successful deployment, you can access the Remote SWE Agents system through
304
304
- Respond to issue comments and assignments
305
305
- Seamless CI/CD integration
306
306
307
-
For tips on how to effectively use the agents, refer to the "Useful Tips" section below.
307
+
For tips on how to effectively use the agents, refer to the [Useful Tips](#useful-tips) section.
308
308
309
309
### GitHub Actions Integration
310
310
311
311
This repository can be used as a GitHub Action to automatically trigger Remote SWE agents from GitHub events like issue comments, assignments, and PR reviews. The GitHub Action uses the Remote SWE API functionality to create and manage agent sessions.
312
312
313
313
Use `aws-samples/remote-swe-agents` in your workflow and configure your API base URL and key as repository secrets. You can generate API keys from the deployed webapp interface. See [action.yml](./action.yml) for input parameters and [.github/workflows/remote-swe.yml](./.github/workflows/remote-swe.yml) for a complete example workflow.
314
314
315
+
### Tenant Isolation Model
316
+
317
+
This project is currently designed as a single-tenant system, meaning it is intended to be deployed on a per-tenant basis.
318
+
319
+
Since it follows a completely pay-as-you-go model, the overhead of deploying multiple instances is minimal in terms of infrastructure costs.
320
+
321
+
To control access for each tenant, you have the following access permission configurations:
322
+
323
+
1.**Slack App**: You can set the `SLACK_ADMIN_USER_ID_LIST` environment variable in CDK to deny access from non-permitted users. You can then add allowed users using the `approve_user` Slack command.
324
+
2.**Webapp**: Cognito self-sign-up is disabled by default. You can add users from the Cognito management console. Currently, anyone with a Cognito account has equal permissions. Users can configure the system, create new sessions, issue API keys, or view cost analysis from the web UI.
325
+
3.**REST API**: Anyone who knows the API keys can access it. You should delete keys that are no longer in use.
326
+
4.**GitHub Actions**: Anyone with write access to the repository (i.e., collaborators) can invoke the action.
0 commit comments