Skip to content

Commit

Permalink
re-align cloud pods documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
HarshCasper committed Nov 1, 2023
1 parent d60b110 commit 31333c3
Show file tree
Hide file tree
Showing 21 changed files with 25 additions and 13 deletions.
2 changes: 1 addition & 1 deletion content/en/academy/localstack-101/lesson-7/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ Witness firsthand how they empower developers in various scenarios, especially f
<br/>
Further reading:

- [Cloud Pods Documentation](https://docs.localstack.cloud/user-guide/tools/cloud-pods/)
- [Cloud Pods Documentation](https://docs.localstack.cloud/user-guide/cloud-pods/)
- [Cloud Pods Browser](https://docs.localstack.cloud/user-guide/web-application/cloud-pods-browser/)
2 changes: 1 addition & 1 deletion content/en/getting-started/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ hide_readingtime: true

| Term | Definition |
|---------------------------------------------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Cloud Pods]({{< ref "user-guide/tools/cloud-pods" >}}) | Advanced persistence mechanism that allows to take a snapshot of the state of your LocalStack instance, as well as easily share the application state to enable collaborative debugging. |
| [Cloud Pods]({{< ref "user-guide/cloud-pods" >}}) | Advanced persistence mechanism that allows to take a snapshot of the state of your LocalStack instance, as well as easily share the application state to enable collaborative debugging. |
| [Diagnostics Endpoint]({{< ref "help-and-support" >}}) | The endpoint on the running LocalStack Container that prints diagnostic data about LocalStack to assist with debugging and troubleshooting. |
| [Edge Port]({{< ref "endpoint-url" >}}) | The HTTP port LocalStack listens on for any type of request (e.g. from AWS SDKs). The default port is 4566. |
| [External Service Ports]({{< ref "external-ports" >}}) | The ports reserved for infrastructure that is started as part of a managed service like database server, Redis cluster, and are exposed through the LocalStack Container. |
Expand Down
2 changes: 1 addition & 1 deletion content/en/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Now that you’ve seen how to deploy a local AWS infrastructure for your sample
$ localstack stop
{{< / command >}}

LocalStack is ephemeral in nature and will not persist any data across restarts. LocalStack runs inside a Docker container and once it is spinned down, all the locally created resources are removed automatically. To persist data across restarts, consider looking at our [persistence mechanism documentation]({{< ref "references/persistence-mechanism" >}}) or [Cloud Pods]({{< ref "user-guide/tools/cloud-pods" >}}), our next generation state management utility.
LocalStack is ephemeral in nature and will not persist any data across restarts. LocalStack runs inside a Docker container and once it is spinned down, all the locally created resources are removed automatically. To persist data across restarts, consider looking at our [persistence mechanism documentation]({{< ref "references/persistence-mechanism" >}}) or [Cloud Pods]({{< ref "user-guide/cloud-pods" >}}), our next generation state management utility.

## Next Steps

Expand Down
2 changes: 1 addition & 1 deletion content/en/overview/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h5 class="card-title"><i class="fa fa-book"></i> Featured guides and articles</
<div class="card-text">
<ul>
<li><a href="{{< ref "api-key" >}}">How do I get started with a LocalStack API key?</a></li>
<li><a href="{{< ref "user-guide/tools/cloud-pods" >}}">What are Local Cloud Pods and how do I use them?</a></li>
<li><a href="{{< ref "user-guide/cloud-pods" >}}">What are Local Cloud Pods and how do I use them?</a></li>
<li><a href="{{< ref "lambda-tools" >}}">How LocalStack improves your Lambda developer experience</a></li>
<li><a href="{{< ref "feature-coverage" >}}">Which AWS services does LocalStack support?</a></li>
<li><a href="{{< ref "user-guide/integrations/serverless-framework" >}}">How do I use the Serverless Framework with LocalStack?</a></li>
Expand Down
2 changes: 1 addition & 1 deletion content/en/references/init-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ which returns either `true` or `false`.
## Usage example

A common use case for init hooks is pre-seeding LocalStack with custom state.
If you have more complex state, [Cloud Pods]({{< ref `user-guide/tools/cloud-pods` >}}) may be a good option to look into!
If you have more complex state, [Cloud Pods]({{< ref `user-guide/cloud-pods` >}}) may be a good option to look into!
But for simple state, for example if you want to have a certain S3 bucket or DynamoDB table created when starting LocalStack, init hooks can be very useful.

To execute aws cli commands when LocalStack becomes ready,
Expand Down
2 changes: 1 addition & 1 deletion content/en/references/persistence-mechanism.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ LocalStack has two distinct persistence mechanisms
* **Cloud Pods**: a way to store, distribute, inspect, and version snapshots.

This document is concerned with snapshot-based persistence.
To learn more about cloud pods and their use cases, please refer to our documentation on [**Cloud pods**]({{< ref "user-guide/tools/cloud-pods">}}).
To learn more about cloud pods and their use cases, please refer to our documentation on [**Cloud pods**]({{< ref "user-guide/cloud-pods">}}).

## Snapshot-based persistence

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ pro: true
leadimage: "reproducible-machine-learning-cloud-pods-featured-image.png"
---

[LocalStack Cloud Pods]({{< ref "user-guide/tools/cloud-pods" >}}) enable you to create persistent state snapshots of your LocalStack instance, which can then be versioned, shared, and restored. It allows next-generation state management and team collaboration for your local cloud development environment, which you can utilize to create persistent shareable cloud sandboxes. Cloud Pods works directly with the [LocalStack CLI]({{< ref "getting-started/installation#localstack-cli" >}}) to save, merge, and restore snapshots of your LocalStack state. You can always tear down your LocalStack instance and restore it from a snapshot at any point in time.
[LocalStack Cloud Pods]({{< ref "user-guide/cloud-pods" >}}) enable you to create persistent state snapshots of your LocalStack instance, which can then be versioned, shared, and restored. It allows next-generation state management and team collaboration for your local cloud development environment, which you can utilize to create persistent shareable cloud sandboxes. Cloud Pods works directly with the [LocalStack CLI]({{< ref "getting-started/installation#localstack-cli" >}}) to save, merge, and restore snapshots of your LocalStack state. You can always tear down your LocalStack instance and restore it from a snapshot at any point in time.

Cloud Pods is supported by both [LocalStack Pro](https://app.localstack.cloud/) and [LocalStack Community](https://github.com/localstack/localstack). Using [Community Cloud Pods]({{< ref "user-guide/tools/cloud-pods/community" >}}), you get a limited experience saving and loading your LocalStack state in a Cloud Pod, only with the AWS services emulated in the Community Edition. With LocalStack Pro, you can utilize an extended CLI that allows you to inspect your Cloud Pods, version them using tags, and push them to the LocalStack platform for storage and collaboration.
Cloud Pods is supported by both [LocalStack Pro](https://app.localstack.cloud/) and [LocalStack Community](https://github.com/localstack/localstack). Using [Community Cloud Pods]({{< ref "user-guide/cloud-pods/community" >}}), you get a limited experience saving and loading your LocalStack state in a Cloud Pod, only with the AWS services emulated in the Community Edition. With LocalStack Pro, you can utilize an extended CLI that allows you to inspect your Cloud Pods, version them using tags, and push them to the LocalStack platform for storage and collaboration.

In this tutorial, we will use [LocalStack Pro]({{< ref "getting-started/api-key" >}}) to train a simple machine-learning model that recognizes handwritten digits on an image. We will rely on Cloud Pods to create a reproducible sample by using:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Cloud Pods"
weight: 10
description: >
Cloud Pods provides a new way of collaborating in cloud application development workflows.
aliases:
- /user-guide/tools/
---

## Introduction
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Community Cloud Pods"
weight: 99
description: >
Get started with LocalStack Community Cloud Pods to to save and load your container state at will
aliases:
- /user-guide/tools/
---

{{< alert title="Note" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Getting started"
weight: 3
description: Get started with Cloud Pods to manage the state of your LocalStack instance state
aliases:
- /user-guide/tools/
---

Using the LocalStack Cloud Pods command-line interface (CLI) via the `pod` command enables you to create and manage cloud pods directly from your terminal. The Cloud Pods CLI is particularly useful in these scenarios:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Launchpad"
weight: 10
description: Get started with Cloud Pods Launchpad to share and inject Cloud Pods into your LocalStack instance via a URL
aliases:
- /user-guide/tools/
---

The LocalStack Cloud Pods Launchpad enables you to easily share and inject Cloud Pods into a LocalStack instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "CLI command reference"
weight: 4
description: >
Reference guide for LocalStack Cloud Pods CLI commands and how to get started on using them!
aliases:
- /user-guide/tools/
---

This reference provides descriptions and example commands for LocalStack Cloud Pods CLI (`pod`) commands.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Remotes"
weight: 5
description: The reference guide for LocalStack Cloud Pods remotes and how to get started on using them!
aliases:
- /user-guide/tools/
---

A remote is the location where Cloud Pods are stored. By default, Cloud Pod artifacts are stored in the LocalStack platform. However, if your organization's data regulations or sovereignty requirements prohibit storing Cloud Pod assets in a remote storage infrastructure, you have the option to persist Cloud Pods in an on-premises storage location under your complete control.
Expand Down
2 changes: 1 addition & 1 deletion content/en/user-guide/web-application/accounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: >
LocalStack Accounts allow you to manage your resources & configurations, and serve as an entry point to our Web Application, the Pro CLI, and more!
---

To start using LocalStack's Web Application, you must create an account. With a LocalStack account, you can sign-up for a license and use your API keys to access our advanced features. These include [AWS services]({{< ref "references/coverage" >}}) marked under **Pro**, [Stack Insights]({{< ref "stack-insights" >}}), [Cloud Pods]({{< ref "user-guide/tools/cloud-pods" >}}), and more!
To start using LocalStack's Web Application, you must create an account. With a LocalStack account, you can sign-up for a license and use your API keys to access our advanced features. These include [AWS services]({{< ref "references/coverage" >}}) marked under **Pro**, [Stack Insights]({{< ref "stack-insights" >}}), [Cloud Pods]({{< ref "user-guide/cloud-pods" >}}), and more!

## Creating an account

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ description: >
[The Cloud Pods Browser](https://app.localstack.cloud/pods) lets you access and manage all your Cloud Pods. The Cloud Pods Browser is a feature of our LocalStack Web Application that is exclusive to **LocalStack Team & Enterprise users**.

With Cloud Pods, you can have individual or shared ownership of a snapshot of your LocalStack instance.
The LocalStack CLI allows you to create new Cloud Pods and configure their [visibility settings](https://docs.localstack.cloud/user-guide/tools/cloud-pods/pods-cli/#save).
The LocalStack CLI allows you to create new Cloud Pods and configure their [visibility settings](https://docs.localstack.cloud/user-guide/cloud-pods/pods-cli/#save).

<img src="cloud-pods-browser.png" alt="LocalStack Web Application's Cloud Pods Browser outlining various saved Clod Pods" title="Cloud Pods Browser" width="900" />

## Usage

You can use [Cloud Pods](https://docs.localstack.cloud/user-guide/tools/cloud-pods/) to manage your local AWS infrastructure and collaborate with others:
You can use [Cloud Pods](https://docs.localstack.cloud/user-guide/cloud-pods/) to manage your local AWS infrastructure and collaborate with others:

- Cloud Pods are accessible to all LocalStack Team users in your organization namespace. Public Cloud Pods are accessible to all LocalStack users.
- Cloud Pods version history is available, which allows you to view the version history of a Cloud Pod and access previous versions of specific Cloud Pods.
- Cloud Pods can be made public, injected into a running LocalStack container, or deleted - all from the LocalStack Web Application.

{{< alert title="Warning" color="warning">}}
LocalStack Pro users cannot access the Cloud Pods Browser. Community & Pro users can use the [Community Cloud Pods](https://docs.localstack.cloud/user-guide/tools/cloud-pods/community/) and save their Cloud Pods locally or share them via a GitHub/GitLab repository. The [Cloud Pods launchpad](https://docs.localstack.cloud/user-guide/tools/cloud-pods/launchpad/) can be used to inject a Cloud Pod into a running LocalStack container through a simple click.
LocalStack Pro users cannot access the Cloud Pods Browser. Community & Pro users can use the [Community Cloud Pods](https://docs.localstack.cloud/user-guide/cloud-pods/community/) and save their Cloud Pods locally or share them via a GitHub/GitLab repository. The [Cloud Pods launchpad](https://docs.localstack.cloud/user-guide/cloud-pods/launchpad/) can be used to inject a Cloud Pod into a running LocalStack container through a simple click.
{{< /alert >}}

## Access the version history
Expand All @@ -31,7 +31,7 @@ To view the version history of a Cloud Pod, click on the Cloud Pod's name in the

<img src="cloud-pods-version-history.png" alt="LocalStack Web Application's Cloud Pods Browser outlining the versions of the Clod Pod" title="Cloud Pods Browser displaying the version history of the Cloud Pod" width="900" />

To create a new version of a Cloud Pod, refer to the [Cloud Pods CLI](https://docs.localstack.cloud/user-guide/tools/cloud-pods/pods-cli/#save) documentation.
To create a new version of a Cloud Pod, refer to the [Cloud Pods CLI](https://docs.localstack.cloud/user-guide/cloud-pods/pods-cli/#save) documentation.

## Save a Cloud Pod

Expand Down

0 comments on commit 31333c3

Please sign in to comment.