You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/user-guide/aws/dynamodb/index.md
+2
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,8 @@ DynamoDB provides a fast and scalable key-value datastore with support for repli
13
13
LocalStack allows you to use the DynamoDB APIs in your local environment to manage key-value and document data models.
14
14
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_dynamodb/), which provides information on the extent of DynamoDB's integration with LocalStack.
15
15
16
+
DynamoDB emulation is powered by [DynamoDB Local](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html).
17
+
16
18
## Getting started
17
19
18
20
This guide is designed for users new to DynamoDB and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
If the `ssh` command throws an error like "Identity file not accessible" or "bad permissions", then please make sure that the key file has a restrictive `0400` permission as illustrated [here]({{< relref "ec2#create-a-key-pair" >}}).
214
+
If the `ssh` command throws an error like "Identity file not accessible" or "bad permissions", make sure that the key file has a restrictive `0400` permission as illustrated above.
215
215
{{< /callout >}}
216
216
217
217
## VM Managers
@@ -251,8 +251,8 @@ While the records of resources will be persisted, the instances or AMIs themselv
251
251
252
252
### AMIs
253
253
254
-
LocalStack utilizes a specific naming scheme to recognize and manage associated containers and images.
255
254
Docker base images which are tagged with the scheme `localstack-ec2/<AmiName>:<AmiId>` are recognized as Amazon Machine Images (AMIs).
255
+
These can be used to launch EC2 instances which are in fact Docker containers.
256
256
257
257
You can mark any Docker base image as AMI using the below command:
258
258
@@ -267,28 +267,27 @@ At startup, LocalStack downloads the following AMIs that can be used to launch D
267
267
- Amazon Linux 2023 `ami-024f768332f0`
268
268
269
269
{{< callout "note" >}}
270
-
The auto download of Docker images to be used as AMIs can be disabled using the `EC2_DOWNLOAD_DEFAULT_IMAGES=0` configuration variable.
270
+
The auto download of Docker images for default AMIs can be disabled using the `EC2_DOWNLOAD_DEFAULT_IMAGES=0` configuration variable.
271
271
{{< /callout >}}
272
272
273
273
All LocalStack-managed Docker AMIs bear the resource tag `ec2_vm_manager:docker`.
If an AMI does have the `ec2_vm_manager:docker` tag, it means that it is mocked.
281
+
If an AMI does not have the `ec2_vm_manager:docker` tag, it means that it is mocked.
282
282
Attempting to launch Dockerized instances using these AMIs will result in an `InvalidAMIID.NotFound` error.
283
283
See [Mock VM manager](#mock-vm-manager).
284
284
{{< /callout >}}
285
285
286
-
AWS does not provide an API to download AMIs.
287
-
This prevents the use stock AWS AMIs on LocalStack.
288
-
However, in certain cases it may be possible to tweak your AMI build process to target Docker images.
286
+
AWS does not provide an API to download AMIs which prevents the use of real AWS AMIs on LocalStack.
287
+
However, in certain cases it may be possible to tweak your workflow to make it work with Localstack.
289
288
290
-
For example, suppose you use [Packer](https://packer.io/) to customise the Amazon Linux AMI on AWS.
291
-
You can instead make Packer use the [Docker builder](https://developer.hashicorp.com/packer/integrations/hashicorp/docker/latest/components/builder/docker) instead of the Amazon builder and add the customisations on top of the Amazon Linux [Docker base image](https://hub.docker.com/_/amazonlinux/).
289
+
For example, you can use [Packer](https://packer.io/) to customise the Amazon Linux AMI on AWS.
290
+
Packer can be made to use the [Docker builder](https://developer.hashicorp.com/packer/integrations/hashicorp/docker/latest/components/builder/docker) instead of the Amazon builder and add the customisations on top of the Amazon Linux [Docker base image](https://hub.docker.com/_/amazonlinux/).
292
291
The final image then can be used by LocalStack EC2 as illustrated above.
293
292
294
293
### Instances
@@ -321,26 +320,27 @@ These addresses are also printed in the logs while the instance is being initial
321
320
When instances are launched, LocalStack attempts to start SSH server `/usr/sbin/sshd` in the Docker base image.
322
321
If not found, it installs and starts the [Dropbear](https://github.com/mkj/dropbear) SSH server.
323
322
324
-
To be able to access the instance at additional ports from the host system, you can modify the default security group and incorporate the needed ingress ports.
323
+
To be able to access the instance at additional ports from the host system, you can modify the default security group and include the required ingress ports.
325
324
326
325
{{< callout "note" >}}
327
326
Security group ingress rules are applied only during the creation of the Dockerized instance.
328
327
Modifying a security group will not open any ports for a running instance.
329
328
{{< /callout >}}
330
329
331
330
The system supports up to 32 ingress ports.
332
-
This constraint is in place to prevent the host from exhausting available ports.
331
+
This constraint is in place to prevent exhausting free ports on the host.
Copy file name to clipboardExpand all lines: content/en/user-guide/aws/fis/index.md
+3-6
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ FIS defines the following elements:
28
28
1. Duration of the disruption.
29
29
30
30
Together this is termed as an Experiment.
31
-
After the designated time, FIS restores systems to their original state and/or ceases introducing faults.
31
+
After the designated time, running experiments restore systems to their original state and cease introducing faults.
32
32
33
33
{{< callout "note" >}}
34
34
FIS experiment emulation is part of LocalStack Enterprise.
@@ -37,10 +37,9 @@ If you'd like to try it out, please [contact us](https://www.localstack.cloud/de
37
37
38
38
FIS actions can be categorized into two main types:
39
39
40
-
1.Single-time events — For example, the `aws:ec2:stop-instances` FIS action, which sends a [`StopInstances`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_StopInstances.html) API to specific EC2 instances.
40
+
1.One-time events: For example, the `aws:ec2:stop-instances` FIS action, which sends a [`StopInstances`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_StopInstances.html) API to specific EC2 instances.
41
41
Some of these events can automatically be undone after a defined time, such as sending a [`StartInstances`](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_StartInstances.html) command to the affected instances.
42
-
1. Inducing API errors in response to a specified percentage of API calls.
43
-
For instance, using `aws:fis:inject-api-unavailable-error` to introduce an HTTP 503 error.
42
+
1. Probabilistic API errors: For instance, using `aws:fis:inject-api-unavailable-error` to introduce an HTTP 503 error.
44
43
45
44
## Getting started
46
45
@@ -233,9 +232,7 @@ LocalStack FIS currently supports the following actions:
233
232
-**`aws:rds:reboot-db-instances`**: Runs EC2 RebootInstances on the target EC2 instances.
234
233
-**`aws:ssm:send-command`**: Runs the Systems Manager SendCommand on the target EC2 instances.
235
234
236
-
{{< callout "note" >}}
237
235
If you would like support for more FIS actions, please make a feature request on [GitHub](https://github.com/localstack/localstack/issues/new/choose).
Copy file name to clipboardExpand all lines: content/en/user-guide/aws/iot/index.md
+11-15
Original file line number
Diff line number
Diff line change
@@ -10,32 +10,35 @@ aliases:
10
10
11
11
## Introduction
12
12
13
-
AWS IoT provides cloud services to manage IoT fleet and integrate them with other AWS services
13
+
AWS IoT provides cloud services to manage IoT devices and integrate them with other AWS services.
14
14
15
-
LocalStack Pro supports IoT Core, IoT Data, IoT Analytics and related APIs as well as an in-built MQTT broker.
15
+
LocalStack Pro supports IoT Core, IoT Data, IoT Analytics.
16
16
Common operations for creating and updating things, groups, policies, certificates and other entities are implemented with full CloudFormation support.
17
17
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_iot/).
18
18
19
+
LocalStack ships a [Message Queuing Telemetry Transport (MQTT)](https://mqtt.org/) broker powered by [Eclipse Mosquitto](https://mosquitto.org/) which supports both pure MQTT and MQTT-over-WSS (WebSockets Secure) protocols.
20
+
19
21
## Getting Started
20
22
21
23
This guide is for users that are new to IoT and assumes a basic knowledge of the AWS CLI and LocalStack [`awslocal`](https://github.com/localstack/awscli-local) wrapper.
22
24
23
25
Start LocalStack using your preferred method.
24
26
25
-
LocalStack ships an Message Queuing Telemetry Transport (MQTT) broker powered by [Mosquitto](https://mosquitto.org/) which supports both pure MQTT and MQTT-over-WSS (WebSockets Secure) protocols.
26
27
To retrieve the MQTT endpoint, use the [`DescribeEndpoint`](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeEndpoint.html) operation.
The MQTT broker may not be automatically available on a fresh launch of LocalStack.
38
-
You should make a `DescribeEndpoint` call to ensure the broker is running and identify the port.
41
+
You can make a `DescribeEndpoint` call to start the broker and identify the port.
39
42
{{< /callout >}}
40
43
41
44
This endpoint can then be used with any MQTT client to publish and subscribe to topics.
@@ -50,7 +53,7 @@ $ mqtt subscribe \
50
53
--topic climate
51
54
{{< /command >}}
52
55
53
-
In another terminal, publish a message to this topic.
56
+
In a separate terminal session, publish a message to this topic.
54
57
55
58
{{< command >}}
56
59
$ mqtt publish \
@@ -60,16 +63,16 @@ $ mqtt publish \
60
63
-m "temperature=30°C;humidity=60%"
61
64
{{< /command >}}
62
65
63
-
This message will be pushed to all subscribers of this topic, including the one in the first terminal.
66
+
This message will be pushed to all subscribers of this topic, including the one in the first terminal session.
64
67
65
68
## Authentication
66
69
67
70
LocalStack IoT maintains its own root certificate authority which is regenerated at every run.
68
71
The root CA certificate can be retrieved from <http://localhost.localstack.cloud:4566/_aws/iot/LocalStackIoTRootCA.pem>.
69
72
70
-
{{< callout >}}
73
+
{{< callout "tip" >}}
71
74
AWS provides its root CA certificate at <https://www.amazontrust.com/repository/AmazonRootCA1.pem>.
72
-
For more information, see [this](https://docs.aws.amazon.com/iot/latest/developerguide/server-authentication.html#server-authentication-certs).
75
+
[This section](https://docs.aws.amazon.com/iot/latest/developerguide/server-authentication.html#server-authentication-certs) contains information about CA certificates.
73
76
{{< /callout >}}
74
77
75
78
When connecting to the endpoints, you will need to provide this root CA certificate for authentication.
@@ -191,10 +194,3 @@ The following actions are supported:
-[HTTP](https://docs.aws.amazon.com/iot/latest/developerguide/https-rule-action.html) (URL confirmation and substitution templating is not implemented)
194
-
195
-
## Current Limitations
196
-
197
-
LocalStack MQTT broker does not support multi-account/multi-region namespacing.
198
-
Internally, the MQTT messages are not routed to the appropriate account ID/region even though the endpoint URL may suggest otherwise.
199
-
All messages will be routed to the `000000000000` account and the `us-east-1` region.
200
-
This prevents features such as topic rules from working properly when not using the this account ID or region.
Copy file name to clipboardExpand all lines: content/en/user-guide/aws/kinesis/index.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,8 @@ It is used for applications that require real-time processing and deriving insig
14
14
LocalStack allows you to use the Kinesis Data Streams APIs in your local environment from setting up data streams and configuring data processing to building real-time applications.
15
15
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_kinesis/).
16
16
17
+
Emulation for Kinesis is powered by [Kinesis Mock](https://github.com/etspaceman/kinesis-mock).
18
+
17
19
## Getting started
18
20
19
21
This guide is designed for users new to Kinesis Data Streams and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
@@ -205,4 +207,4 @@ The following code snippets and sample applications provide practical examples o
205
207
## Limitations
206
208
207
209
In multi-account setups, each AWS account launches a separate instance of Kinesis Mock, which is very resource intensive when a large number of AWS accounts are used.
208
-
An [open Kinesis Mock issue](https://github.com/etspaceman/kinesis-mock/issues/377) is being used to keep track of this feature.
210
+
[This Kinesis Mock issue](https://github.com/etspaceman/kinesis-mock/issues/377) is being used to keep track of this feature.
Copy file name to clipboardExpand all lines: content/en/user-guide/aws/mwaa/index.md
+7-3
Original file line number
Diff line number
Diff line change
@@ -8,15 +8,15 @@ tags: ["Pro image"]
8
8
9
9
## Introduction
10
10
11
-
Managed Workflows for Apache Airflow (MWAA) is a fully managed service by AWS that simplifies the deployment, management, and scaling of Apache Airflow workflows in the cloud.
11
+
Managed Workflows for Apache Airflow (MWAA) is a fully managed service by AWS that simplifies the deployment, management, and scaling of [Apache Airflow](https://airflow.apache.org/) workflows in the cloud.
12
12
MWAA leverages the familiar Airflow features and integrations while integrating with S3, Glue, Redshift, Lambda, and other AWS services to build data pipelines and orchestrate data processing workflows in the cloud.
13
13
14
14
LocalStack allows you to use the MWAA APIs in your local environment to allow the setup and operation of data pipelines.
15
-
The supported APIs are available on our[API coverage page](https://docs.localstack.cloud/references/coverage/coverage_mwaa/), which provides information on the extent of MWAA's integration with LocalStack.
15
+
The supported APIs are available on the[API coverage page](https://docs.localstack.cloud/references/coverage/coverage_mwaa/).
16
16
17
17
## Getting started
18
18
19
-
This guide is designed for users new to Managed Workflows for Apache Airflow and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
19
+
This guide is designed for users new to MWAA and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
20
20
21
21
Start your LocalStack container using your preferred method.
22
22
We will demonstrate how to create an Airflow environment and access the Airflow UI.
@@ -153,3 +153,7 @@ The Resource Browser allows you to perform the following actions:
153
153
-**View Environment**: View details of an existing MWAA environment by clicking on the environment name.
154
154
-**Edit Environment**: Edit an existing MWAA environment by clicking on the **Edit** button after clicking on the environment name.
155
155
-**Delete Environment**: Select the environment name and click on the **Actions** button followed by **Remove Selected** button.
156
+
157
+
## Current Limitations
158
+
159
+
- LocalStack MWAA does not support [startup scripts](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html)
0 commit comments