Skip to main content

​
Prerequisites

Before installing Kittyhawk, ensure you have:
  • Node.js (version 14 or higher)
  • TypeScript knowledge
  • CDK8s understanding (see CDK8s documentation)
  • A project where you want to define Kubernetes deployments

​
Step 1: Set up CDK8s TypeScript Project

Create a k8s folder within your project: 
mkdir k8s
cd k8s
Inside the k8s folder, initialize a CDK8s TypeScript project by following the official CDK8s instructions.

​
Step 2: Install Kittyhawk

Add the Kittyhawk library to your project: 
yarn add @pennlabs/kittyhawk

​
Step 3: Verify Installation

Check that Kittyhawk is installed correctly by verifying it appears in your package.json: 
{
  "dependencies": {
    "@pennlabs/kittyhawk": "^1.1.11",
    "cdk8s": "^2.69.58",
    "constructs": "^10.4.2"
  }
}

​
Additional Dependencies

Kittyhawk includes cron-time-generator as a dependency for easier cron job scheduling. This allows you to write: 
cronTime.every(5).minutes()  // Instead of */5 * * * *

​
Next Steps

Now that Kittyhawk is installed, you’re ready to create your first deployment configuration.

Quickstart

Deploy your first application with Kittyhawk

Build docs developers (and LLMs) love

Get started for freeTalk to us