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

Commit 0e1a6d1

Browse files
mvanbaakmichaelwittig
authored andcommitted
Document LOCAL_MARKER_GROUP. (#55)
* Document LOCAL_MARKER_GROUP. Closes #51 * Better wording
1 parent 5e2f691 commit 0e1a6d1

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,16 @@ one or more of the following lines:
9494
ASSUMEROLE="IAM-role-arn" # IAM Role ARN for multi account. See below for more info
9595
IAM_AUTHORIZED_GROUPS="GROUPNAMES" # Comma seperated list of IAM groups to import
9696
SUDOERSGROUP="GROUPNAME" # IAM group that should have sudo access
97+
LOCAL_MARKER_GROUP="iam-synced-users" # Dedicated UNIX group to mark imported users. Used for deleting removed IAM users
9798
LOCAL_GROUPS="GROUPNAMES" # Comma seperated list of UNIX groups to add the users in
9899
USERADD_PROGRAM="/usr/sbin/useradd" # The useradd program to use. defaults to `/usr/sbin/useradd`
99100
USERADD_ARGS="--create-home --shell /bin/bash" # Arguments for the useradd program. defaults to `--create-home --shell /bin/bash`
100101
```
101102

103+
The LOCAL_MARKER_GROUP will be created if it does not exist. BEWARE: DO NOT add any manually created users
104+
to this group as they will be deleted in the next sync. This group is used by aws-ec2-ssh to keep track
105+
of what users were imported in the last run.
106+
102107
## Using a multi account strategy with a central IAM user account
103108

104109
If you are using multiple AWS accounts you probably have one AWS account with all the IAM users (I will call it **users account**), and separate AWS accounts for your environments (I will call it **dev account**). Support for this is provided using the AssumeRole functionality in AWS.

0 commit comments

Comments
 (0)