Installation

Introduction

Skyramp gives you a comprehensive solution for testing of modern, distributed software applications. The following components are needed to get started:

• The Skyramp Client helps you quickly generate the tests you need.

• The Skyramp Worker is responsible for executing tests and mocking services.

• The Skyramp Python Library facilitates communcation between the Skyramp Client and Worker.

Install Skyramp Client

Install the Skyramp terminal client with a single command:

bash -c "$(curl -fsSL https://skyramp.dev/installer.sh)"

Follow the step-by-step instructions in the terminal to complete the installation process.

Check Installation

Verify your Skyramp installation by running:

Refer to the CLI Commands for a comprehensive list of available commands.

Uninstalling the Skyramp Client

To uninstall Skyramp, run:

/bin/bash -c "$(curl -fsSL https://skyramp.dev/uninstaller.sh)"

Install Skyramp Python Library

Install the Skyramp Python library via pip:

To ensure Skyramp works as intended, we automatically install the following dependencies if version requirements are unmet. If you would like to prevent this, please use the following command:

pip install skyramp --no-deps

Required Dependencies

PyYAML [required: >=6.0.0]
Robotframework [required: >=4.1.2]
Typing_extensions [required: >=4.9.0]

Install Skyramp Worker

The Skyramp Worker serves as the foundation for executing tests and mocking services.

Using Docker Compose

Ensure Docker Compose is installed, then add the following to your docker-compose.yaml:

services:
  skyramp:
    image: public.ecr.aws/j1n2c2p2/rampup/worker:latest
    volumes:
      - skyramp:/etc/skyramp
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - "35142:35142"
    restart: always
  # The services below (dashboard-server, dashboard-client, and mongodb)
  # can be included optionally for Skyramp Dashboard bring up
  dashboard-server:
    image: public.ecr.aws/j1n2c2p2/rampup/dashboard-server:latest
    environment:
      NODE_ENV: production
      DOCKER_ENV: true 
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - "4000:4000"
    restart: always
  dashboard-client:
    image: public.ecr.aws/j1n2c2p2/rampup/dashboard-client:latest
    environment:
      NODE_ENV: production
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - "3000:3000"
    restart: always
  mongodb:
    image: mongo:6.0.6
    container_name : mongo-datastore-svc
    mem_limit: 2g
    ports:
      - "27017:27017"
    environment:
      MONGO_INITDB_ROOT_USERNAME: admin
      MONGO_INITDB_ROOT_PASSWORD: skyramp
      MONGO_INITDB_DATABASE: dashboarddb
    volumes:
      - mongodb:/data/db
    restart: always
volumes:
  mongodb:
  skyramp

Deploy the Skyramp Worker:

docker compose up -d --wait

Using Helm for Kubernetes

If Helm isn’t installed, refer to Helm’s documentation to get started.

1. Add Skyramp Helm Repo:

2. Update Repositories:

3. Install Worker Chart:

   helm install -n

• Replace <namespace> with the Kubernetes namespace where you want to deploy the Skyramp Worker chart. You can choose an existing namespace or create a new one.

• Replace <release-name> with a name for this Helm release. A release is a unique instance of a Helm chart installation.

Installing Worker with Python Modules (Optional)

To include additional Python modules in your Skyramp Worker:

1. Building the Worker Image with Python Modules

Create or modify a Dockerfile:

FROM --platform=linux/amd64 public.ecr.aws/j1n2c2p2/rampup/worker:latest
COPY requirements.txt /
RUN pip3 install -r

This Dockerfile uses the base Skyramp Worker image and copies your requirements.txt file into it, then installs the Python modules specified in requirements.txt.

Build the custom Worker image using the docker build command. Replace <image-name> with a suitable name for your custom image and <image-tag> with the desired tag:

docker build -t

2. Use the Custom Worker Image

Deploy it using Docker Compose or Helm, replacing the image reference.

Supported Operating Systems

• Mac OS X: 11.0 or later

• Ubuntu: 18.04 or later

• CentOS: 8.04 or later

• Fedora: 36.0 or later

• Windows Subsystem for Linux (WSL): 1

What’s Next

Now that you’ve installed Skyramp, proceed to the Writing Tests section to start using Skyramp’s programmatic test language.