From fdf0c616ce431819c059f0e7c5c8af7376017cbf Mon Sep 17 00:00:00 2001 From: Ruben Diaz Date: Wed, 29 Jun 2016 15:42:28 +0300 Subject: [PATCH] #88 Documentation for interactive mode --- user-guide/ssh-access.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/user-guide/ssh-access.rst b/user-guide/ssh-access.rst index 225cb1e..97279f5 100644 --- a/user-guide/ssh-access.rst +++ b/user-guide/ssh-access.rst @@ -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. @@ -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 - - -