Skip to content
This repository was archived by the owner on Nov 8, 2021. It is now read-only.

Commit 5e5c3a2

Browse files
committed
improved docs for install script
1 parent d256dd4 commit 5e5c3a2

File tree

3 files changed

+21
-8
lines changed

3 files changed

+21
-8
lines changed

import_users.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ IAM_AUTHORIZED_GROUPS=""
88
LOCAL_MARKER_GROUP="iam-synced-users"
99

1010
# Give the users these local UNIX groups
11+
# Comma seperated list
1112
LOCAL_GROUPS=""
1213

1314
# Specify an IAM group for users who should be given sudo privileges, or leave

install.sh

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,16 @@ Install import_users.sh and authorized_key_commands.
88
-h display this help and exit
99
-v verbose mode.
1010
11-
-a arn AssumeRole ARN to get users from another AWS account
12-
-i group,group Comma seperated list of IAM groups that should have ssh access
13-
-l group,group Comma seperated list of UNIX groups to add the users to
14-
-s group IAM group that should have sudo access. use ##ALL## if all users need it
11+
-a arn Assume a role before contacting AWS IAM to get users and keys.
12+
This can be used if you define your users in one AWS account, while the EC2
13+
instance you use this script runs in another.
14+
-i group,group Which IAM groups have access to this instance
15+
Comma seperated list of IAM groups. Leave empty for all available IAM users
16+
-l group,group Give the users these local UNIX groups
17+
Comma seperated list
18+
-s group Specify an IAM group for users who should be given sudo privileges, or leave
19+
empty to not change sudo access, or give it the value '##ALL##' to have all
20+
users be given sudo rights.
1521
1622
1723
EOF

showcase.yaml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,16 @@ Resources:
126126
-h display this help and exit
127127
-v verbose mode.
128128
129-
-a arn AssumeRole ARN to get users from another AWS account
130-
-i group,group Comma seperated list of IAM groups that should have ssh access
131-
-l group,group Comma seperated list of UNIX groups to add the users to
132-
-s group IAM group that should have sudo access. use ##ALL## if all users need it
129+
-a arn Assume a role before contacting AWS IAM to get users and keys.
130+
This can be used if you define your users in one AWS account, while the EC2
131+
instance you use this script runs in another.
132+
-i group,group Which IAM groups have access to this instance
133+
Comma seperated list of IAM groups. Leave empty for all available IAM users
134+
-l group,group Give the users these local UNIX groups
135+
Comma seperated list
136+
-s group Specify an IAM group for users who should be given sudo privileges, or leave
137+
empty to not change sudo access, or give it the value '##ALL##' to have all
138+
users be given sudo rights.
133139
134140
135141
EOF

0 commit comments

Comments
 (0)