From bd9abc29c70c1a6ca2b7f9d6b48304bbfcf42412 Mon Sep 17 00:00:00 2001 From: Quetzalli Writes Date: Wed, 25 Jun 2025 18:40:07 -0700 Subject: [PATCH 1/6] finished QAing Getting Started --- src/content/docs/aws/getting-started/auth-token.mdx | 4 ++-- src/content/docs/aws/getting-started/index.md | 2 +- src/content/docs/aws/getting-started/installation.mdx | 2 +- src/content/docs/aws/getting-started/quickstart.mdx | 10 +++++----- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/content/docs/aws/getting-started/auth-token.mdx b/src/content/docs/aws/getting-started/auth-token.mdx index 73f28076..4e0ddc88 100644 --- a/src/content/docs/aws/getting-started/auth-token.mdx +++ b/src/content/docs/aws/getting-started/auth-token.mdx @@ -97,7 +97,7 @@ You have the option to run your LocalStack container in the background by append The `localstack` CLI automatically detects the Auth Token and appropriately conveys it to the LocalStack container. :::note -If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image](aws/capabilities/config/docker-images/#localstack-pro-image), which includes Pro services and several advanced features. +If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image](/aws/capabilities/config/docker-images#localstack-pro-image), which includes Pro services and several advanced features. ::: ### Docker @@ -113,7 +113,7 @@ $ docker run \ localstack/localstack-pro ``` -For more information about starting LocalStack with Docker, take a look at our [Docker installation](aws/getting-started/installation/#docker) guide. +For more information about starting LocalStack with Docker, take a look at our [Docker installation](/aws/getting-started/installation/#docker) guide. ### Docker Compose diff --git a/src/content/docs/aws/getting-started/index.md b/src/content/docs/aws/getting-started/index.md index aa374b15..be2786f4 100644 --- a/src/content/docs/aws/getting-started/index.md +++ b/src/content/docs/aws/getting-started/index.md @@ -12,7 +12,7 @@ With LocalStack, you can run your AWS applications or Lambdas entirely on your l Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow. -LocalStack supports a growing number of [AWS services](/aws/) +LocalStack supports a growing number of [AWS services](/aws/services/) , like [Lambda](/aws/services/lambda), [S3](/aws/services/s3), [DynamoDB](/aws/services/dynamodb), [Kinesis](/aws/services/kinesis), [SQS](/aws/services/sqs), [SNS](/aws/services/sns), and more! [LocalStack Pro](https://localstack.cloud/pricing) supports additional APIs and advanced features to make your cloud development experience a breeze! diff --git a/src/content/docs/aws/getting-started/installation.mdx b/src/content/docs/aws/getting-started/installation.mdx index 4c5c87c0..5a93dee6 100644 --- a/src/content/docs/aws/getting-started/installation.mdx +++ b/src/content/docs/aws/getting-started/installation.mdx @@ -435,7 +435,7 @@ python3 -m localstack.cli.main #### The `localstack` CLI does not start the LocalStack container If you are using the `localstack` CLI to start LocalStack, but the container is not starting, please check the following: -- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](aws/tooling/dns-server/#system-dns-configuration) to disable it. +- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](/aws/tooling/dns-server#system-dns-configuration) to disable it. - Start LocalStack with a specific DNS address: ```bash DNS_ADDRESS=0 localstack start diff --git a/src/content/docs/aws/getting-started/quickstart.mdx b/src/content/docs/aws/getting-started/quickstart.mdx index dcf4c4cf..6e78896f 100644 --- a/src/content/docs/aws/getting-started/quickstart.mdx +++ b/src/content/docs/aws/getting-started/quickstart.mdx @@ -39,10 +39,10 @@ An internal SES LocalStack testing endpoint (`/_localstack/aws/ses`) is configur ## Prerequisites - [LocalStack CLI](/aws/getting-started/installation/#installing-localstack-cli) -- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](https://docs.localstack.cloud/getting-started/auth-token/) +- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](/aws/getting-started/auth-token/) - [Docker](https://docs.docker.com/get-docker/) - [Python 3.11+](https://www.python.org/downloads/) & `pip` -- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal) +- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper](/aws/integrations/aws-native-tools/aws-cli/#localstack-aws-cli-awslocal) - `jq`, `zip` & `curl` You can start LocalStack using the `localstack` CLI. @@ -104,7 +104,7 @@ pyenv global 3.11 ### Setup the serverless image resizer -This application enables serverless image resizing using [S3](/aws/services/s3/), [SSM](/aws/services/ssm/), [Lambda](/aws/services/lambda/), [SNS](aws/services/sns/), and [SES](/aws/services/ses/). +This application enables serverless image resizing using [S3](/aws/services/s3/), [SSM](/aws/services/ssm/), [Lambda](/aws/services/lambda/), [SNS](/aws/services/sns/), and [SES](/aws/services/ses/). A simple web interface allows users to upload and view resized images. A Lambda function generates S3 pre-signed URLs for direct uploads, while S3 bucket notifications trigger image resizing. Another Lambda function lists and provides pre-signed URLs for browser display. @@ -356,6 +356,6 @@ To expand your LocalStack capabilities, explore the following based on your expe - [Tutorials](/aws/tutorials): Check out our tutorials to learn how to use LocalStack across various AWS services and application stacks. - [Supported Services](/aws/services): Explore LocalStack's emulated AWS services. -- [Capabilities](): Learn about LocalStack's capabilities including features like IAM policy stream, state management, and more. -- [Tooling](): Get details on LocalStack's tooling and integrations. +- [Capabilities](/aws/capabilities/): Learn about LocalStack's capabilities including features like IAM policy stream, state management, and more. +- [Tooling](/aws/tooling/): Get details on LocalStack's tooling and integrations. - [Blog](https://blog.localstack.cloud): Read our blog posts about LocalStack and the latest enhancements for a better local development and testing experience. From 123b1d73065d38a0d982ccd021b096653bfc8ec7 Mon Sep 17 00:00:00 2001 From: Quetzalli Writes Date: Wed, 25 Jun 2025 22:04:39 -0700 Subject: [PATCH 2/6] finished fixing aws docs --- .../aws/capabilities/config/docker-images.md | 2 +- .../docs/aws/capabilities/config/podman.md | 4 +- .../capabilities/state-management/index.md | 2 +- .../docs/aws/enterprise/k8s-operator.md | 4 +- .../aws/enterprise/kubernetes-executor.md | 6 +- .../app-frameworks/serverless-framework.md | 2 +- .../app-frameworks/spring-cloud-function.mdx | 2 +- .../integrations/aws-native-tools/aws-cli.md | 2 +- .../aws/integrations/aws-sdks/javascript.mdx | 2 +- .../integrations/containers/devcontainers.mdx | 2 +- .../infrastructure-as-code/crossplane.md | 4 +- .../integrations/messaging/docker-compose.yml | 70 +++++++++++++++++++ .../messaging/selfmanaged-kafka-cluster.md | 4 +- .../extensions/developing-extensions.mdx | 2 +- .../docs/aws/tooling/extensions/index.md | 2 +- .../tooling/localstack-docker-extension.md | 3 +- .../docs/snowflake/getting-started/index.md | 4 +- 17 files changed, 93 insertions(+), 24 deletions(-) create mode 100644 src/content/docs/aws/integrations/messaging/docker-compose.yml diff --git a/src/content/docs/aws/capabilities/config/docker-images.md b/src/content/docs/aws/capabilities/config/docker-images.md index c346eb56..b91e6660 100644 --- a/src/content/docs/aws/capabilities/config/docker-images.md +++ b/src/content/docs/aws/capabilities/config/docker-images.md @@ -21,7 +21,7 @@ docker pull localstack/localstack:latest To use the LocalStack Community image, you don't need to sign-up for an account on [LocalStack Web Application](https://app.localstack.cloud). The Community image is free to use and does not require a license to run. -The Community image can be used to run [local AWS services](/aws/) with [integrations](/aws/integrations/) on your local machine or in your [continuous integration pipelines](/aws/integrations/continuous-integration/). +The Community image can be used to run [local AWS services](/aws/services/) with [integrations](/aws/integrations/) on your local machine or in your [continuous integration pipelines](/aws/integrations/continuous-integration/). The Community image also covers a limited set of [LocalStack Tools](/aws/tooling/) to make your life as a cloud developer easier. You can use [LocalStack Desktop](/aws/capabilities/web-app/localstack-desktop/) or [LocalStack Docker Extension](/aws/tooling/localstack-docker-extension) to use LocalStack with a graphical user interface. diff --git a/src/content/docs/aws/capabilities/config/podman.md b/src/content/docs/aws/capabilities/config/podman.md index 2b0d8497..019ac0cc 100644 --- a/src/content/docs/aws/capabilities/config/podman.md +++ b/src/content/docs/aws/capabilities/config/podman.md @@ -7,7 +7,7 @@ template: doc ## Introduction By default, the LocalStack CLI starts the LocalStack runtime inside a Docker container. -Docker may not be available on your system, and a popular alternative is [Podman](https://podman.io/getting-started/) which you can use to run LocalStack. +Docker may not be available on your system, and a popular alternative is [Podman](https://podman.io/get-started) which you can use to run LocalStack. Podman support is still experimental, and the following docs give you an overview of the current state. From the Podman docs: @@ -32,7 +32,7 @@ It creates the following links: - `/var/run/docker.sock -> /run/podman/podman.sock` This package is available for some distros: -- https://archlinux.org/packages/community/x86_64/podman-docker/ +- https://archlinux.org/packages/extra/x86_64/podman-docker/ - https://packages.ubuntu.com/oracular/podman-docker - https://packages.debian.org/sid/podman-docker diff --git a/src/content/docs/aws/capabilities/state-management/index.md b/src/content/docs/aws/capabilities/state-management/index.md index 389773eb..dc8dedbd 100644 --- a/src/content/docs/aws/capabilities/state-management/index.md +++ b/src/content/docs/aws/capabilities/state-management/index.md @@ -1,6 +1,6 @@ --- title: Overview -description: Cloud Pods provides a new way of collaborating in cloud application development workflows. +description: State Management in LocalStack allows you to save and load the state of your LocalStack instance. template: doc sidebar: order: 1 diff --git a/src/content/docs/aws/enterprise/k8s-operator.md b/src/content/docs/aws/enterprise/k8s-operator.md index 5abc2696..5a5cdc38 100644 --- a/src/content/docs/aws/enterprise/k8s-operator.md +++ b/src/content/docs/aws/enterprise/k8s-operator.md @@ -74,7 +74,7 @@ _Appears in:_ | `kind` _string_ | `LocalStack` | `kind` _string_ | Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | `spec` _[LocalStackSpec](#localstackspec)_ | | | `status` _[LocalStackStatus](#localstackstatus)_ | | @@ -88,7 +88,7 @@ LocalStackList contains a list of LocalStack | `kind` _string_ | `LocalStackList` | `kind` _string_ | Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | +| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/list-meta/)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | `items` _[LocalStack](#localstack) array_ | | #### LocalStackSpec diff --git a/src/content/docs/aws/enterprise/kubernetes-executor.md b/src/content/docs/aws/enterprise/kubernetes-executor.md index ba2a97c0..ea87a856 100644 --- a/src/content/docs/aws/enterprise/kubernetes-executor.md +++ b/src/content/docs/aws/enterprise/kubernetes-executor.md @@ -61,9 +61,9 @@ Lambda hot reloading & remote debugging are not supported in the Kubernetes exec You can run the following services on Kubernetes clusters using the LocalStack Enterprise image: -- [DocumentDB](https://docs.localstack.cloud/user-guide/aws/docdb/) -- [MWAA](https://docs.localstack.cloud/user-guide/aws/docdb/) -- [RDS](https://docs.localstack.cloud/user-guide/aws/rds/) ([MySQL](https://docs.localstack.cloud/user-guide/aws/rds/#mysql-engine) & [MSSQL](https://docs.localstack.cloud/user-guide/aws/rds/#microsoft-sql-server-engine)) +- [DocumentDB](/aws/services/docdb) +- [MWAA](/aws/services/docdb) +- [RDS](/aws/services/rds) ([MySQL](/aws/services/rds/#mysql-engine) & [MSSQL](/aws/services/rds/#microsoft-sql-server-engine)) To use Kubernetes as the runtime backend, set the `CONTAINER_RUNTIME` configuration variable to `kubernetes`. Note that there are no service-specific configuration variables for these services. \ No newline at end of file diff --git a/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md b/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md index b7e5a14d..292217f8 100644 --- a/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md +++ b/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md @@ -20,7 +20,7 @@ In particular, the setup consists of the following two steps. This guide assumes that you have the following tools installed. -* LocalStack ([Install](https://docs.localstack.cloud/get-started/#installation)) +* LocalStack ([Install](/aws/getting-started/#installation)) * Serverless ([Install](https://www.serverless.com/framework/docs/getting-started/)) It also assumes that you already have a Serverless app set up consisting of a couple of Lambda functions and a `serverless.yml` file similar to the following. diff --git a/src/content/docs/aws/integrations/app-frameworks/spring-cloud-function.mdx b/src/content/docs/aws/integrations/app-frameworks/spring-cloud-function.mdx index 1b49b895..52cbb6c8 100644 --- a/src/content/docs/aws/integrations/app-frameworks/spring-cloud-function.mdx +++ b/src/content/docs/aws/integrations/app-frameworks/spring-cloud-function.mdx @@ -56,7 +56,7 @@ when building production-ready applications. ## Setting up an Application -We recommend using [jenv](https://www.jenv.be) to manage multiple Java runtimes. +We recommend using [jenv](https://github.com/jenv/jenv) to manage multiple Java runtimes. ### Starting a new Project diff --git a/src/content/docs/aws/integrations/aws-native-tools/aws-cli.md b/src/content/docs/aws/integrations/aws-native-tools/aws-cli.md index fa1c4c75..5af2977b 100644 --- a/src/content/docs/aws/integrations/aws-native-tools/aws-cli.md +++ b/src/content/docs/aws/integrations/aws-native-tools/aws-cli.md @@ -9,7 +9,7 @@ sidebar: ## Introduction The [AWS Command Line Interface (CLI)](https://aws.amazon.com/cli/) is a unified tool for creating and managing AWS services via a command line interface. -All CLI commands applicable to services implemented within {/*[LocalStack](references/coverage/) TODO: I couldn't find this page in the new docs*/} can be executed when operating against LocalStack. +All CLI commands applicable to services implemented within [LocalStack](/aws/integrations/aws-native-tools/aws-cli/) can be executed when operating against LocalStack. You can use the AWS CLI with LocalStack using either of the following approaches: diff --git a/src/content/docs/aws/integrations/aws-sdks/javascript.mdx b/src/content/docs/aws/integrations/aws-sdks/javascript.mdx index c425ce96..3aedb977 100644 --- a/src/content/docs/aws/integrations/aws-sdks/javascript.mdx +++ b/src/content/docs/aws/integrations/aws-sdks/javascript.mdx @@ -118,7 +118,7 @@ s3.send(new ListBucketsCommand({})) :::note In case of issues resolving S3 DNS record, we can fallback to `http://localhost:4566` in combination with the provider setting `forcePathStyle: true` (see the specific way of setting this parameter for each SDK above). The S3 service endpoint is slightly different from the other service endpoints, because AWS is deprecating path-style based access for hosting buckets. -See [S3 documentation](user-guide/aws/s3) about endpoints. {/*TODO: fix link*/} +See [S3 documentation](/aws/services/s3) about endpoints. ::: ## Resources diff --git a/src/content/docs/aws/integrations/containers/devcontainers.mdx b/src/content/docs/aws/integrations/containers/devcontainers.mdx index 4ba51c06..019a2aeb 100644 --- a/src/content/docs/aws/integrations/containers/devcontainers.mdx +++ b/src/content/docs/aws/integrations/containers/devcontainers.mdx @@ -112,7 +112,7 @@ To get started with LocalStack and DevContainers in VS Code, follow these steps: * Filter by typing "localstack" in the search bar and select the **LocalStack Docker-in-Docker** template. - [Select official LocalStack Template (DinD)](public/images/aws/04a_select_template_dind.png) + [Select official LocalStack Template (DinD)](/aws/integrations/containers/devcontainers/#localstack-templates) * Proceed through the configuration by selecting or entering values. Pressing **Enter** through the options will apply default settings, which include: diff --git a/src/content/docs/aws/integrations/infrastructure-as-code/crossplane.md b/src/content/docs/aws/integrations/infrastructure-as-code/crossplane.md index 9c4c0cf1..5c4f5563 100644 --- a/src/content/docs/aws/integrations/infrastructure-as-code/crossplane.md +++ b/src/content/docs/aws/integrations/infrastructure-as-code/crossplane.md @@ -23,7 +23,7 @@ In the following, we provide a step-by-step guide for installing Crossplane in a * LocalStack running in local Docker * A local Kubernetes cluster: * We can use the [embedded Kubernetes cluster](https://docs.docker.com/desktop/kubernetes) that ships with modern versions of Docker Desktop (can be easily enabled in the Docker settings) - * Alternatively, you can [create a local EKS cluster](https://docs.localstack.cloud/user-guide/aws/elastic-kubernetes-service/#create-an-embedded-kubernetes-cluster) in LocalStack directly, which will spin up a light-weight embedded `k3d` Kubernetes cluster in your Docker environment + * Alternatively, you can [create a local EKS cluster](/aws/services/eks/#create-an-embedded-kubernetes-cluster) in LocalStack directly, which will spin up a light-weight embedded `k3d` Kubernetes cluster in your Docker environment * The [`helm`](https://helm.sh) and [`kubectl`](https://kubernetes.io/docs/tasks/tools/#kubectl) command-line clients installed ## Installing Crossplane in local Kubernetes @@ -236,7 +236,7 @@ You can refer to the additional reading material to learn and explore more advan * Kubernetes on Docker Desktop: https://docs.docker.com/desktop/kubernetes * Kubernetes getting started guide: https://kubernetes.io/docs/setup -* EKS Kubernetes clusters on LocalStack: https://docs.localstack.cloud/user-guide/aws/elastic-kubernetes-service +* EKS Kubernetes clusters on LocalStack: https://docs.localstack.cloud/aws/services/eks/ * Crossplane user docs: https://docs.crossplane.io * Crossplane AWS provider family: https://marketplace.upbound.io/providers/upbound/provider-family-aws * Crossplane AWS provider source code: https://github.com/upbound/provider-aws \ No newline at end of file diff --git a/src/content/docs/aws/integrations/messaging/docker-compose.yml b/src/content/docs/aws/integrations/messaging/docker-compose.yml new file mode 100644 index 00000000..ec9b3034 --- /dev/null +++ b/src/content/docs/aws/integrations/messaging/docker-compose.yml @@ -0,0 +1,70 @@ +services: + zookeeper: + image: confluentinc/cp-zookeeper:6.0.2 + container_name: zookeeper + hostname: zookeeper + ports: + - "2181:2181" + environment: + ZOOKEEPER_CLIENT_PORT: 2181 + ZOOKEEPER_TICK_TIME: 2000 + + kafka: + image: confluentinc/cp-kafka:6.0.2 + container_name: kafka + hostname: kafka + restart: always + depends_on: + - zookeeper + ports: + - "9092:9092" + - "9101:9101" + environment: + KAFKA_BROKER_ID: 1 + KAFKA_ZOOKEEPER_CONNECT: 'zookeeper:2181' + KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT + KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:29092,PLAINTEXT_HOST://localhost:9092 + KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1 + KAFKA_GROUP_INITIAL_REBALANCE_DELAY_MS: 0 + KAFKA_CONFLUENT_LICENSE_TOPIC_REPLICATION_FACTOR: 1 + KAFKA_CONFLUENT_BALANCER_TOPIC_REPLICATION_FACTOR: 1 + KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: 1 + KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR: 1 + KAFKA_JMX_PORT: 9101 + KAFKA_JMX_HOSTNAME: localhost + CONFLUENT_METRICS_REPORTER_BOOTSTRAP_SERVERS: kafka:29092 + CONFLUENT_METRICS_REPORTER_TOPIC_REPLICAS: 1 + CONFLUENT_METRICS_ENABLE: 'true' + CONFLUENT_SUPPORT_CUSTOMER_ID: 'anonymous' + KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'true' + + kowl: + image: quay.io/cloudhut/kowl:v1.3.1 + container_name: kowl + restart: always + ports: + - "8080:8080" + depends_on: + - kafka + environment: + - KAFKA_BROKERS=kafka:29092 + + localstack: + container_name: "${LOCALSTACK_DOCKER_NAME-localstack-main}" + image: localstack/localstack-pro # required for Pro + ports: + - "127.0.0.1:4566:4566" # LocalStack Gateway + - "127.0.0.1:4510-4559:4510-4559" # external services port range + - "127.0.0.1:443:443" # LocalStack HTTPS Gateway (Pro) + depends_on: + - kafka + - kowl + environment: + # Activate LocalStack Pro: https://docs.localstack.cloud/getting-started/auth-token/ + - LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN:?} # required for Pro + # LocalStack configuration: https://docs.localstack.cloud/references/configuration/ + - DEBUG=${DEBUG:-0} + - PERSISTENCE=${PERSISTENCE:-0} + volumes: + - "${LOCALSTACK_VOLUME_DIR:-./volume}:/var/lib/localstack" + - "/var/run/docker.sock:/var/run/docker.sock" \ No newline at end of file diff --git a/src/content/docs/aws/integrations/messaging/selfmanaged-kafka-cluster.md b/src/content/docs/aws/integrations/messaging/selfmanaged-kafka-cluster.md index d95ca8b4..655fc465 100644 --- a/src/content/docs/aws/integrations/messaging/selfmanaged-kafka-cluster.md +++ b/src/content/docs/aws/integrations/messaging/selfmanaged-kafka-cluster.md @@ -6,13 +6,13 @@ sidebar: order: 1 --- -LocalStack Pro supports [AWS Managed Streaming for Kafka (MSK)](/aws/services/msk) {/*TODO: target doesn't exist yet */}and you can create Kafka clusters directly through the MSK API that will run in LocalStack. +LocalStack Pro supports [AWS Managed Streaming for Kafka (MSK)](/aws/services/msk) and you can create Kafka clusters directly through the MSK API that will run in LocalStack. In some cases, you may want to run your own self-managed Kafka cluster and integrate it with your applications, like triggering Lambdas from a Kafka stream running in your own cluster. The Lambda integration with self-managed Kafka clusters is also a LocalStack Pro feature. ## Running self-managed Kafka -You can find the [example Docker Compose](docker-compose.yml) file which contains a single-noded ZooKeeper and a Kafka cluster and a simple LocalStack setup as well as [Kowl](https://github.com/cloudhut/kowl), an Apache Kafka Web UI. +You can find the [example Docker Compose](https://github.com/localstack/localstack-docs/blob/master/src/content/docs/aws/integrations/messaging/docker-compose.yml) file which contains a single-noded ZooKeeper and a Kafka cluster and a simple LocalStack setup as well as [Kowl](https://github.com/cloudhut/kowl), an Apache Kafka Web UI. 1. Run Docker Compose: diff --git a/src/content/docs/aws/tooling/extensions/developing-extensions.mdx b/src/content/docs/aws/tooling/extensions/developing-extensions.mdx index dfa8b6a8..843b181e 100644 --- a/src/content/docs/aws/tooling/extensions/developing-extensions.mdx +++ b/src/content/docs/aws/tooling/extensions/developing-extensions.mdx @@ -14,7 +14,7 @@ This section provides a brief overview of how to develop your own extensions. ## Extensions API -LocalStack exposes a Python API for building extensions that can be found in the core codebase in [`localstack.extensions.api`](https://github.com/localstack/localstack/tree/master/localstack/extensions/api). +LocalStack exposes a Python API for building extensions that can be found in the core codebase in [`localstack.extensions.api`](https://github.com/localstack/localstack/tree/master/localstack-core/localstack/extensions/api). The basic interface to implement is as follows: diff --git a/src/content/docs/aws/tooling/extensions/index.md b/src/content/docs/aws/tooling/extensions/index.md index 2117c855..a3d99254 100644 --- a/src/content/docs/aws/tooling/extensions/index.md +++ b/src/content/docs/aws/tooling/extensions/index.md @@ -22,7 +22,7 @@ You can use LocalStack Extensions to: - Instrumenting AWS requests with additional information before they reach your Lambdas. - Logging AWS API calls to custom data backends. -The officially supported [LocalStack Extensions]({/aws/tooling/extensions/official-extensions) can be discovered on our [Extension Library](https://app.localstack.cloud/extensions/library). +The officially supported LocalStack Extensions can be discovered on our [Official Extensions Library](https://app.localstack.cloud/extensions/library). To install and use extensions, you need an active LocalStack license. :::note diff --git a/src/content/docs/aws/tooling/localstack-docker-extension.md b/src/content/docs/aws/tooling/localstack-docker-extension.md index d50c2912..e3020d39 100644 --- a/src/content/docs/aws/tooling/localstack-docker-extension.md +++ b/src/content/docs/aws/tooling/localstack-docker-extension.md @@ -36,8 +36,7 @@ Upon the initial launch of the extension, a prompt to select a mount point for t Select your username from the drop-down menu. Furthermore, you can modify this setting later by navigating to the **Configurations** tab and choosing a different mount point. -![](/images/aws/) -Select the mount point upon the launch of LocalStack's Docker extension +Select the mount point upon the launch of LocalStack's Docker extension. ## Features diff --git a/src/content/docs/snowflake/getting-started/index.md b/src/content/docs/snowflake/getting-started/index.md index cfa63339..ab44946f 100644 --- a/src/content/docs/snowflake/getting-started/index.md +++ b/src/content/docs/snowflake/getting-started/index.md @@ -18,7 +18,7 @@ docker pull localstack/snowflake You can start the Snowflake Docker container using the following methods: -1. [`localstack` CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) +1. [`localstack` CLI](/snowflake/getting-started/#localstack-cli) 2. [`docker` CLI](https://docs.docker.com/get-docker/) 2. [Docker Compose](https://docs.docker.com/compose/install/) @@ -118,4 +118,4 @@ If you are encountering network issues and your Snowflake client drivers are una ## Next steps -Now that the Snowflake emulator is installed, you can use it for developing and testing your Snowflake data pipelines. Refer to our [Quickstart](/aws/getting-started/quickstart) guide to get started. +Now that the Snowflake emulator is installed, you can use it for developing and testing your Snowflake data pipelines. Refer to our [Quickstart](/snowflake/getting-started/quickstart/) guide to get started. From 2ec428e87fb55cae2bf480de32fe2b205d041fc4 Mon Sep 17 00:00:00 2001 From: Quetzalli Writes Date: Wed, 25 Jun 2025 22:28:59 -0700 Subject: [PATCH 3/6] finished fixing snow docs --- src/content/docs/snowflake/capabilities/init-hooks.mdx | 2 +- src/content/docs/snowflake/getting-started/faq.md | 2 +- src/content/docs/snowflake/getting-started/quickstart.md | 4 ++-- .../snowflake/tutorials/aws-lambda-localstack-snowpark.md | 4 ++-- .../tutorials/credit-scoring-with-localstack-snowpark.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/content/docs/snowflake/capabilities/init-hooks.mdx b/src/content/docs/snowflake/capabilities/init-hooks.mdx index af0d941b..7de74566 100644 --- a/src/content/docs/snowflake/capabilities/init-hooks.mdx +++ b/src/content/docs/snowflake/capabilities/init-hooks.mdx @@ -7,7 +7,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'; ## Introduction -LocalStack for Snowflake supports automatically executing `*.sf.sql` files via [Init Hooks](https://docs.localstack.cloud/references/init-hooks/) when mounted into the Docker container. A script can be added to one of these stages in the lifecycle: +LocalStack for Snowflake supports automatically executing `*.sf.sql` files via Init Hooks when mounted into the Docker container. A script can be added to one of these stages in the lifecycle: - `BOOT`: the container is running, but LocalStack hasn’t started - `START`: the Python process is running, and LocalStack is starting diff --git a/src/content/docs/snowflake/getting-started/faq.md b/src/content/docs/snowflake/getting-started/faq.md index 42e4e323..cc015112 100644 --- a/src/content/docs/snowflake/getting-started/faq.md +++ b/src/content/docs/snowflake/getting-started/faq.md @@ -14,7 +14,7 @@ Yes, the Snowflake emulator supports the Snowflake v2 SQL API (`/api/v2/*` endpo ### Why are my Snowflake tests failing? -The Snowflake emulator is in **preview** and may not support all Snowflake features. If your tests are failing, it could be due to the lack of support for certain Snowflake features in the emulator. We recommend checking the [function coverage](https://snowflake.localstack.cloud/references/coverage-functions/) to see the list of supported SQL functions and [feature coverage](https://snowflake.localstack.cloud/references/coverage-features/) to see the list of supported features. If you encounter any issues, you can connect with us for [support](#support-faqs). +The Snowflake emulator is in **preview** and may not support all Snowflake features. If your tests are failing, it could be due to the lack of support for certain Snowflake features in the emulator. We recommend checking the [function coverage](/snowflake/sql-functions/) to see the list of supported SQL functions and [feature coverage](/snowflake/features/) to see the list of supported features. If you encounter any issues, you can connect with us for [support](#support-faqs). ### Why does the Snowflake emulator run on `snowflake.localhost.localstack.cloud`? diff --git a/src/content/docs/snowflake/getting-started/quickstart.md b/src/content/docs/snowflake/getting-started/quickstart.md index 91aa44cb..5a8c460b 100644 --- a/src/content/docs/snowflake/getting-started/quickstart.md +++ b/src/content/docs/snowflake/getting-started/quickstart.md @@ -12,7 +12,7 @@ This guide explains how to set up the Snowflake emulator and develop a Python pr ## Prerequisites -- [`localstack` CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) +- [`localstack` CLI](/snowflake/getting-started/#localstack-cli) - [LocalStack for Snowflake](/snowflake/getting-started/) - Python 3.10 or later - [`snowflake-connector-python` library](https://docs.snowflake.com/en/developer-guide/python-connector/python-connector-install) @@ -129,7 +129,7 @@ To stop LocalStack and remove locally created resources, use: localstack stop ``` -LocalStack is ephemeral and doesn't persist data across restarts. It runs inside a Docker container, and once it’s stopped, all locally created resources are automatically removed. In a future release of the Snowflake emulator, we will provide proper persistence and integration with our [Cloud Pods](https://docs.localstack.cloud/aws/capabilities/state-management/cloud-pods) feature as well. +LocalStack is ephemeral and doesn't persist data across restarts. It runs inside a Docker container, and once it’s stopped, all locally created resources are automatically removed. In a future release of the Snowflake emulator, we will provide proper persistence and integration with a [Cloud Pods](/aws/capabilities/state-management/cloud-pods/) feature as well. ## Next steps diff --git a/src/content/docs/snowflake/tutorials/aws-lambda-localstack-snowpark.md b/src/content/docs/snowflake/tutorials/aws-lambda-localstack-snowpark.md index 5f76ac2b..320583d9 100644 --- a/src/content/docs/snowflake/tutorials/aws-lambda-localstack-snowpark.md +++ b/src/content/docs/snowflake/tutorials/aws-lambda-localstack-snowpark.md @@ -19,9 +19,9 @@ The code in this tutorial is available on [GitHub](https://github.com/localstack ## Prerequisites -- [`localstack` CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) with a [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/getting-started/auth-token/) +- [`localstack` CLI](/snowflake/getting-started/#localstack-cli) with a [`LOCALSTACK_AUTH_TOKEN`](/aws/getting-started/auth-token/) - [LocalStack for Snowflake](/snowflake/getting-started/) -- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) & [`awslocal` wrapper](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal) +- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) & [`awslocal` wrapper](/aws/integrations/aws-native-tools/aws-cli/#localstack-aws-cli-awslocal) - Python 3.10 installed locally ## Create the Lambda function diff --git a/src/content/docs/snowflake/tutorials/credit-scoring-with-localstack-snowpark.md b/src/content/docs/snowflake/tutorials/credit-scoring-with-localstack-snowpark.md index 146ab67d..7b14a6d6 100644 --- a/src/content/docs/snowflake/tutorials/credit-scoring-with-localstack-snowpark.md +++ b/src/content/docs/snowflake/tutorials/credit-scoring-with-localstack-snowpark.md @@ -14,7 +14,7 @@ The Jupyter Notebook and the dataset used in this tutorial are available on [Git ## Prerequisites -- [`localstack` CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) with a [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/getting-started/auth-token/) +- [`localstack` CLI](/snowflake/getting-started/#localstack-cli) with a [`LOCALSTACK_AUTH_TOKEN`](/aws/getting-started/auth-token/) - [LocalStack for Snowflake](/snowflake/getting-started/) - [Snowpark](/snowflake/integrations/snowpark) with other Python libraries - [Jupyter Notebook](https://jupyter.org/install#jupyter-notebook) From cf6804c4108e7bda0f36481576fdc112813b14ee Mon Sep 17 00:00:00 2001 From: Quetzalli Writes Date: Wed, 25 Jun 2025 22:33:03 -0700 Subject: [PATCH 4/6] fix broken link --- .../aws/integrations/app-frameworks/serverless-framework.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md b/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md index 292217f8..bc79a5f7 100644 --- a/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md +++ b/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md @@ -20,7 +20,7 @@ In particular, the setup consists of the following two steps. This guide assumes that you have the following tools installed. -* LocalStack ([Install](/aws/getting-started/#installation)) +* LocalStack ([Install](/aws/getting-started#installation)) * Serverless ([Install](https://www.serverless.com/framework/docs/getting-started/)) It also assumes that you already have a Serverless app set up consisting of a couple of Lambda functions and a `serverless.yml` file similar to the following. From f6f2628f58a955586ff78ac131a04aa1e5e1a098 Mon Sep 17 00:00:00 2001 From: Harsh Mishra Date: Thu, 26 Jun 2025 11:26:39 +0530 Subject: [PATCH 5/6] Update localstack-docker-extension.md --- src/content/docs/aws/tooling/localstack-docker-extension.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/content/docs/aws/tooling/localstack-docker-extension.md b/src/content/docs/aws/tooling/localstack-docker-extension.md index e3020d39..65c3d032 100644 --- a/src/content/docs/aws/tooling/localstack-docker-extension.md +++ b/src/content/docs/aws/tooling/localstack-docker-extension.md @@ -38,6 +38,8 @@ Furthermore, you can modify this setting later by navigating to the **Configurat Select the mount point upon the launch of LocalStack's Docker extension. +![Select the mount point upon the launch of LocalStack's Docker extension](/images/aws/localstack-docker-extension-mount-point.png) + ## Features LocalStack's Docker Extension helps users to manage their LocalStack container with a simple and intuitive user interface through Docker Desktop. From 548e5d516ef31afab823bb8dccf5e1744c272c11 Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Thu, 26 Jun 2025 11:31:19 +0530 Subject: [PATCH 6/6] fix --- .../aws/integrations/app-frameworks/serverless-framework.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md b/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md index bc79a5f7..f7617fe8 100644 --- a/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md +++ b/src/content/docs/aws/integrations/app-frameworks/serverless-framework.md @@ -20,7 +20,7 @@ In particular, the setup consists of the following two steps. This guide assumes that you have the following tools installed. -* LocalStack ([Install](/aws/getting-started#installation)) +* LocalStack ([Install](/aws/getting-started/installation)) * Serverless ([Install](https://www.serverless.com/framework/docs/getting-started/)) It also assumes that you already have a Serverless app set up consisting of a couple of Lambda functions and a `serverless.yml` file similar to the following.