Skip to content

Commit

Permalink
add docs for ephemeral instance
Browse files Browse the repository at this point in the history
  • Loading branch information
HarshCasper committed Nov 4, 2023
1 parent a861f67 commit fbb3ee6
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 0 deletions.
17 changes: 17 additions & 0 deletions content/en/user-guide/ephemeral-environments/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Ephemeral Environments"
linkTitle: "Ephemeral Environments"
weight: 12
description: >
Ephemeral Environments allows you to run a LocalStack instance on cloud and access it from your local machine.
cascade:
type: docs
---

## Introduction

LocalStack Ephemeral Environments allow you to run an LocalStack instance in the cloud. Ephemeral Environments in LocalStack encompasses the following features:

- Deploy LocalStack as a cloud sandbox for dev&test loops without running it locally.
- Create easy previews by enabling preview-per-PR type workflows for application change.
- Facilitate collaboration by allowing developers to test features on the same environment.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: "Ephemeral Instances"
linkTitle: "Ephemeral Instances"
weight: 1
description: Create an Ephemeral Instance in the cloud using the LocalStack Web Application
---

## Introduction

LocalStack Ephemeral Instance allows you to run an LocalStack instance in the cloud. You can interact with these remote instances via the LocalStack Web Application, or by configuring your integrations and developer tools with the endpoint URL of the remote instance. These instances are terminated after 90 minutes.

## Getting started

This guide is designed for users new to Ephemeral Instance and assumes basic knowledge of the LocalStack Web Application. In this guide, we will create an Ephemeral Instance and interact with it via the LocalStack Web Application and the AWS CLI.

### Create a new Ephemeral Instance

Navigate to the [**LocalStack Instance Management**](https://app.localstack.cloud/instances) and click on the **Ephemeral (Team)** tab. Click on the **Create Ephemeral Instance** button.

<img src="ephemeral-instance-creation.png" alt="Creating an Ephemeral Instance" title="Creating an Ephemeral Instance" width="800" />

You will be able to specify the name of the new Epheemeral Instance. Click on **Create Instance** to create the new Ephemeral Instance.

### Interact with the Ephemeral Instance

After the Epheemeral Instance is created, you will be able to see the instance in the **LocalStack Instance Management** page.

<img src="localstack-ephemeral-instance.png" alt="LocalStack Ephemeral Instance" title="LocalStack Ephemeral Instance" width="800" />

You will also be able to access the following with your Ephemeral Instance:

- Status Page
- Resource Browser
- State Management
- Extensions

<img src="localstack-ephemeral-instance-resource-browser.png" alt="LocalStack Ephemeral Instance Resource Browser" title="LocalStack Ephemeral Instance Resource Browser" width="800" />

### Access the Ephemeral Instance via AWS CLI

You can access the Ephemeral Instance via the AWS CLI by configuring the AWS CLI with the endpoint URL of the Ephemeral Instance. You can find the endpoint URL of the Ephemeral Instance in the **LocalStack Instance Management** page.

To create an S3 bucket in the Ephemeral Instance, run the following command:

{{< command >}}
$ aws --endpoint-url=<EPHEMERAL_INSTANCE_ENDPOINT_URL> s3 mb s3://<BUCKET_NAME>
{{< /command >}}

You can replace `<EPHEMERAL_INSTANCE_ENDPOINT_URL>` with the endpoint URL of the Ephemeral Instance and `<BUCKET_NAME>` with the name of the S3 bucket you want to create. To query the list of S3 buckets in the Ephemeral Instance, run the following command:

{{< command >}}
$ aws --endpoint-url=<EPHEMERAL_INSTANCE_ENDPOINT_URL> s3 ls
{{< /command >}}

You can further use integrations, such as [CDK](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/), [SAM CLI](https://docs.localstack.cloud/user-guide/integrations/aws-sam/), and [Terraform](https://docs.localstack.cloud/user-guide/integrations/terraform/), to interact with the Ephemeral Instance. In these integrations, you can change the `LOCALSTACK_HOSTNAME` environment variable to the endpoint URL of the Ephemeral Instance.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fbb3ee6

Please sign in to comment.