Skip to content

Commit

Permalink
#88 Documentation for interactive mode
Browse files Browse the repository at this point in the history
  • Loading branch information
outime authored Jun 29, 2016
1 parent 6883894 commit fdf0c61
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions user-guide/ssh-access.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,18 @@ Every team member can get access to any of the team's EC2 instances by using the
# enter odd hostname "odd-eu-west-1.myteam.example.org"
$ ssh -A odd-eu-west-1.myteam.example.org # agent-forwarding must be used!
$ ssh 172.31.146.1 # jump from bastion to private instance
.. Tip::

Use the ``--connect`` flag to directly connect to the EC2 instance so you do not need to execute the SSH command yourself.

.. Tip::

Use the **interactive mode** to experience an easy way to access instances. This mode prompts you for the AWS region where your instance is located, so it can present you a list of enumerated deployed stacks from which you can choose the one you want to access and provide a reason for it.

To get the most of this mode, it's recommended that piu is invoked with the ``--connect`` flag so you get into the instance as soon as the odd host authorizes your request: ``$ piu request-access --interactive --connect``. Alternatively, you can set the ``PIU_CONNECT`` and ``PIU_INTERACTIVE`` environment variables in your shell profile so you can invoke the command with the mentioned features enabled just with: ``$ piu request-access``.

.. Tip::

Use the ``--clip`` option to copy the output of piu to your clipboard.
Expand Down Expand Up @@ -68,6 +75,3 @@ All current and historic access requests can be listed on the command line:
$ piu list # list the most recent requests to my odd host
$ piu list -U jdoe -O '*' # list most recent requests by user "jdoe"
$ piu list -O '*' -s GRANTED # show all active access requests

0 comments on commit fdf0c61

Please sign in to comment.