Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 2.18 KB

README.md

File metadata and controls

97 lines (69 loc) · 2.18 KB

Canopy

Prerequisites

In order to run Canopy, you need to have the following prerequisites set up on your system:

Usage

$ npm install -g aws-cdk
$ npm install -g canopy-cli
$ canopy COMMAND
running command...
$ canopy --help [COMMAND]
Usage Canopy COMMAND
...

Getting Started

  1. Install AWS CDK (Cloud Development Kit):
$ npm install -g aws-cdk
  1. Install Canopy's CLI:
$ npm install -g canopy-cli

  1. Run canopy configure to set up your AWS credentials, provide an initial CloudFront distribution, and bootstrap your AWS environment with AWS CDK resources.

  2. Deploy Canopy's pipeline to AWS infrastructure and attach your CloudFront distribution to the pipeline:

$ canopy deploy
  1. After successful deployment, the Amazon EC2 public IP is output, and logs can now be processed by the pipeline. Visualize logs and metrics via the Grafana UI at http://{EC2_public_IP}:3000.

The default login for Grafana is:

  • username: admin
  • password: admin
  1. Launch Canopy's Admin Dashboard to monitor pipeline status and set up "quick" alerts:
$ canopy launchDashboard

Adding a CloudFront Distribution to the Pipeline

  1. To add an additional distribution to the pipeline:
$ canopy add

Teardown

To delete all deployed AWS resources, run:

$ canopy destroy

Commands

$ canopy
Usage: Canopy [options] [command]

Canopy Infrastructure Management API

Options:
  -h, --help           display help for command

Commands:
  add [options]        Attach Real-Time Log Configuration to Distribution
  deploy               Deploy Canopy Infrastructure to AWS
  destroy              Destroy Canopy Infrastructure on AWS
  configure [options]  Configure your AWS credentials
  alert [options]      Add pre-configured alerts to your Grafana instance
  launchDashboard      Launches Canopy Admin Dashboard
  help [command]       display help for command