Skip to content

oslabs-beta/cloudband

Repository files navigation

Cloudband

Contributors Stargazers MIT License

Table of Contents
  1. About
  2. Getting Started
  3. Monitoring Features
  4. Contributing
  5. Built With
  6. License
  7. Authors
  8. Authors

About Cloudband

Easy access and straightforward, intuitive visualization of AWS resource metrics are critical to AWS developers. It is intimidating to navigate the extensive AWS documentation and many hundreds of services, and challenging to quickly visualize metrics for these resources.

Our solution is a web application that provides comprehensive charts for direct visualization of a wide range of available EC2 metrics and Lambda functions, for those who use Lambda functions to process lifecycle events from Amazon Elastic Compute Cloud and their related EC2 resources

Project Links: Github | Linkedin | [Press](will write this later this week)

Getting started (User Guide)

🛠️

Visit our Website

  1. Existing user? You can log in using your email and password.

  2. For new users, click "Create New Stack.

  3. Follow the link and sign in as an IAM user. Follow the instructions on the How To page or watch our How To Create a New Stack Video Tutorial.

  4. Copy and paste the unique ARN outputted from the prior step.

  5. Input the ARN into the Enter ARN Here field

(back to top)

Getting started (Contributor Guide)

🛠️

  1. Fork and clone this repository.

  2. Follow the Developer Setup Guide.

  3. Using the pre-made Dockerfile, build an image and tag it as "cloudband" (must use this name).

  4. On Dockerhub, pull the mongo image.

  5. Create an .env file with the following information, replacing the AWS_ACCESS_KEY and AWS_SECRET_KEY for your cloudband-user account's keys.


# cloudband's keys
AWS_ACCESS_KEY=********************
AWS_SECRET_KEY=******************************************

#MONGO URI
MONGO_URI_=mongodb://mongodb:27017/cloudband

export AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY
export AWS_SECRET_ACCESS_KEY=$AWS_SECRET_KEY
export AWS_DEFAULT_REGION=us-east-1
export MONGO_URI=$MONGO_URI_

  1. Run both images via the docker-compose YAML file.

  2. Go to your localhost:3000 to see the application.

(back to top)

Monitoring Features:

  1. On the landing page, users can select the type of EC2 resources they'd like to monitor. Once selected, users can view the metrics for the selected EC2 resources.

  1. By clicking on the instance id, you can easily toggle an instance's data on or off to view only what you want to see.

  1. The Cloudband interface allows you to seamlessly switch between your EC2 and Lambda metrics for a more convenient way to view your data.

(back to top)

Contributing:

Have a suggestion? Found a bug? Want to make Cloudband even more amazing? Please fork the repo and create a pull request. Don't forget to give the project a star ⭐️! Thanks again!

  1. Fork Cloudband

  2. Clone to your local machine

    git clone <your-repo-url>
    
  3. Create your Feature Branch

    git checkout -b feature/AmazingFeature
    
  4. Commit your Changes

    git commit -m 'Add some AmazingFeature'
    
  5. Push to the Branch

    git push origin feature/AmazingFeature
    
  6. Open a Pull Request

(back to top)

Built with

💻

(back to top)

License

Distributed under the MIT License.

(back to top)

Authors:

Caroline Kimball - Github || Linkedin

Camille Salter - Github || Linkedin

Greg Jenner - Github || Linkedin

John Donovan - Github || Linkedin

Tomas Kim - Github || Linkedin

Project Links: Github || Linkedin || Medium

(back to top)

Acknowledgments

(back to top)