Add SSM Port Forwarding Readme

docs/developer-access.md

@@ -0,0 +1,77 @@
+# Developer Access using AWS Tools
+
+## Port Forwarding using SSM Session Manager
+
+This documentation demonstrates how to use session manager for port forwarding to a remote host.
+It establishes a secure connection to the remote host and forwards a local port to a port on the remote host.
+This allows you to access services running on the remote host through your local machine.
+
+Official documentation for [Session Manager Port Forwarding](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html#sessions-start-port-forwarding)
+
+### Steps for session manager port forwarding:
+1. Install and configure the AWS CLI
+  * Refer to documentation on how to do this
+2. Install Session Manager plugin.
+  * Download the installer:
+   ```shell
+   curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/mac_arm64/sessionmanager-bundle.zip" -o "sessionmanager-bundle.zip"
+   ```
+  * Create a per-user bin directory: `mkdir -p ~/.local/bin`
+  * Run the installer:
+  ```shell
+  ./sessionmanager-bundle/install -i ~/.local/sessionmanagerplugin -b ~/.local/bin/session-manager-plugin
+  ```
+  * Edit (or create) `~/.bash_profile`, add this line: `export PATH=$HOME/.local/bin:$PATH`
+  * Verify the plugin is installed and executable: `which session-manager-plugin`. The output should show the location of the plugin
+
+Depending on whether you want to connect to a port on the container or a port on a remote host that the container has access to, do one of the following:
+
+#### Connect to ports on the container
+
+```shell
+$ aws ssm start-session --target INSTANCE_ID --document-name AWS-StartPortForwardingSession --parameters '{"portNumber":["8080"],"localPortNumber":["8080"]}'
+```
+Then, in another terminal session:
+```shell
+$ curl localhost:8080
+```
+
+This will connect to port 8080 on the running container.
+
+#### Connect to remote hosts accessible from the container
+
+```shell
+aws ssm start-session --target "ecs:YOUR_ECS_CLUSTER_NAME_c7feb90c8b61453c8019b48826f8b077_c7feb90c8b61453c8019b48826f8b077-946514567" --document-name AWS-StartPortForwardingSessionToRemoteHost --parameters '{"portNumber":["5432"],"localPortNumber":["5432"],"host":["YOUR_RDS_ENDPOINT.<REGION>.rds.amazonaws.com"]}'
+```
+Then, in another terminal session:
+```shell
+$ psql localhost:5432
+```
+This will open a Postgres Client session with the RDS instance accessible by the running container.
+
+## Shell access with ECS Exec:
+```shell
+aws ecs execute-command --cluster <CLUSTER_NAME> \    --task arn:aws:ecs:<REGION>:<AWS_ACCOUNT>:task/YOUR_ECS_CLUSTER_NAME/1316ce88a09e43c9a30927c1833c0246  \
+    --container wsgi \
+    --command "/bin/sh" \
+    --interactive
+```
+#### To find ECS task ARNs and IDs in the console, you can follow these steps:
+
+1. Open the AWS Management Console and navigate to the ECS service.
+2. Select the cluster that contains the tasks you want to find.
+3. In the cluster details page, click on the "Tasks" tab.
+4. You will see a list of tasks running in the cluster. The ARN and ID of each task will be displayed in the table.
+
+Note that the ARN is a unique identifier for each task, while the ID is a shorter identifier that can be used for referencing tasks within the cluster.
+
+#### To find ECS Services, task ARNs and IDs using AWS CLI commands:
+
+To list services in an AWS ECS cluster -
+`aws ecs list-services --cluster <cluster_name>`
+
+List tasks for a specific cluster -
+`aws ecs list-tasks --cluster <cluster_name>`
+
+Describe tasks to get more details -
+`aws ecs describe-tasks --cluster <cluster_name> --tasks <task_id1> <task_id2> ...`