Lodge is an open source self-managed logging framework for small, distributed applications based on the Elastic stack. Lodge allows users to ship, transform, store, visualize, and monitor their logs.
Sam Clark Software Engineer Dallas, TX
Rana Deeb Software Engineer San Francisco, CA
Regina Donovan Software Engineer Atlanta, GA
Justin Lo Software Engineer Vancouver, BC
- Prerequisites
- Installing Lodge
- Lodge CLI Commands
- Initializing Lodge
- Deploying Lodge
- Tearing Down Lodge
- Connecting To Lodge
- Helpful Resources
- Node.js (v14)
- NPM
- AWS Account
- AWS CLI configured with a default region that has at least 3 availability zones
- AWS Cloud Development Kit CLI
- AWS Software Development Kit CLI
- AWS System Manager CLI
You'll need to have the above accounts and tools before running any Lodge CLI commands. The Lodge CLI is an NPM package that deploys an AWS CDK application in Node.js. An AWS account and CLI tools are required to deploy the Lodge infrastructure to AWS.
npm i -g lodge-cli
| Command | Description |
|---|---|
lodge init |
Initialize the CDK application and prepare for deployment. |
lodge deploy |
Launches a configuration wizard, generates CloudFormation templates, and deploys Lodge to AWS |
lodge destroy |
Tears down the AWS infrastructure that is hosting Lodge |
lodge connect |
Starts an AWS SSM session with the Lodge bastion host |
To initialize the Lodge application, run lodge init.
This command will:
- Verify that prerequisites are met
- Clone the CDK application locally
- Install the dependencies
- Generate an AWS key-pair
To deploy Lodge, run lodge deploy.
This command will start an interactive wizard for configuring the deployment. The prompts include:
- Selecting an existing or creating a new AWS Virtual Private Cloud (VPC)
- If using an existing VPC
- Choose the VPC from the list fetched from your AWS account
- Choose the public subnet you wish to use to deploy the dashboard
- Choose the private subnets you wish to use to deploy the rest of the pipeline
- If using a new VPC
- Enter the CIDR block of the network you will be shipping logs from
Once the wizard is complete, the CDK application will generate a series of CloudFormation templates that will take up to an hour to finish deploying on your account. You will see status updates in the terminal as well as in the CloudFormation console in AWS.
To tear down the Lodge pipeline, run lodge destroy
After confirming that you wish to destroy the CloudFormation stacks, the Lodge CLI will begin the teardown process. This process will also take upwards of an hour.
To connect to the Lodge pipeline, run lodge connect
This command will begin an AWS System Manager (SSM) session with the bastion host. From there, you can run ./lodge-connect <component> to SSH directly to Lodge components. Host names include:
- zookeeper1
- zookeeper2
- zookeeper3
- kafka1
- kafka2
- kafka3
- es1
- es2
- es3
- kibana
- webTools