https://github.com/team-triage/triage-cli

Command line tool for deploying Triage to AWS
https://github.com/team-triage/triage-cli

aws-cdk aws-fargate docker javascript npm

Last synced: about 1 month ago
JSON representation

Command line tool for deploying Triage to AWS

• Host: GitHub
• URL: https://github.com/team-triage/triage-cli
• Owner: Team-Triage
• License: gpl-3.0
• Created: 2022-11-10T00:34:46.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-11T19:05:03.000Z (over 1 year ago)
• Last Synced: 2025-03-06T07:32:51.729Z (about 2 months ago)
• Topics: aws-cdk, aws-fargate, docker, javascript, npm
• Language: JavaScript
• Homepage: https://team-triage.github.io/
• Size: 17.5 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# triage-cli

`triage-cli` is a command line tool used to deploy Triage to AWS.

Prerequisites


- `npm 8.8+` 

- `docker 20.10.17+`

- `aws-cli version 2`

How to use


Before starting, be sure that you've logged into `aws-cli`. `triage-cli` will securely deploy Triage using your account info and default region.

 

 1. First, install the latest version of the `triage-cli` `npm` package with

     `npm install -g triage-cli` 

 2. Create a project directory and `cd` into it. This will contain the files necessary to deploy Triage to your AWS ecosystem.

	`mkdir myTriageProject && cd myTriageProject`

 3. Run `triage init`. This will clean up any existing files within the directory (perhaps from a previous deployment) and install dependencies necessary to deploy Triage. It will also generate a `config.properties` file in the current working directory.

	`triage init`

 4. Add the required key/value pairs to the `config.properties` file. 

	-	At a minimum, you'll need the following:

		 - `bootstrap.servers`

		 - `topic.name`

		 - `partition.count`

	 - In order for Triage to connect to your Kafka cluster, you'll also need to include the necessary key/value pairs for your specific authentication method.	 

 

 5. Run `triage deploy`

	

	`triage deploy`

	This step may take some time - up to 5 minutes. `triage-cli` will, among several other intermediary steps, deploy a number of Triage containers equal to the `partition.count` specified in `config.properties` and an application load balancer to allow access from the internet. It will also create a DynamoDB table to store any poison pill messages encountered.

6. When `triage-cli` has finished running, you will receive the following information needed to connect to Triage:

	- Triage's Network Address

		- This is an AWS internet-facing load balancer

	- Authentication Key

		- This is the key needed by consumer applications wishing to connect to Triage

	- DynamoDB Table Name

		- This is the name of the table where Triage containers will store dead-letters or poison pills. 

Teardown


To teardown a Triage deployment, simply navigate to the directory created during deployment and run `triage destroy`. This will remove all AWS resources associated with Triage.