Skip to content

Latest commit

 

History

History
executable file
·
192 lines (136 loc) · 4.99 KB

README.md

File metadata and controls

executable file
·
192 lines (136 loc) · 4.99 KB
Raw

AWS Scheduler Info

Is an Application to automate and manage the start/stop of AWS Resources (EC2 | AsGroups | RDS )

Backend in Python / Lambda / Gateway Api

  • AWS::Lambda::Function

    • ResourcesApi
    • SchedulerCheckAndApply
    • SchedulerFunctionsLayer

  • AWS::Cognito::UserPoolUser

    • UserDashboard dashboard

  • AWS::ApiGateway::RestApi

    • apiGateway

  • AWS::ApiGateway::Method

    • updateMethod

Frontend Javascript / S3

  • AWS::S3::Bucket
    • CodeSourceBucket
  • AWS::S3::Bucket
    • DashBoardBucket

Install

Instalation is done through the workflow file in github.

Two step installation is needed

First Backend ( Gateway API / Lambda / Cognito ) resources and next the Frontend (Javascript/HTML)

The Username Password is generated in the GitHub Action. It echoes in the github output console A simple test with jest.js in included in the workflow

Issue this commands to trigger an installation

  1. Clone the repo and cd into the root dir.

  2. Installation of Gateway API / Lambda / Cognito

Date=$(date +%D_%T); echo "infra_deploy $Date" > DeployTriggerFile.txt ; git add DeployTriggerFile.txt;git commit -m "Actions: infra_deploy ENV:LEARNING $Date";git push origin master
  1. Installation of S3 / Javascript code for DashBoard
Date=$(date +%D_%T); echo "DashBoard_setup $Date" > DeployTriggerFile.txt ; git add DeployTriggerFile.txt;git commit -m "Actions: DashBoard_setup ENV:LEARNING $Date";git push origin master

SetUp Resources

Tags have to be added to resources so that scheduler app can start/stop at defined schedules. TAGS:

    Key: "Name"
    Value: "Resource Name Used in DashBoard Listing/Debuging"      

    Key: "Project"
    Value: "Resource Project Group Used in DashBoard for grouping resources"

    Key: "Scheduler:Flag"
    Value: Exec|False 
    If Exec Resources is managed by Scheduler. If False or non existant, no action is taken

    Key: "Scheduler:Timings"
    Value: "0600:2000"
    time interval when resource should be running. Configured Values:
    "0600:2000","0900:1900","2000:0600"
    
    Key: "Scheduler:WeekDays"
    Value: "weekworkdays"
    week days when resource should be running. Configured Values:        
    "all","weekworkdays","sat,sun"

    Key: "Scheduler:OverRide"
    Value: ""
    Flag to overide the normal start/stop.
    Must be set in DashBoard WebConsole and with a Date
    Format dd-mm-yyyy
    If this date is set and is after the current day, the app wont do any actions (start|stop) on the resource
    Timezone is not taken in consideration

Below examples for adding to CloudFormation stacks

AWS::AutoScaling::AutoScalingGroup TAGS

  Tags: 
  - 
    Key: "Name"
    Value: "AsGroupNightShift"   
    PropagateAtLaunch: False 
  - 
    Key: "Project"
    Value: "App2_NightShift"
    PropagateAtLaunch: True 
  - 
    Key: "Scheduler:Flag"
    Value: Exec
    PropagateAtLaunch: True      
  - 
    Key: "Scheduler:Timings"
    Value: "2000:0600"
    PropagateAtLaunch: True         
  - 
    Key: "Scheduler:WeekDays"
    Value: "weekworkdays"
    PropagateAtLaunch: True         
  - 
    Key: "Scheduler:OverRide"
    Value: ""
    PropagateAtLaunch: True

AWS::EC2::Instance TAGS

  Tags: 
  - 
    Key: "Name"
    Value: "Ec2_MultipleProjects_Night"      
  - 
    Key: "Project"
    Value: "App_Ec2Only,App2_NightShift"
  - 
    Key: "Scheduler:Flag"
    Value: Exec
  -         
    Key: "Scheduler:Timings"
    Value: "2000:0600"
  - 
    Key: "Scheduler:WeekDays"
    Value: "weekworkdays"
  - 
    Key: "Scheduler:OverRide"
    Value: ""

AWS::RDS::DBInstance TAGS

 Tags: 
  - 
    Key: "Name"
    Value: "Rds_Day"      
  - 
    Key: "Project"
    Value: "App1_DayShift"
  - 
    Key: "Scheduler:Flag"
    Value: Exec
  -         
    Key: "Scheduler:Timings"
    Value: "0600:2000"
  - 
    Key: "Scheduler:WeekDays"
    Value: "weekworkdays"
  - 
    Key: "Scheduler:OverRide"
    Value: ""

Some more Informations

  • 3 main actions using commit message in github actions : ( infra_deploy python_update_code DashBoard_update_setup )
    • DashBoard_update_setup is to setup the web / Cognito
    • python_update_code just to deploy updated Python code
    • infra_deploy CFN stack and also the python code will be deploy
  • 2 ENV ENV:LEARNING and ENV:TESTING using commit message in github actions too
    • PREPRD coming soon
  • To Install everything from scratch use infra_deploy first, and then DashBoard_update_setup.
  • default App user : dashboard
  • To find Default user Pwd: See output of Github Action step "Install puppeteer jest and exec test" You can find process.env.DASHBOARD_PWD parameters.