DOCSEARCHbyAlgolia
Submit Docs

Preevy Documentation

website·Indexed 33 days ago

https://preevy.dev/

Preevy provides a cost-effective way to provision ephemeral preview environments to improve code-review workflows. It includes a CLI for managing environments, profiles, and logs, as well as drivers for Kubernetes, Microsoft Azure, and GCP Compute Engine. The tool offers a GitHub integration via @preevy/plugin-github and a Livecycle Docker Extension for easier environment management.

Tokens
16.8K
Snippets
90
Records
135
Agent score
67%

What's inside Preevy

  1. Overview of Preevy ephemeral environments

    Preevy is an open-source tool by Livecycle used to provision, manage, and expose ephemeral environments for containerized cloud applications. It is designed to integrate into pull/merge request workflows, allowing developers to deploy app revisions with either public or protected access, either on the public internet or within a private network, without requiring extensive DevOps expertise.

  2. Overview of the Preevy Tunnel Server

    Preevy uses a tunnel server to expose preview environment services to end users. It is a Node.js server that creates tunnels for HTTP services using SSH. By default, the Preevy CLI uses a public tunnel server hosted on livecycle.run, but this can be overridden using the --tunnel-server flag.

  3. Overview of Preevy Preview Environments

    Preevy is an open-source tool designed to help development teams improve code-review workflows by provisioning ephemeral 'Preview Environments' for every branch. These environments allow developers to test, validate, and review changes in a non-production version of the application before merging. Preevy specifically targets complex applications with multiple services, aiming to lower the barrier to entry for developers who have minimal knowledge of Docker and a cloud provider account by prioritizing simplicity and cost-effectiveness over high-fidelity production mirroring.

  4. Overview of Preevy for Docker Compose preview environments

    Preevy is an open-source tool developed by Livecycle that allows developers to provision, manage, and expose ephemeral (short-lived) environments for containerized applications in the cloud. It is specifically designed for Docker Compose applications and is intended to be integrated into pull request or merge request workflows to enable rapid testing and review without requiring extensive DevOps expertise.

  5. Overview of Livecycle Dashboard capabilities

    The Livecycle Dashboard is a web application providing a graphical user interface (GUI) for managing Livecycle environments. Key capabilities include:

    • Remote terminal and log access
    • Container inspection
    • Collaboration tools including chat and pointing tools for team sharing

  6. Overview of the Kubernetes single Pod driver

    The Kubernetes single Pod driver allows Preevy to provision ephemeral preview environments on a Kubernetes cluster. For each environment, the driver creates a Kubernetes Pod running a Docker server. Preevy connects to this Docker server to build and run services. Services are exposed via the Preevy Tunnel Service, eliminating the need for manual ingress configuration.

  7. Use Livecycle shared preview environments for collaborative reviews

    Livecycle provides shared preview environments that allow developers to share latest changes and collect in-context feedback. These environments include built-in tools for technical teammates to review changes and access services directly from a browser, including real-time logging, error detection, and terminal command execution to resolve issues early in the development lifecycle.

  8. Understand Livecycle Docker Extension capabilities and features

    The Livecycle Docker Extension is a tool integrated with Docker that allows developers to expose local development environments via secure HTTPS tunnels. Key features include:

    • Consistent URLs: Stable endpoints for shared environments.
    • Access Control: Support for private environments and authentication via Google or GitHub.
    • Debugging Tools: The Livecycle dashboard provides log inspection, shell access, and container inspection.
    • Language Agnostic: Works with any application or framework that can run inside a Docker container.
    • Preevy CLI Integration: Enables the creation of remote ephemeral preview environments for Pull Requests, which can be provisioned via CI pipelines and accessed even when the local development machine is offline.

  9. Share ephemeral environments for code review and feedback

    Livecycle allows developers to create previews of code changes and share them with teammates via the Dashboard. Team members can be invited to ephemeral environments to review changes directly in their browser and provide in-context feedback. Users can view a list of open projects assigned to them within the Dashboard to begin the review process.

  10. Provision virtual machines using the Preevy AWS Lightsail driver

    Preevy can provision virtual machines on AWS Lightsail using the lightsail driver. This is a cost-effective solution for preview environments, with provisioning times typically around 2 minutes.

  11. Route preview environment traffic via the Preevy Tunnel Server

    Services in provisioned environments are not exposed directly to the internet; instead, they are accessed via a tunnel created by the Tunnel Server. While Livecycle provides a default SaaS Tunnel Server at livecycle.run, the Tunnel Server is open-source and can be self-hosted on your own infrastructure to maintain control over request metadata and logs.
    # Specify a custom tunnel server address during execution
--tunnel-url <your-tunnel-server-address>

  12. Provision VMs on GCP using the Preevy GCE driver

    Preevy uses the gce driver to provision virtual machines on Google Compute Engine. By default, it uses the e2-small machine size (2GB RAM, 2vCPU).