Jump to Content

Documentation API Reference Changelog

Documentation API Reference Changelog

INTRODUCTION

What is Bunnyshell
Bunnyshell Requirements
Basic Terminology
How Bunnyshell works
QUICKSTART GUIDE

USING BUNNYSHELL

Organizations
Projects
- Project Settings
Environments
Components
Environment workflows & Pipelines
Terraform
Variables
- Interpolation
Volumes for docker-compose
Troubleshooting
- Troubleshooting workflows
- Troubleshooting components
Public API
SDK

BUNNYSHELL CLI

Bunnyshell CLI Overview
Install the CLI
CLI Authentication
Shell Autocomplete
Port Forwarding
SSH

REMOTE DEVELOPMENT

Remote Development Overview
Start Remote Development
Debugging remotely with VS Code
Debugging locally with port forwarding
Debugging frontend apps
- Debugging frontend in VS Code
- Debugging frontend in Jetbrains
Stop Remote Development
Prevent Remote Development

TEMPLATES

What are Templates
Use Templates in Bunnyshell
Clone Template repositories
Add your own Templates
- Prepare repository for Custom Templates
Sync Environment with Template

Common configurations

Build Settings
- Resource Allocation
Customizing URLs
Exposing URLs
Securing access for certain IPs

INTEGRATIONS

Git Providers
- Self-hosted Github
- Self-hosted Gitlab
Kubernetes clusters
Image Registries
Slack

CONNECTORS

What are connectors
Neon database

KUBERNETES CLUSTERS

Create a cluster
Prepare the cluster

METRICS

Engineering Metrics
- Metrics explained

Bunnyshell in 5 minutes

Creating and Deploying your first Environment
Creating and Deploying your first Ephemeral Environment
Destroying Ephemeral Environments
Keeping your environment up-to-date
Limited environment availability

QUICKSTART GUIDE

Quickstart Overview
Bunnyshell use cases
Create & Deploy the Environment
Common configuration
Ephemeral Environments
- Create & Destroy an Ephemeral Environment
Remote Development
Troubleshooting
- Troubleshooting in Bunnyshell
- Troubleshooting in Kubernetes
CLI, API & SDK
Completed Quickstart Guide

QUICKSTART / DEPLOY / HELM

Helm Overview
Deploying the Application
Understand how Bunnyshell works
Continue Quickstart Guide

QUICKSTART / DEPLOY / DOCKER-COMPOSE

Docker-compose Overview
Deploying the Application
Understand how Bunnyshell works
Best practices for docker-compose
Continue Quickstart Guide

TERRAFORM QUICKSTART GUIDE

Terraform Overview
- Pre-requisites
Terraform use cases
Application changes
Terraform Modules in Bunnyshell
Using Terraform Modules in Environments
Troubleshooting

REFERENCE GUIDE

Environment definition file (bunnyshell.yaml)
Docker compose conversion support

Powered by

Optimizing costs

Cluster pre-requisites for node auto-scaling

📘
TO DO
mention cluster autoscaler / HPA

Updated 5 months ago