Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 3.26 KB

README.md

File metadata and controls

95 lines (64 loc) · 3.26 KB
Raw

Scalable Internet Services Utility Script

scalable_admin

Provides the functionality necessary to administrate github and AWS for the purposes of Scalable Internet Services classes.

Set up

Resolve python dependencies via:

# cd to the directory containing setup.py and run
pip install -e .

Configure AWS credentials by creating/editing the file ~/.aws/credentials so that it contains an admin section:

[scalableinternetservices-admin]
aws_access_key_id = ADMIN_USER_ACCESS_KEY
aws_secret_access_key = ADMIN_USER_SECRET_ACCESS_KEY

These credentials should correspond to a user that has full permission to the AWS API for the AWS account.

You will automatically be prompted for your github credentials the first time you issue a gh command. An access token will be saved to ~/.config/github_creds. The github account you use should have admin rights to the github organization.

Create/update $(HOME)/.config/scalable_admin.json

The file has the following keys that need to be set:

  • aws_account_alias: Set this value to the IAM alias configured for your AWS account.

  • aws_account_id: Set this value to your AWS account's numerical account ID.

  • aws_iam_group_name: Set this value to the IAM group name you'd like to associate with all your class accounts.

  • aws_region: Set this value to the AWS region that you'd like to grant access to.

  • github_archive_organization: Set this value to reflect the github organization that you'd like to archive projects to.

  • github_organization: Set this value to reflect your github organization.

Below is an example of the contents of the json file:

{
    "aws_account_alias": "cs291a",
    "aws_account_id": "123456789012",
    "aws_iam_group_name": "scalableinternetservices",
    "aws_region": "us-west-2",
    "github_archive_organization": "scalableinternetservicesarchive",
    "github_organization": "scalableinternetservices"
}

Commands

scalable_admin aws TEAM...

Use this command to configure the AWS permissions for one ore more teams. On first run for a team this command will create the account, outputting the newly created credentials, and create the team's keypair file: TEAM.pem.

Subsequent runs can be used to make updates to a team's permissions. This is only necessary if the permission settings have been modified in this package.

scalable_admin aws-purge TEAM...

Use this command to completely remove one or more teams' permissions. This command may fail if the AWS user for the team was manually modified through the IAM web interface.

scalable_admin aws-update-all

Use this command to update the permissions for all teams. The list of teams is dynamically determined from IAM users who belong to the group indicated by the config option aws_iam_group_name.

scalable_admin github TEAM USER...

Use this command to create a git repository, if it does not already exist, and add invite list of github USERs to the repository if they have not already been invited. Multiple users can be specified, and should be separated by spaces. Each USER should be the student's github account name.

Subsequent exections of the command is additive, thus it will not remove associated/invited accounts that are not specified on the command line.