Skip to content

Commit

Permalink
add a basic doc for ephemeral instances (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
HarshCasper authored Aug 12, 2024
1 parent ba19321 commit 0ee96a9
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@
go.work

.idea/

node_modules
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions content/en/user-guide/ephemeral-instances/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Ephemeral Instances"
linkTitle: "Ephemeral Instances"
weight: 14
description: Get started with Ephemeral Instances in LocalStack for Snowflake
---

## Introduction

Ephemeral Instances allows you to run a LocalStack for Snowflake instance in the cloud. You can interact with these instances by configuring your Snowflake host with the endpoint URL of the ephemeral instance.

{{< alert title="Note" >}}
Ephemeral Instances is offered as a **preview** feature and under active development.
{{< /alert >}}

## Getting started

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, choose **LocalStack Snowflake (preview)**, select the lifetime of the instance by dragging the slider, and click on **Launch**.

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

After the ephemeral instance is created, you can run the following command to verify the status of the instance:

{{< command >}}
$ export SNOWFLAKE_HOST=<ephemeral-instance-endpoint>
$ curl -d '{}' $SNOWFLAKE_HOST/session
{{< /command >}}

You can access the Ephemeral Instance via the SnowSQL or any alternative SQL client by configuring the Snowflake host with the endpoint URL of the Ephemeral Instance.

0 comments on commit 0ee96a9

Please # to comment.