Added "known issues" to readme

glassechidna · Jun 30, 2019 · 0e008a2 · 0e008a2
1 parent 5b38b2b
commit 0e008a2
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -44,6 +44,16 @@ AWS_PROFILE=mycompany ssh ec2-user@i-000abc124def
 ssh -L 2375:127.0.0.1:2375 ec2-user@i-000abc124def
 ```
 
+## Known issues
+
+Right now this tool only works with SSH public keys that are stored on disk.
+What that means in effect is that you can't:
+
+* Pass in an identity using `ssh -i <pemfile>`
+* Use an SSH agent
+
+Both of these are being actively worked on.
+
 [rel-notes]: https://aws.amazon.com/about-aws/whats-new/2019/06/introducing-amazon-ec2-instance-connect/
 [docs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html
 [mssh]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-connect-set-up.html#ec2-instance-connect-install-eic-CLI