Aegea

How to use Aegea

Aegea is a command-line tool developed by the Chan Zuckerberg Initiative to simplify the deployment and management of web applications on Amazon Web Services (AWS). Here are the steps to use Aegea:

1. Install Aegea:

   1. Aegea requires Python 3.6 or higher. You can install it using pip, the Python package installer, by running the following command in your terminal:

      pip install aegea
      

2. Configure Aegea:

   1. Before using Aegea, you need to configure your AWS credentials. Aegea uses the AWS Command Line Interface (CLI) to interact with AWS services. To configure your credentials, run the following command:

      aws configure
      

   2. It will prompt you to enter your AWS Access Key ID, Secret Access Key, default region name, and output format. Once configured, Aegea will be able to access your AWS resources.

3. Create an Aegea project:

   1. Aegea organizes your application as a project. To create a new project, navigate to the directory where you want to store your project files and run the following command:

      aegea init myproject
      

   2. This will create a new directory named
      myproject
      with the necessary project structure.

4. Configure your project:

   1. Inside your project directory, you'll find a file called
      config.yaml
      . Open this file in a text editor and modify it according to your application's requirements. The configuration file allows you to specify various aspects of your application, such as its name, runtime environment, dependencies, and more.

5. Deploy your application:

   1. Once your project is configured, you can deploy it to AWS using the following command:

      aegea deploy
      

   2. Aegea will build your application, create the necessary AWS resources (e.g., Amazon Elastic Container Service, Amazon EC2 instances), and deploy your application.

6. Monitor and manage your application:

   1. Aegea provides various commands to monitor and manage your deployed application. Here are some commonly used ones:
      1. aegea ps
         : Lists all running containers or services in your project.
      2. aegea logs <service-name>
         : Displays the logs of a specific service.
      3. aegea scale <service-name> <number-of-instances>
         : Scales a service by increasing or decreasing the number of instances.
      4. aegea destroy
         : Destroys all AWS resources associated with your project.

7. Update your application:

   1. To update your application with new changes, modify your project files and run the following command:

      aegea deploy
      

   2. Aegea will automatically detect the changes and update your deployment accordingly.

Remember to refer to the Aegea documentation for detailed information on its capabilities and features.