File tree

130 files changed

+310
-340
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searcx below for content that may be hidden.

130 files changed

+310
-340
lines changed
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ taxonomyCloud = []
2929
taxonomyCloudTitle = ["Tag Cloud", "Categories"]
3030

3131
# set taxonomyPageHeader = [] to hide taxonomies on the page headers
32-
taxonomyPageHeader = []
32+
taxonomyPageHeader = ["tags"]
3333

3434

3535
# Highlighting config
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,6 @@ You can manually set the Auth Token, or use the `export` command to establish th
108108

109109
## Licensing-related configuration
110110

111-
To ensure that LocalStack only starts when you can activate LocalStack Pro/Team/Enterprise, set `ACTIVATE_PRO=1` in your environment. This is set to `true` by default if using the `localstack/localstack-pro` container image. If set to 1, LocalStack will fail to start if the activation did not work. If set to 0, an attempt is made to start LocalStack without any licensed features.
112-
113111
To avoid logging any licensing-related error messages, set `LOG_LICENSE_ISSUES=0` in your environment. Refer to our [configuration guide](https://docs.localstack.cloud/references/configuration/#localstack-pro) for more information.
114112

115113
## Checking license activation
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ If you want to access our security documentation and test reports, please contac
318318

319319
### Does LocalStack provide offline capabilities?
320320

321-
LocalStack Community and Pro/Team provide limited offline capabilities.
321+
LocalStack Community and Pro images provide limited offline capabilities.
322322
To use a fully-fledged offline mode, you may use LocalStack Enterprise, which can be used in air-gapped environments.
323323
The regular LocalStack Docker images may need to download additional dependencies for specific services (e.g., Elasticsearch, Big Data services) at runtime, while the offline image bakes all dependencies into the image, along with any other configuration that you might need.
324324
For more details, please take a look at our [Enterprise offering](https://localstack.cloud/pricing).
Original file line numberDiff line numberDiff line change
@@ -117,5 +117,5 @@ There are several reasons a key activation can fail:
117117
* Invalid key: there is no valid license associated with the key, for example because the license has expired.
118118
* License server cannot be reached: LocalStack will try to perform an offline license activation if the license server cannot be reached, but will require a re-activation every 24 hours.
119119

120-
If you are using the `localstack/localstack-pro` image, but cannot activate your , we recommend falling back to the community version `localstack/localstack`.
120+
If you are using the `localstack/localstack-pro` image, but cannot activate your , we recommend falling back to the community image `localstack/localstack`.
121121
If that is not an option, you can set `ACTIVATE_PRO=0` which will attempt to start LocalStack without pro features.
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ title: "ARM64 Support"
33
weight: 50
44
description: >
55
Running LocalStack on ARM64 CPUs
6-
tags: ["apple", "silicon", "m1", "raspberry pi"]
7-
aliases:
8-
- /localstack/arm64-support/
96
---
107

118
Since [version 0.13](https://.com/localstack/localstack/releases/tag/v0.13.0), LocalStack officially publishes a [multi-architecture Docker manifest](https://hub.docker.com/r/localstack/localstack).
Original file line numberDiff line numberDiff line change
@@ -407,16 +407,15 @@ These configurations have already been removed and **won't have any effect** on
407407
| `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout]({{< ref "filesystem" >}}). |
408408
| `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system](https://docs.localstack.cloud/references/init-hooks/). |
409409
| `MULTI_ACCOUNTS` | 2.0.0 | `0` (default) | Enable multi-accounts (preview) |
410-
| `REQUIRE_PRO` | 2.0.0 | 0 (default) | Whether to require license activation to succeed to start LocalStack. If set to 0 (default) LocalStack will start as community version if the license cannot be activated. |
411410
| `SQS_PROVIDER` | 2.0.0 | `moto` (default) and `elasticmq` | |
412411
| `SYNCHRONOUS_API_GATEWAY_EVENTS` | 2.0.0 | `1` (default) \| `0` | Whether or not to handle API Gateway Lambda event sources as synchronous invocations. |
413412
| `SYNCHRONOUS_DYNAMODB_EVENTS` | 2.0.0 | `1` (default) \| `0` | Whether or not to handle DynamoDB Lambda event sources as synchronous invocations. |
414413
| `SYNCHRONOUS_SQS_EVENTS` | 2.0.0 | `1` \| `0` (default) | Whether or not to handle SQS Lambda event sources as synchronous invocations. |
415414
| `SYNCHRONOUS_SNS_EVENTS` | 2.0.0 | `1` \| `0` (default) | Whether or not to handle SNS Lambda event sources as synchronous invocations. |
416415
| `TMPDIR`| 2.0.0 | `/tmp` (default) | Temporary folder on the host running the CLI and inside the LocalStack container .|
417416
| `USE_LIGHT_IMAGE` | 2.0.0 | `1` (default) | Whether to use the light-weight Docker image. Overwritten by `IMAGE_NAME`.|
418-
| `LEGACY_PERSISTENCE` | 1.0.0 | `true` (default) | Whether to enable legacy persistence mechanism based on API calls record & replay. Only relevant for Community version, not relevant for advanced persistence mechanism in Pro. |
419-
| `PERSISTENCE_SINGLE_FILE` | 1.0.0 | `true` (default)| Specify if persistence files should be combined (only relevant for legacy persistence in Community version, not relevant for advanced persistence in Pro version). |
417+
| `LEGACY_PERSISTENCE` | 1.0.0 | `true` (default) | Whether to enable legacy persistence mechanism based on API calls record & replay. Only relevant for Community image, not relevant for advanced persistence mechanism in Pro. |
418+
| `PERSISTENCE_SINGLE_FILE` | 1.0.0 | `true` (default)| Specify if persistence files should be combined (only relevant for legacy persistence in Community image, not relevant for advanced persistence in Pro version). |
420419
| `PORT_WEB_UI` | 0.12.8 | `8080` (default) | Port for the legacy Web UI. Replaced by our [Web Application](https://app.localstack.cloud) |
421420

422421
## Profiles
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: "Credentials"
33
linkTitle: "Credentials"
4-
categories: ["LocalStack"]
5-
tags: ["access-key-id", "secret-access-key", "account-id"]
64
weight: 50
75
description: >
86
Credentials for accessing LocalStack AWS API
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: "Cross-Account and Cross-Region Access"
33
linkTitle: "Cross-Account and Cross-Region Access"
4-
categories: ["LocalStack"]
5-
tags: ["multi-tenant", "multi-account", "namespaces"]
64
weight: 50
75
description: >
86
Accessing resources in another account or region
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
---
22
title: "Multi-Account Setups"
33
linkTitle: "Multi-Account Setups"
4-
categories: []
5-
tags: ["multi-tenant", "multi-account", "account-id", "namespaces"]
6-
aliases:
7-
- /aws/multi-account-setups/
8-
- /tools/multi-account-setups/
94
weight: 50
105
description: >
116
Using LocalStack in multi-tenant setups
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Transparent endpoint injection
3+
tags: ["Pro image"]
34
weight: 2
45
tags:
56
- troubleshooting
@@ -20,7 +21,7 @@ You need to make two changes:
2021

2122
For more details, see your [DNS server documentation]({{<ref "dns-server">}}).
2223

23-
For the community edition of LocalStack, you can employ your own DNS server to achieve a similar outcome, but it won't be managed by LocalStack.
24+
For the community image of LocalStack, you can employ your own DNS server to achieve a similar outcome, but it won't be managed by LocalStack.
2425
Note that in both cases, SSL verification must be disabled.
2526

2627
## From a lambda function
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ title: "Podman"
33
weight: 50
44
description: >
55
Running LocalStack inside Podman
6-
tags: ["podman", "docker"]
7-
aliases:
8-
- /localstack/podman/
96
---
107

118
## Overview
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Here is an example of AWS API call metadata:
7979
}
8080
```
8181

82-
For the community version, we only track service, operation, status code, and how often the combination of those occurred.
82+
For the community image, we only track service, operation, status code, and how often the combination of those occurred.
8383

8484
### CLI invocations
8585

Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Get started with AWS Certificate Manager (ACM) on LocalStack
1010

1111
ACM supports securing multiple domain names and subdomains and can create wildcard SSL certificates to protect an entire domain and its subdomains. You can also use ACM to import certificates from third-party certificate authorities or to generate private certificates for internal use.
1212

13-
LocalStack supports ACM via the Community offering, allowing you to use the ACM API to create, list, and delete certificates. The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_acm/), which provides information on the extent of ACM's integration with LocalStack.
13+
LocalStack allows you to use the ACM APIs to create, list, and delete certificates. The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_acm/), which provides information on the extent of ACM's integration with LocalStack.
1414

1515
## Getting started
1616

@@ -60,124 +60,6 @@ Finally you can use the [`DeleteCertificate` API](https://docs.aws.amazon.com/ac
6060
$ awslocal acm delete-certificate --certificate-arn arn:aws:acm:<region>:account:certificate/<certificate_ID>
6161
{{< /command >}}
6262

63-
## ACM Private Certificate Authority
64-
65-
AWS Private Certificate Authority (ACM PCA) is a managed private Certificate Authority (CA) service that manages the lifecycle of your private certificates.
66-
ACM PCA extends ACM's certificate management capabilities to private certificates, enabling you to manage public and private certificates centrally.
67-
68-
LocalStack supports ACM PCA via the Pro/Team offering, allowing you to use the ACM PCA API to create, list, and delete private certificates.
69-
You can creating, describing, tagging, and listing tags for a CA using ACM PCA.
70-
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_acm-pca/), which provides information on the extent of ACM PCA's integration with LocalStack.
71-
72-
### Create a Certificate Authority (CA)
73-
74-
Start by creating a new Certificate Authority with ACM PCA using the [`CreateCertificateAuthority`](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) API.
75-
This command sets up a new CA with specified configurations for key algorithm, signing algorithm, and subject information.
76-
77-
{{< command >}}
78-
$ awslocal acm-pca create-certificate-authority \
79-
--certificate-authority-configuration '{
80-
"KeyAlgorithm":"RSA_2048",
81-
"SigningAlgorithm":"SHA256WITHRSA",
82-
"Subject":{
83-
"Country":"US",
84-
"Organization":"Example Corp",
85-
"OrganizationalUnit":"Sales",
86-
"State":"WA",
87-
"Locality":"Seattle",
88-
"CommonName":"www.example.com"
89-
}
90-
}' \
91-
--revocation-configuration '{
92-
"OcspConfiguration":{
93-
"Enabled":true
94-
}
95-
}' \
96-
--certificate-authority-type "ROOT" \
97-
--tags Key=Name,Value=MyPCA
98-
<disable-copy>
99-
{
100-
"CertificateAuthorityArn": "arn:aws:acm-pca:us-east-1:000000000000:certificate-authority/f38ee966-bc23-40f8-8143-e981aee73600"
101-
}
102-
</disable-copy>
103-
{{< /command >}}
104-
105-
Note the `CertificateAuthorityArn` from the output as it will be needed for subsequent commands.
106-
107-
### Describe the Certificate Authority
108-
109-
To retrieve the detailed information about the created Certificate Authority, use the [`DescribeCertificateAuthority`](https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html) API.
110-
This command returns the detailed information about the CA, including the CA's ARN, status, and configuration.
111-
112-
{{< command >}}
113-
$ awslocal acm-pca describe-certificate-authority \
114-
--certificate-authority-arn arn:aws:acm-pca:us-east-1:000000000000:certificate-authority/f38ee966-bc23-40f8-8143-e981aee73600
115-
<disable-copy>
116-
{
117-
"CertificateAuthority": {
118-
"Arn": "arn:aws:acm-pca:us-east-1:000000000000:certificate-authority/f38ee966-bc23-40f8-8143-e981aee73600",
119-
"OwnerAccount": "000000000000",
120-
"CreatedAt": "2023-12-23T20:52:20.917796+05:30",
121-
"Type": "ROOT",
122-
"Status": "PENDING_CERTIFICATE",
123-
"CertificateAuthorityConfiguration": {
124-
"KeyAlgorithm": "RSA_2048",
125-
"SigningAlgorithm": "SHA256WITHRSA",
126-
"Subject": {
127-
"Country": "US",
128-
"Organization": "Example Corp",
129-
"OrganizationalUnit": "Sales",
130-
"State": "WA",
131-
"CommonName": "www.example.com",
132-
"Locality": "Seattle"
133-
}
134-
},
135-
"RevocationConfiguration": {
136-
"OcspConfiguration": {
137-
"Enabled": true
138-
}
139-
},
140-
"KeyStorageSecurityStandard": "FIPS_140_2_LEVEL_3_OR_HIGHER",
141-
"UsageMode": "SHORT_LIVED_CERTIFICATE"
142-
}
143-
}
144-
</disable-copy>
145-
{{< /command >}}
146-
147-
### Tag the Certificate Authority
148-
149-
Tagging resources in AWS helps in managing and identifying them. Use the [`TagCertificateAuthority`](https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html) API to tag the created Certificate Authority.
150-
This command adds the specified tags to the specified CA.
151-
152-
{{< command >}}
153-
$ awslocal acm-pca tag-certificate-authority \
154-
--certificate-authority-arn arn:aws:acm-pca:us-east-1:000000000000:certificate-authority/f38ee966-bc23-40f8-8143-e981aee73600 \
155-
--tags Key=Admin,Value=Alice
156-
{{< /command >}}
157-
158-
After tagging your Certificate Authority, you may want to view these tags.
159-
You can use the [`ListTags`](https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html) API to list all the tags associated with the specified CA.
160-
161-
{{< command >}}
162-
$ awslocal acm-pca list-tags \
163-
--certificate-authority-arn arn:aws:acm-pca:us-east-1:000000000000:certificate-authority/f38ee966-bc23-40f8-8143-e981aee73600 \
164-
--max-results 10
165-
<disable-copy>
166-
{
167-
"Tags": [
168-
{
169-
"Key": "Name",
170-
"Value": "MyPCA"
171-
},
172-
{
173-
"Key": "Admin",
174-
"Value": "Alice"
175-
}
176-
]
177-
}
178-
</disable-copy>
179-
{{< /command >}}
180-
18163
## Examples
18264

18365
The following code snippets and sample applications provide practical examples of how to use ACM in LocalStack for various use cases:
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ title: "Amplify"
33
linkTitle: "Amplify"
44
description: >
55
Get started with Amplify on LocalStack
6+
tags: ["Pro image"]
67
---
78

89
## Introduction
910

1011
Amplify is a JavaScript-based development framework with libraries, UI components, and a standard CLI interface for building and deploying web and mobile applications. With Amplify, developers can build and host static websites, single-page applications, and full-stack serverless web applications using an abstraction layer over popular AWS services like DynamoDB, Cognito, AppSync, Lambda, S3, and more.
1112

12-
LocalStack supports Amplify via the Pro/Team offering, allowing you to use the Amplify APIs to build and test their Amplify applications locally. The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_amplify/), which provides information on the extent of Amplify's integration with LocalStack.
13+
LocalStack allows you to use the Amplify APIs to build and test their Amplify applications locally. The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_amplify/), which provides information on the extent of Amplify's integration with LocalStack.
1314

1415
{{< alert title="Note" >}}
1516
The `amplifylocal` CLI and the Amplify JS library have been deprecated and are no longer supported. We recommend using the Amplify CLI with the Amplify LocalStack Plugin instead.
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,16 @@ title: "API Gateway"
33
linkTitle: "API Gateway"
44
description: >
55
Get started with API Gateway on LocalStack
6+
tags: ["Pro image"]
67
---
78

89
## Introduction
910

1011
API Gateway is a managed service that enables developers to create, deploy, and manage APIs (Application Programming Interfaces). It allows easy creation of REST, HTTP, and WebSocket APIs to securely access data, business logic, or functionality from backend services like AWS Lambda functions or EC2 instances. API Gateway supports standard HTTP methods such as `GET`, `POST`, `PUT`, ``, and `DELETE` and integrates with various AWS services, including Lambda, Cognito, CloudWatch, and X-Ray.
1112

12-
LocalStack supports API Gateway V1 via the Community offering and API Gateway V2 via the Pro/Team offering, allowing you to use the API Gateway to create, deploy, and manage APIs on your local machine to invoke those exposed API endpoints. The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_apigatewayv2/), which provides information on the extent of API Gateway V2's integration with LocalStack.
13+
LocalStack supports API Gateway V1 in the Community image and API Gateway V2 in the Pro image. LocalStack allows you to use the API Gateway APIs to create, deploy, and manage APIs on your local machine to invoke those exposed API endpoints.
1314

14-
{{< alert title="Note">}}
15-
The Pro/Team version supports API Gateway V2 and V1, enabling you to create local HTTP and WebSocket APIs that allow long-lived connections and bi-directional communication between the API and your clients.
16-
{{< /alert >}}
15+
The supported APIs are available on the API coverage page for [API Gateway V1](https://docs.localstack.cloud/references/coverage/coverage_apigateway/) & [API Gateway V2](https://docs.localstack.cloud/references/coverage/coverage_apigatewayv2/), which provides information on the extent of API Gateway's integration with LocalStack.
1716

1817
## Getting started
1918

Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
title: "AppConfig"
33
linkTitle: "AppConfig"
44
description: Get started with AppConfig on LocalStack
5+
tags: ["Pro image"]
56
---
67

78
AppConfig is a service provided by Amazon Web Services (AWS) that simplifies the process of managing and deploying application configurations. AppConfig offers centralized management of configuration data and the ability to create, manage, and deploy configuration changes separately. It allows you to avoid deploying the service repeatedly for smaller changes, enables controlled deployments to applications and includes built-in validation checks & monitoring.
89

9-
LocalStack supports AppConfig via the Pro/Team offering, allowing you to use the AppConfig APIs in your local environment to define configurations for different environments and deploy them to your applications as needed. The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_appconfig/), which provides information on the extent of AppConfig's integration with LocalStack.
10+
LocalStack allows you to use the AppConfig APIs in your local environment to define configurations for different environments and deploy them to your applications as needed. The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_appconfig/), which provides information on the extent of AppConfig's integration with LocalStack.
1011

1112
## Getting started
1213

0 commit comments

Comments
 (0)