Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aws-solutions/instance-scheduler-on-aws
A cross-account and cross-region solution that allows customers to automatically start and stop EC2 and RDS Instances
https://github.com/aws-solutions/instance-scheduler-on-aws
Last synced: 1 day ago
JSON representation
A cross-account and cross-region solution that allows customers to automatically start and stop EC2 and RDS Instances
- Host: GitHub
- URL: https://github.com/aws-solutions/instance-scheduler-on-aws
- Owner: aws-solutions
- License: apache-2.0
- Created: 2017-10-26T19:48:24.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T21:04:44.000Z (2 days ago)
- Last Synced: 2024-11-07T22:18:00.932Z (2 days ago)
- Language: Python
- Homepage: https://aws.amazon.com/solutions/implementations/instance-scheduler-on-aws/
- Size: 2.71 MB
- Stars: 553
- Watchers: 57
- Forks: 274
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Instance Scheduler on AWS
The Instance Scheduler on AWS solution automates the starting and stopping of Amazon Elastic Compute Cloud (Amazon EC2)
and Amazon Relational Database Service (Amazon RDS) instances.
This solution helps reduce operational costs by stopping resources that are not in use and starting them when they are
needed. The cost savings can be significant if you leave all of your instances running at full utilization continuously.
## Getting Started
To understand how to use Instance Scheduler on AWS, please review the [implementation
guide](https://docs.aws.amazon.com/solutions/latest/instance-scheduler-on-aws/solution-overview.html) on the [solution
landing page](https://aws.amazon.com/solutions/implementations/instance-scheduler-on-aws/). To deploy the solution, see
[Deploying the Solution](#deploying-the-solution).
## Repository Organization
```
|- .github/ - GitHub issue and pull request templates
|- .projen/ - projen-generated project metadata
|- deployment/ - build scripts
|- projenrc/ - projen source code
|- source/ - project source code
|- app/ - AWS Lambda Function source code
|- cli/ - Instance Scheduler CLI source code
|- instance-scheduler/ - CDK source code
|- pipeline/ - automated testing pipeline source code
```
## Deploying the Solution
### One-Click Deploy From Amazon Web Services
Refer to the [solution landing page](https://aws.amazon.com/solutions/implementations/instance-scheduler-on-aws/) to
deploy Instance Scheduler on AWS using our pre-packaged deployment assets.
### Deploy from source code using CDK
Instance Scheduler can be deployed to your AWS account directly from the source code using AWS Cloud Development Kit
(CDK).
#### Prerequisites
- cloned repository
- AWS CLI v2
- Node.JS 18
- docker
#### Deploying the hub stack
```
npm ci
npx cdk bootstrap
npx cdk deploy instance-scheduler-on-aws
```
This will deploy the solution into your aws account using all default configuration settings. You will then need to
update those settings to their desired values from the CloudFormation console by selecting the deployed template and
clicking "Update" -> "Use Current Template".
Refer to the [Implementation
Guide](https://docs.aws.amazon.com/solutions/latest/instance-scheduler-on-aws/deployment.html#step1) for guidance on
what each of the configuration parameters is for.
#### Deploying Remote Stacks in Other Accounts
To deploy the remote stack for cross-account scheduling, you will first need to have deployed the primary control stack.
Then update your aws credentials to match those of the remote account you would like to schedule and deploy the remote
stack.
```
npx cdk bootstrap
npx cdk deploy instance-scheduler-on-aws-remote --parameters InstanceSchedulerAccount={account-id} --parameters Namespace={namespace} --parameters UsingAWSOrganizations={useOrgs}
```
Replace:
- {account-id} with the id of the account that contains the primary control stack.
- {namespace} with the same unique namespace that was provided to the primary control stack
- {useOrgs} with the same value set in the primary control stack (Yes/No)
For example: `InstanceSchedulerAccount=111222333444`
### Deploy from GitHub (AWS Console)
This method mimics the procedure used by AWS One-Click Deploy allowing you to deploy the solution from the AWS console
using assets that you can control and update.
#### Overview
AWS Solutions use two buckets: a bucket for global access to templates, which is accessed via HTTPS, and regional
buckets for access to assets within the region, such as Lambda code. You will need:
- One global bucket that is accessed via the https end point. AWS CloudFormation templates are stored here. Ex.
"mybucket"
- One regional bucket for each region where you plan to deploy using the name of the global bucket as the root, and
suffixed with the region name. Ex. "mybucket-us-east-1"
- Your buckets should be encrypted and disallow public access.
#### You will need:
- cloned repository
- AWS CLI v2
- Node.js 18
- docker
- Two S3 buckets (minimum): 1 global and 1 for each region where you will deploy.
#### Step 1 - Download from GitHub
Clone the repository to a local directory on your linux client. Note: If you intend to modify Instance Scheduler you may
wish to create your own fork of the GitHub repo and work from that. This allows you to check in any changes you make to
your private copy of the solution.
#### Step 2 - Build the solution
From the _deployment_ folder in your cloned repo, run build-s3-dist.sh, passing the root name of your bucket(ex.
mybucket), name of the solution (i.e. instance-scheduler-on-aws) and the version you are building (ex. v1.5.0). We
recommend using a similar version based on the version downloaded from GitHub (ex. GitHub: v1.5.0, your build:
v1.5.0.mybuild).
```
cd deployment
./build-s3-dist.sh instance-scheduler-on-aws
```
#### Step 3 - Upload to your buckets
The previous step will have generated several folders in your local directory including:
```
deployment/global-s3-assets
deployment/regional-s3-assets
```
Upload the contents of `deployment/global-s3-assets` to your global bucket and `deployment/regional-s3-assets` to your
regional buckets following the pattern `s3://///`.
For example:
```
//global assets
s3://mybucket/instance-scheduler-on-aws/v1.5.0/instance-scheduler.template
s3://mybucket/instance-scheduler-on-aws/v1.5.0/instance-scheduler-remote.template
//regional assets
s3://mybucket-us-east-1/instance-scheduler-on-aws/v1.5.0/f779f5b7643ba70e9a5e25c8898f4e4e8e54ca15b150eee1dd25c2c636b188b8.zip
s3://mybucket-us-west-1/instance-scheduler-on-aws/v1.5.0/f779f5b7643ba70e9a5e25c8898f4e4e8e54ca15b150eee1dd25c2c636b188b8.zip
```
_Note: The scheduler-cli is optional and does not need to be published to the global bucket for deploy to work._
#### Step 4 - Deploy The Solution
Refer to the [Implementation
Guide](https://docs.aws.amazon.com/solutions/latest/instance-scheduler-on-aws/deployment.html) for deployment
instructions, using the link to the instance-scheduler.template from your bucket, rather than the one for AWS Solutions.
Ex. https://mybucket.s3.amazonaws.com/instance-scheduler-on-aws/v1.5.0.mybuild/instance-scheduler.template
## Testing the Solution
### Prerequisites
- cloned repository
- AWS CLI v2
- Node.js 18
- docker
- Python 3.10
- tox
### Running Tests Locally
```
npm ci
npm run test
```
## Modifying the Solution
### projen
This solution uses [projen](https://projen.io/) to manage certain project files. If you need to modify any of these
files, modify the source in [.projenrc.ts](./.projenrc.ts) and run `projen` to regenerate the files.
### Package installation
```
# For Node.js dependencies
npm ci
# For Python dependencies
cd source/app
poetry install
```
If you don't have `poetry`, refer to [Poetry](https://python-poetry.org/docs/) to install `poetry`.
## CDK Documentation
Instance Scheduler on AWS templates are generated using AWS CDK, for further information on CDK please refer to the
[documentation](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html).
## Collection of Operational Metrics
This solution collects anonymized operational metrics to help AWS improve the quality and features of the solution. For
more information, including how to disable this capability, please see the [implementation
guide](https://docs.aws.amazon.com/solutions/latest/instance-scheduler-on-aws/anonymized-data.html).
---
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License Version 2.0 (the "License"). You may not use this file except in compliance with the
License. A copy of the License is located at
http://www.apache.org/licenses/
or in the "[LICENSE](./LICENSE)" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing
permissions and limitations under the License.