diff --git a/content/en/user-guide/cloud-sandbox/ephemeral-instance/cloud-pod-details-page.png b/content/en/user-guide/cloud-sandbox/ephemeral-instance/cloud-pod-details-page.png deleted file mode 100644 index 7f249ef4b5..0000000000 Binary files a/content/en/user-guide/cloud-sandbox/ephemeral-instance/cloud-pod-details-page.png and /dev/null differ diff --git a/content/en/user-guide/cloud-sandbox/ephemeral-instance/credit-consumption.png b/content/en/user-guide/cloud-sandbox/ephemeral-instance/credit-consumption.png new file mode 100644 index 0000000000..03e6444676 Binary files /dev/null and b/content/en/user-guide/cloud-sandbox/ephemeral-instance/credit-consumption.png differ diff --git a/content/en/user-guide/cloud-sandbox/ephemeral-instance/ephemeral-instance-creation.png b/content/en/user-guide/cloud-sandbox/ephemeral-instance/ephemeral-instance-creation.png index f77c5887d1..63a14e4671 100644 Binary files a/content/en/user-guide/cloud-sandbox/ephemeral-instance/ephemeral-instance-creation.png and b/content/en/user-guide/cloud-sandbox/ephemeral-instance/ephemeral-instance-creation.png differ diff --git a/content/en/user-guide/cloud-sandbox/ephemeral-instance/index.md b/content/en/user-guide/cloud-sandbox/ephemeral-instance/index.md index 3cf509b653..9ddc21410d 100644 --- a/content/en/user-guide/cloud-sandbox/ephemeral-instance/index.md +++ b/content/en/user-guide/cloud-sandbox/ephemeral-instance/index.md @@ -7,12 +7,11 @@ description: Create an Ephemeral Instance in the cloud using the LocalStack Web ## 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. +Ephemeral Instances allows you to run a LocalStack instance in the cloud. +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. -{{< callout >}} -Ephemeral Instance is available on invite-only preview. -If you'd like to try it out, please [contact us](https://www.localstack.cloud/demo) to request access. +{{< callout "note" >}} +Ephemeral Instances is offered as a **preview** feature and under active development. {{< /callout >}} ## Getting started @@ -22,33 +21,33 @@ In this guide, we will create an Ephemeral Instance and interact with it via the ### 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. +Navigate to the [**LocalStack Ephemeral Instance Management**](https://app.localstack.cloud/instances/ephemeral) page. +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**. Creating an Ephemeral Instance -You will be able to specify the name of the new Epheemeral Instance. -Click on **Create Instance** to create the new Ephemeral Instance. +Optionally, you can specify a LocalStack Extension to be installed or loaded in the Ephemeral Instance. +You can select the extension from the **Extension settings** dropdown list before launching the Ephemeral Instance. +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. ### 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. +After the Ephemeral Instance is created, you will be able to see the instance in the **LocalStack Instance Management** page. -LocalStack Ephemeral Instance - -You will also be able to access the following with your Ephemeral Instance: +You will also be able to access the following features with your Ephemeral Instance: - Status Page - Resource Browser - State Management - Extensions -LocalStack Ephemeral Instance Resource Browser +LocalStack Ephemeral Instance ### 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. +Copy the endpoint URL and set it as the `--endpoint-url` parameter in the AWS CLI command. To create an S3 bucket in the Ephemeral Instance, run the following command: @@ -63,25 +62,27 @@ To query the list of S3 buckets in the Ephemeral Instance, run the following com $ aws --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. +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. +In these integrations, you can change the `AWS_ENDPOINT_URL` environment variable to the endpoint URL of the Ephemeral Instance. -### Remove the Ephemeral Instance +### Shut Down the Ephemeral Instance -You can delete the Ephemeral Instance by clicking on the **Remove** button in the **LocalStack Instance Management** page. -These instances are automatically terminated after 90 minutes, in case you don`t remove them manually. +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. -## Load Cloud Pod into an Ephmeral Instance +Shutdown the LocalStack Ephemeral Instance -You can load a Cloud Pod into an Ephemeral Instance to seed your pre-existing cloud resources into a freshly created Ephemeral Instance. -You can further use AWS CLI or other integrations to interact with these resources, along with using other features of the LocalStack Web Application. +{{< callout "warning" >}} +Ephemeral Instances, by default, are created with the latest version of LocalStack. +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. +{{< /callout >}} -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. -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. +## Credit Consumption -Cloud Pod Details page -

+Ephemeral Instances consume credits based on the resources used and the duration of the instance. +You can view the credit consumption of the Ephemeral Instance in the **Ephemeral Instance** page. +Currently, for every 1 credit, you can run an Ephemeral Instance for 1 minute. +You can view the available minutes under the **Lifetime in minutes** slider when creating an Ephemeral Instance. +You can also see the credit consumption in the **Credit Consumption** section of the Ephemeral Instance page. -Click **Continue** to start the Ephemeral Instance and load the Cloud Pod. -You will be able to see the Ephemeral Instance on the sidebar. -You can copy the endpoint URL of the Ephemeral Instance and use it to manage your cloud resources. +Credit Consumption +

diff --git a/content/en/user-guide/cloud-sandbox/ephemeral-instance/localstack-ephemeral-instance-resource-browser.png b/content/en/user-guide/cloud-sandbox/ephemeral-instance/localstack-ephemeral-instance-resource-browser.png deleted file mode 100644 index 932543c34e..0000000000 Binary files a/content/en/user-guide/cloud-sandbox/ephemeral-instance/localstack-ephemeral-instance-resource-browser.png and /dev/null differ diff --git a/content/en/user-guide/cloud-sandbox/ephemeral-instance/localstack-ephemeral-instance.png b/content/en/user-guide/cloud-sandbox/ephemeral-instance/localstack-ephemeral-instance.png index dbd9e2b15a..30999d1d97 100644 Binary files a/content/en/user-guide/cloud-sandbox/ephemeral-instance/localstack-ephemeral-instance.png and b/content/en/user-guide/cloud-sandbox/ephemeral-instance/localstack-ephemeral-instance.png differ diff --git a/content/en/user-guide/cloud-sandbox/ephemeral-instance/shutdown-ephemeral-instance.png b/content/en/user-guide/cloud-sandbox/ephemeral-instance/shutdown-ephemeral-instance.png new file mode 100644 index 0000000000..49c7511e42 Binary files /dev/null and b/content/en/user-guide/cloud-sandbox/ephemeral-instance/shutdown-ephemeral-instance.png differ