Git Product home page Git Product logo

aegea's Introduction

Aegea: Amazon Web Services Operator Interface

Aegea is a command line interface (CLI) that provides a set of essential commands and terminal dashboards for operators of Amazon Web Services (AWS) accounts. Aegea lets you build AMIs and Docker images using the cloud-init config management package, manage config roles, launch and monitor instances and services, and manage AWS resources including ELB, RDS, and AWS Batch. It is intended to be used in conjunction with the existing functionality of the AWS CLI and boto3.

Installation

pip3 install aegea

Before you do this, you will also need to install some system library dependencies:

OS Command
Mac OS Install Homebrew, then run brew install python.
Ubuntu sudo apt-get update; sudo apt-get install build-essential python3-{pip,dev,cffi} libffi-dev libssl-dev moreutils
Red Hat sudo yum install python3-devel python3-cffi openssl-devel moreutils

Run aws configure to configure IAM access credentials that will be used by the aws and aegea commands. You can create a new IAM key at https://console.aws.amazon.com/iam/home#/users. See the AWS CLI documentation for more details.

Aegea commands

Below are some highlights from Aegea's suite of commands. Run aegea --help to see the full list of commands.

Command Key functionality
aegea ls List running EC2 instances
aegea launch Launch EC2 instances and specify options such as spot tenancy, AMI, instance type, etc.
aegea ssh, aegea scp Connect to running instances, transfer files using AWS Systems Manager or other options
aegea batch Submit, manage and monitor AWS Batch jobs
aegea ecs Monitor ECS clusters and run Fargate tasks
aegea build-ami Build EC2 AMIs using cloud-init configuration scripts
aegea build-docker-image Build AWS ECR docker images using Dockerfiles or cloud-init scripts
aegea logs Download AWS CloudWatch Logs contents using S3 export
aegea grep Query AWS CloudWatch Logs contents using CloudWatch Logs Insights
aegea cost List AWS cost reports generated by AWS Cost Explorer
aegea secrets List and manage secrets stored in AWS Secrets Manager

Aegea SSH

The aegea ssh command (and its variant aegea scp) is an SSH configuration wrapper that integrates with the AWS Systems Manager to provide SSH connectivity to your instances without opening any inbound ports (if your instance OS is not configured with SSM, use aegea ssh --no-ssm to open a direct connection). aegea ssh securely resolves instance addresses by name and pre-fetches their public keys without the Trust-On-First-Use requirement. It also optionally integrates with the Bless package using the blessclient configuration convention.

Aegea Launch

The aegea launch command launches EC2 instances. It has integrated support for Bless as well as DNS, runtime cloud-init configuration, automatic location of Aegea-built AMIs or up-to-date Ubuntu or Amazon Linux AMIs, automatic storage configuration, and other options.

Aegea Batch

The AWS Batch API lets you run non-interactive command line workflows in Docker containers, managing AWS ECS, Spot Fleet, and EC2 in your account on your behalf. Use the aegea batch family of commands to interact with AWS Batch. The key command is aegea batch submit to submit jobs.

Run aegea batch submit --command "echo 'hello world'" --memory 2048 --vcpus 4 --watch to run a Batch job that requires 2 GB RAM and 4 cores to be allocated to the Docker container, and executes the specified command.

You can also use aegea batch submit --execute FILE. This will slurp up FILE (any type of shell script or ELF executable) and execute it in the job's Docker container.

The concurrency and cost of your Batch jobs is governed by the "Max vCPUs" setting in your compute environment. To change the capacity or other settings of your compute environment, go to https://console.aws.amazon.com/batch/home?region=us-east-1#/compute-environments, select "aegea_batch", and click "Edit".

AWS Batch launches and manages ECS host instances to execute your jobs. You can see the host instances by running aegea ls.

Aegea ECS Run

The ECS Fargate API is an interface to the AWS container-based virtualization platform, Firecracker. ECS Fargate allows you to run workloads in fully managed containers: no instances run in your account; you are billed by the second of container use, and containers usually start up within 20 seconds. Use the aegea ecs run command to interact with ECS Fargate. Most aegea batch semantics are applicable to aegea ecs, which interacts with ECS via the "one shot" ECS RunTask API.

Configuration management

Aegea supports ingesting configuration from a configurable array of sources. Each source is a JSON or YAML file. Configuration sources that follow the first source update the configuration using recursive dictionary merging. Sources are enumerated in the following order (i.e., in order of increasing priority):

  • Site-wide configuration source, /etc/aegea/config.yml
  • User configuration source, ~/.config/aegea/config.yml
  • Any sources listed in the colon-delimited variable AEGEA_CONFIG_FILE
  • Command line options

Array merge operators: When loading a chain of configuration sources, Aegea uses recursive dictionary merging to combine the sources. Additionally, when the original config value is a list, Aegea supports array manipulation operators, which let you extend and modify arrays defined in underlying configurations. See https://github.com/kislyuk/tweak#array-merge-operators for a list of these operators.

Building AMIs and Docker images

Aegea includes a lightweight configuration management system for building machine images based on cloud-init (both Docker images and AMIs are supported).

aegea's People

Contributors

kislyuk avatar extemporaneousb avatar midnighteuler avatar brentp avatar jshoe avatar markazhang avatar mrolm avatar jameshowardwang avatar yunfangjuan avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.