Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Commit ecde7b0

Browse files
authored
revamp ephemeral instance docs (#1387)
1 parent 70e1dbe commit ecde7b0

File tree

7 files changed

+30
-29
lines changed

7 files changed

+30
-29
lines changed
Binary file not shown.
Loading
Loading

content/en/user-guide/cloud-sandbox/ephemeral-instance/index.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@ description: Create an Ephemeral Instance in the cloud using the LocalStack Web
77

88
## Introduction
99

10-
LocalStack Ephemeral Instance allows you to run an LocalStack instance in the cloud.
11-
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.
10+
Ephemeral Instances allows you to run a LocalStack instance in the cloud.
11+
You can interact with these instances via the LocalStack Web Application, or by configuring your integrations and developer tools with the endpoint URL of the ephemeral instance.
1212

13-
{{< callout >}}
14-
Ephemeral Instance is available on invite-only preview.
15-
If you'd like to try it out, please [contact us](https://www.localstack.cloud/demo) to request access.
13+
{{< callout "note" >}}
14+
Ephemeral Instances is offered as a **preview** feature and under active development.
1615
{{< /callout >}}
1716

1817
## Getting started
@@ -22,33 +21,33 @@ In this guide, we will create an Ephemeral Instance and interact with it via the
2221

2322
### Create a new Ephemeral Instance
2423

25-
Navigate to the [**LocalStack Instance Management**](https://app.localstack.cloud/instances) and click on the **Ephemeral (Team)** tab.
26-
Click on the **Create Ephemeral Instance** button.
24+
Navigate to the [**LocalStack Ephemeral Instance Management**](https://app.localstack.cloud/instances/ephemeral) page.
25+
In the form, enter the name of the new Ephemeral Instance, select the lifetime of the instance by dragging the slider, and click on **Launch**.
2726

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

30-
You will be able to specify the name of the new Epheemeral Instance.
31-
Click on **Create Instance** to create the new Ephemeral Instance.
29+
Optionally, you can specify a LocalStack Extension to be installed or loaded in the Ephemeral Instance.
30+
You can select the extension from the **Extension settings** dropdown list before launching the Ephemeral Instance.
31+
In case you have access to Cloud Pods and a pod you want to start your instance with, you can also choose it from the **Cloud Pod Settings** dropdown.
3232

3333
### Interact with the Ephemeral Instance
3434

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

37-
<img src="localstack-ephemeral-instance.png" alt="LocalStack Ephemeral Instance" title="LocalStack Ephemeral Instance" width="800" />
38-
39-
You will also be able to access the following with your Ephemeral Instance:
37+
You will also be able to access the following features with your Ephemeral Instance:
4038

4139
- Status Page
4240
- Resource Browser
4341
- State Management
4442
- Extensions
4543

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

4846
### Access the Ephemeral Instance via AWS CLI
4947

5048
You can access the Ephemeral Instance via the AWS CLI by configuring the AWS CLI with the endpoint URL of the Ephemeral Instance.
5149
You can find the endpoint URL of the Ephemeral Instance in the **LocalStack Instance Management** page.
50+
Copy the endpoint URL and set it as the `--endpoint-url` parameter in the AWS CLI command.
5251

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

@@ -63,25 +62,27 @@ To query the list of S3 buckets in the Ephemeral Instance, run the following com
6362
$ aws --endpoint-url=<EPHEMERAL_INSTANCE_ENDPOINT_URL> s3 ls
6463
{{< /command >}}
6564

66-
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.
67-
In these integrations, you can change the `LOCALSTACK_HOSTNAME` environment variable to the endpoint URL of the Ephemeral Instance.
65+
You can also 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.
66+
In these integrations, you can change the `AWS_ENDPOINT_URL` environment variable to the endpoint URL of the Ephemeral Instance.
6867

69-
### Remove the Ephemeral Instance
68+
### Shut Down the Ephemeral Instance
7069

71-
You can delete the Ephemeral Instance by clicking on the **Remove** button in the **LocalStack Instance Management** page.
72-
These instances are automatically terminated after 90 minutes, in case you don`t remove them manually.
70+
You can shut down the instance by navigating to the [Ephemeral Instances page](https://app.localstack.cloud/instances/ephemeral) and clicking on the **Shut Down** button.
7371

74-
## Load Cloud Pod into an Ephmeral Instance
72+
<img src="shutdown-ephemeral-instance.png" alt="Shutdown the LocalStack Ephemeral Instance" title="Shutdown the LocalStack Ephemeral Instance" width="800" />
7573

76-
You can load a Cloud Pod into an Ephemeral Instance to seed your pre-existing cloud resources into a freshly created Ephemeral Instance.
77-
You can further use AWS CLI or other integrations to interact with these resources, along with using other features of the LocalStack Web Application.
74+
{{< callout "warning" >}}
75+
Ephemeral Instances, by default, are created with the latest version of LocalStack.
76+
If you have created a Cloud Pod from an older version of LocalStack, you need to update the Cloud Pod to the latest version before loading it into an Ephemeral Instance.
77+
{{< /callout >}}
7878

79-
To load a pre-defined Cloud Pod, navigate to the **Cloud Pods Details** for the specific Cloud Pod and click on the **Browse Version** button.
80-
Clicking on the button will open a modal where you will be asked to confirm that this will start a new LocalStack instance and load the selected Cloud Pod version.
79+
## Credit Consumption
8180

82-
<img src="cloud-pod-details-page.png" alt="Cloud Pod Details page" title="Cloud Pod Details page" width="800" />
83-
<br><br>
81+
Ephemeral Instances consume credits based on the resources used and the duration of the instance.
82+
You can view the credit consumption of the Ephemeral Instance in the **Ephemeral Instance** page.
83+
Currently, for every 1 credit, you can run an Ephemeral Instance for 1 minute.
84+
You can view the available minutes under the **Lifetime in minutes** slider when creating an Ephemeral Instance.
85+
You can also see the credit consumption in the **Credit Consumption** section of the Ephemeral Instance page.
8486

85-
Click **Continue** to start the Ephemeral Instance and load the Cloud Pod.
86-
You will be able to see the Ephemeral Instance on the sidebar.
87-
You can copy the endpoint URL of the Ephemeral Instance and use it to manage your cloud resources.
87+
<img src="credit-consumption.png" alt="Credit Consumption" title="Credit Consumption" width="800" />
88+
<br><br>
Loading
Loading

0 commit comments

Comments
 (0)