Skip to main content

Prerequisites

Before you start using DevRamps, make sure you have the following set up.

Platform Requirements

DevRamps currently requires GitHub for source control and AWS for deployment. If you use GitLab, Bitbucket, or a non-AWS cloud provider, DevRamps is not yet compatible with your setup.

Estimated Setup Time

If you already have AWS accounts and a GitHub repository, setup takes about 10 minutes. Starting completely from scratch (creating AWS accounts, installing Node.js, etc.) may take 1-2 hours.

AWS Account​

You need at least one AWS account where your application will be deployed. If you don't have one yet, create an AWS account. For a typical setup, you'll have separate accounts for staging and production.

You'll need administrator access to each target account for the initial bootstrap step. Administrator access means your IAM user or role has the AdministratorAccess policy attached — this is needed to create CloudFormation stacks, IAM roles, and OIDC providers. You can verify your access by running:

aws sts get-caller-identity
aws iam list-attached-user-policies --user-name YOUR_USERNAME

After bootstrapping, DevRamps operates with least-privilege IAM roles scoped to only what your pipeline needs.

GitHub Repository​

Your application source code must be hosted on GitHub. DevRamps connects to your repository via a GitHub App to:

  • Detect pipeline definitions in your .devramps/ folder.
  • Clone your source code for artifact builds.
  • Trigger deployments on code push.

You need permission to install GitHub Apps on your organization or personal account.

Node.js (for CLI)​

The DevRamps CLI requires Node.js 18 or higher. You'll use the CLI to bootstrap IAM roles in your AWS accounts.

Verify your installation:

node --version  # Should be v18.0.0 or higher

If you don't have Node.js installed:

  • macOS: brew install node
  • Linux: Use nvm: nvm install 18
  • Windows: Download from nodejs.org. If you plan to use DevRamps CLI frequently, consider using WSL (Windows Subsystem for Linux) for a more consistent experience.

AWS CLI​

You need the AWS CLI configured with credentials that have administrator access to your target accounts. "Assuming roles" means using temporary credentials to act as an IAM role in another account — this is common in multi-account setups but not required for single-account deployments.

aws configure
# or
export AWS_ACCESS_KEY_ID=your_access_key
export AWS_SECRET_ACCESS_KEY=your_secret_key

Supported Deployment Targets​

DevRamps supports deploying to these AWS services:

  • Amazon ECS -- Container deployments with rolling updates
  • Amazon EKS -- Kubernetes deployments via kubectl or Helm
  • AWS CodeDeploy -- EC2 Auto Scaling Group deployments
  • Amazon EC2 -- Direct instance deployments via SSH or SSM
  • Terraform -- Infrastructure provisioning and management

You should have a working understanding of the AWS services you plan to deploy to. See Supported Platforms for a complete list of supported languages, frameworks, and deployment targets.

Next Steps​

  • Quickstart -- Sign up and deploy your first application.