Skip to content

Commit

Permalink
Prepare docs for AWS re:Invent release (#883)
Browse files Browse the repository at this point in the history
* re-align cloud pods documentation

* add security testing intro and IAM enforcement guide

* add docs for explainable IAM

* add a stub for live policy streams

* add docs for ephemeral instance

* rename ci section

* add docs for ephemeral previews

* add docs for loading cloud pods to ephemeral instance

* improve extensions index docs

* Update live policy stream doc with getting started

* Update live policy stream with Web App

* chaos engineering section in user guides: FIS experiment for devs; FIS experiment for architects; outages for infra team (WIP); FIS on webapp template (pending UI PR)

* remove webapp section;add outages example;add extra configurations

* final corrections & add regional outage FIS experiment

* replace screenshot with bash in outages page

* fix broken links

* rewrite chaos engg. section (1)

* rewrite chaos engg. section (2)

* rewrite chaos engg. section (3)

* rewrite chaos engg. section (3)

* rewrite live policy stream doc

* Update content/en/user-guide/security-testing/live-policy-stream/index.md

Co-authored-by: Daniel Fangl <[email protected]>

* Update content/en/user-guide/security-testing/live-policy-stream/index.md

Co-authored-by: Daniel Fangl <[email protected]>

* Update content/en/user-guide/security-testing/live-policy-stream/index.md

Co-authored-by: Daniel Fangl <[email protected]>

* Update content/en/user-guide/security-testing/live-policy-stream/index.md

Co-authored-by: Daniel Fangl <[email protected]>

* Update content/en/user-guide/security-testing/live-policy-stream/index.md

Co-authored-by: Daniel Fangl <[email protected]>

* Update content/en/user-guide/security-testing/live-policy-stream/index.md

Co-authored-by: Daniel Fangl <[email protected]>

* rewrite cloud sandbox docs

* rename IAM policy stream path

* fix final nits for security testing

* remove deployments

* re-write fis experiments doc

* move web app dashboard to its own page

* add docs for ci analytics

* remove visibility docs for cloud pods

---------

Co-authored-by: Nancy Chauhan <[email protected]>
Co-authored-by: AncaGhenade <[email protected]>
Co-authored-by: Daniel Fangl <[email protected]>
  • Loading branch information
4 people authored Nov 16, 2023
1 parent e72c11c commit 9b227b6
Show file tree
Hide file tree
Showing 62 changed files with 1,772 additions and 226 deletions.
4 changes: 2 additions & 2 deletions 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 Browser](https://docs.localstack.cloud/user-guide/web-application/cloud-pods-browser/)
- [Cloud Pods Documentation]({{< ref "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 @@ -108,7 +108,7 @@ <h5 class="card-title"><i class="fa fa-book"></i> Featured guides and articles</
<div class="card-text">
<ul>
<li><a href="{{< ref "getting-started/auth-token" >}}">How do I get started with a LocalStack auth token?</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 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
4 changes: 4 additions & 0 deletions content/en/tutorials/ecs-ecr-container-app/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@ ECS tasks can pull container images from ECR repositories and are customizable u
## Prerequisites

- [LocalStack Pro](https://localstack.cloud/pricing/)
<<<<<<< HEAD
- [awslocal]({{< ref "aws-cli#localstack-aws-cli-awslocal" >}})
=======
- [awslocal](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
>>>>>>> 6a2182110 (fix broken links)
- [Docker](https://docker.io/)
- [`cURL`](https://curl.se/download.html)

Expand Down
4 changes: 4 additions & 0 deletions content/en/tutorials/elb-load-balancing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,11 @@ In this tutorial we focus on the Application Load Balancer (ALB), which operates
- LocalStack Pro
- [Serverless framework](https://www.serverless.com/framework/docs/getting-started/)
- [Node.js & `npm`](https://nodejs.org/en/download/)
<<<<<<< HEAD
- [awslocal]({{< ref "aws-cli#localstack-aws-cli-awslocal" >}})
=======
- [`awslocal`](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
>>>>>>> 6a2182110 (fix broken links)
- `cURL` & `jq`

## Setup a Serverless project
Expand Down
4 changes: 4 additions & 0 deletions content/en/tutorials/java-notification-app/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,11 @@ For this tutorial, you will need:

- [LocalStack Pro](https://localstack.cloud/pricing/) to emulate the AWS services (SNS, SQS, SES, etc) locally
- Don't worry, if you don't have a subscription yet, you can just get a trial license for free.
<<<<<<< HEAD
- [awslocal]({{< ref "aws-cli#localstack-aws-cli-awslocal" >}})
=======
- [awslocal](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
>>>>>>> 6a2182110 (fix broken links)
- [Docker](https://docker.io/)
- Java 11+
- Maven 3+
Expand Down
4 changes: 4 additions & 0 deletions content/en/tutorials/lambda-ecr-container-images/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@ leadimage: "lambda-ecr-container-images-featured-image.png"
Before diving into this tutorial, make sure you have the following prerequisites:

- LocalStack Pro
<<<<<<< HEAD
- [awslocal]({{< ref "aws-cli#localstack-aws-cli-awslocal" >}})
=======
- [`awslocal` CLI](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
>>>>>>> 6a2182110 (fix broken links)
- [Python](https://www.python.org/downloads/)
- [Docker](https://docker.io/)

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/auth-token" >}}) 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 All @@ -44,7 +44,11 @@ We will then create a Cloud Pod to save the state of our LocalStack instance and
For this tutorial, you will need the following:

- [LocalStack Pro](https://localstack.cloud/pricing/)
<<<<<<< HEAD
- [awslocal]({{< ref "aws-cli#localstack-aws-cli-awslocal" >}})
=======
- [`awslocal` CLI](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
>>>>>>> 6a2182110 (fix broken links)
- [Optical recognition of handwritten digits dataset](https://archive.ics.uci.edu/ml/datasets/Optical+Recognition+of+Handwritten+Digits)

If you don't have a subscription to LocalStack Pro, you can request a trial license upon sign-up. For this tutorial to work, you must have the LocalStack CLI installed, which must be version 1.3 or higher. The Cloud Pods CLI is shipped with the LocalStack CLI, so you don't need to install it separately.
Expand Down
8 changes: 8 additions & 0 deletions content/en/tutorials/schema-evolution-glue-msk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ leadimage: "schema-evolution-glue-msk-featured-image.png"

[Apache Kafka](https://kafka.apache.org/) is an open-source distributed event store and stream-processing platform. It is used to capture data generated by producers and distribute it among its consumers. Kafka is known for its scalability, with reports of production environments scaling to [trillions of messages per day](https://engineering.linkedin.com/blog/2019/apache-kafka-trillion-messages). With [Amazon Managed Streaming for Apache Kafka (MSK)](https://aws.amazon.com/msk/), AWS provides a service to provision Apache Kafka clusters easily.

<<<<<<< HEAD
[LocalStack Pro](https://app.localstack.cloud/) supports [Amazon Managed Streaming for Kafka (MSK)]({{< ref "managed-streaming-for-kafka" >}}), which enables you to spin up Kafka clusters on your local machine and test the integration of your applications with Amazon MSK.
=======
[LocalStack Pro](https://app.localstack.cloud/) supports [Amazon Managed Streaming for Kafka (MSK)](https://docs.localstack.cloud/user-guide/aws/managed-streaming-for-kafka/), which enables you to spin up Kafka clusters on your local machine and test the integration of your applications with Amazon MSK.
>>>>>>> 6a2182110 (fix broken links)
Kafka clusters are often used as the central messaging infrastructure in complex microservice environments.
However, the continuous and independent development of the individual microservices - the data producers and consumers - can make it hard to coordinate and evolve data schemas over time without introducing application failures due to incompatibilities. A common solution to this problem is to use a schema registry which provides for the validation of schema changes, preventing any unsafe changes and subsequent application failures.
Expand Down Expand Up @@ -54,7 +58,11 @@ For this tutorial you will need:

- [LocalStack Pro](https://localstack.cloud/pricing/) to emulate Amazon MSK and AWS Glue Schema Registry locally
- Don't worry, if you don't have a subscription yet, you can just get a trial license for free.
<<<<<<< HEAD
- [awslocal]({{< ref "aws-cli#localstack-aws-cli-awslocal" >}})
=======
- [awslocal](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
>>>>>>> 6a2182110 (fix broken links)
- Java 11+
- Maven 3

Expand Down
Loading

0 comments on commit 9b227b6

Please sign in to comment.