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
This section provides a brief overview of how to develop your own extensions.
@@ -101,12 +103,12 @@ class ReadyAnnouncerExtension(Extension):
101
103
LOG.info("my plugin is loaded and localstack is ready to roll!")
102
104
```
103
105
104
-
{{< callout >}}
106
+
:::note
105
107
A note on importing LocalStack modules: since extensions run in the same Python process as the LocalStack runtime,
106
108
you can also import other LocalStack modules outside the `localstack.extensions.api` module, and work with them.
107
109
However, be aware that these modules are not part of our public API, and can change even with patch versions any time.
108
110
Your extension may break in unexpected ways, and we cannot provide support for internal APIs.
109
-
{{</callout>}}
111
+
:::
110
112
111
113
## Packaging extensions
112
114
@@ -172,7 +174,7 @@ Commands:
172
174
First, create a new extension from a template.
173
175
To use `localstack extensions dev new`, you will also need to install [cookiecutter](https://github.com/cookiecutter/cookiecutter) via `pip install cookiecutter`.
174
176
175
-
{{< command >}}
177
+
```bash
176
178
$ localstack extensions dev new
177
179
project_name [My LocalStack Extension]:
178
180
project_short_description [All the boilerplate you need to create a LocalStack extension.]:
Copy file name to clipboardExpand all lines: src/content/docs/aws/tooling/extensions/extensions-library.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ A LocalStack extension is a Python application that runs together with LocalStac
13
13
14
14
LocalStack extensions are available to licensed users, and the list of available extensions can be found in the [Extensions Library](https://app.localstack.cloud/extensions/library).
Copy file name to clipboardExpand all lines: src/content/docs/aws/tooling/extensions/getting-started.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ In this guide, you will install and use the [official MailHog extension for Loca
22
22
To get started, start your LocalStack instance with your `LOCALSTACK_AUTH_TOKEN`.
23
23
Access our [Extension Manager](https://app.localstack.cloud/inst/default/extensions/manage), and click the **Install** button for the MailHog extension.
- Explore our collection of official extensions, along with a growing ecosystem of third-party extensions, in our [Extensions Library](https://app.localstack.cloud/extensions/library).
76
76
- Learn about the various methods for extension management and automating their installation when using LocalStack in a CI environment.
77
-
Get detailed insights from our [Managing Extensions]({{< ref "managing-extensions" >}}) guide.
77
+
Get detailed insights from our [Managing Extensions](/aws/tooling/extensions/managing-extensions) guide.
78
78
- Want to create your own extensions?
79
-
Dive into our guide on [Developing Extensions]({{< ref "developing-extensions" >}}) for step-by-step instructions.
79
+
Dive into our guide on [Developing Extensions](/aws/tooling/extensions/developing-extensions) for step-by-step instructions.
LocalStack Extensions allow developers to extend and customize LocalStack.
12
13
Extensions are a feature of our paid offering.
@@ -21,10 +22,10 @@ You can use LocalStack Extensions to:
21
22
- Instrumenting AWS requests with additional information before they reach your Lambdas.
22
23
- Logging AWS API calls to custom data backends.
23
24
24
-
The officially supported [LocalStack Extensions]({{< ref "user-guide/extensions/official-extensions" >}}) can be discovered on our [Extension Library](https://app.localstack.cloud/extensions/library).
25
+
The officially supported [LocalStack Extensions]({/aws/tooling/extensions/official-extensions) can be discovered on our [Extension Library](https://app.localstack.cloud/extensions/library).
25
26
To install and use extensions, you need an active LocalStack license.
26
27
27
-
{{< callout >}}
28
+
:::note
28
29
The feature and the API are currently in a preview stage and may be subject to change.
29
30
Please report any issues or feature requests on [LocalStack Extension's GitHub repository](https://github.com/localstack/localstack-extensions).
Copy file name to clipboardExpand all lines: src/content/docs/aws/tooling/extensions/localstack-docker-extension.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,33 +11,32 @@ sidebar:
11
11
The LocalStack Extension for Docker Desktop enables developers working with LocalStack to operate their LocalStack container via Docker Desktop, including checking service status, container logs, and configuring profiles.
12
12
To install the LocalStack Extension for Docker Desktop, you need to have [Docker Desktop installed on your machine](https://www.docker.com/products/docker-desktop).
13
13
14
-
<imgsrc="localstack-docker-extension.png"alt="LocalStack Extension for Docker Desktop"title="LocalStack Extension for Docker Desktop"width="800px" />
14
+

15
15
16
16
## Installation
17
17
18
18
To utilize LocalStack's Docker Extension, it is necessary to have a recent version of Docker Desktop (v4.8 or higher) installed on the local machine.
19
19
To enable the extension, access the **Extensions** tab and select the **Enable Docker Extensions** and **Show Docker Extensions system containers** option.
20
20
21
-
<imgsrc="localstack-docker-extension-preferences.png"title="Enable Docker Extensions in the Preferences within the Extensions tab"alt="Enable Docker Extensions in the Preferences within the Extensions tab"width="800px" />
22
-
<br></br>
21
+

23
22
24
23
The LocalStack Extension for Docker Desktop has been validated and can be accessed on the Extensions Marketplace.
25
24
To begin using it, navigate to the **Extensions Marketplace**, search for **LocalStack**, and click the **Install** button to proceed with the installation.
26
25
27
-
<imgsrc="localstack-docker-extension-marketplace.png"title="Discover the LocalStack Extension on the Docker Desktop Marketplace and install it!"width="800px"alt="Discover the LocalStack Extension on the Docker Desktop Marketplace and install it!" />
28
-
<br></br>
26
+

29
27
30
28
An alternative method for installing the LocalStack's Extension for Docker Desktop is pulling the [public Docker image](https://hub.docker.com/r/localstack/localstack-docker-desktop) from Docker Hub and installing it!
After installation, you can access the LocalStack Extension for Docker Desktop from the **Extensions** tab.
37
35
Upon the initial launch of the extension, a prompt to select a mount point for the LocalStack container will appear.
38
36
Select your username from the drop-down menu.
39
37
Furthermore, you can modify this setting later by navigating to the **Configurations** tab and choosing a different mount point.
40
38
39
+

41
40
<imgsrc="localstack-docker-extension-mount-point.png"title="Select the mount point upon the launch of LocalStack's Docker extension"alt="Select the mount point upon the launch of LocalStack's Docker extension"width="800px" />
42
41
43
42
## Features
@@ -50,19 +49,19 @@ The extension includes container management, configuration profile management, s
50
49
You can start, stop, and restart LocalStack from the Docker Desktop.
51
50
You can also see the current status of your LocalStack container and navigate to LocalStack Web Application.
52
51
53
-
<imgsrc="localstack-docker-extension-start.png"title="Start and Stop your LocalStack container with a single click of a button with LocalStack's extension"alt="Start and Stop your LocalStack container with a single click of a button with LocalStack's extension"width="800px" />
52
+

54
53
55
54
### Container logs
56
55
57
56
You can see the log information of the LocalStack container and all the available services and their status on the service page.
58
57
59
-
<imgsrc="localstack-docker-extension-logs.png"title="Check the logs of your running LocalStack container through LocalStack's Docker extension"alt="Check the logs of your running LocalStack container through LocalStack's Docker extension"width="800px" />
58
+

60
59
61
60
### Configuration management
62
61
63
62
You can manage and use your profiles via configurations and create new configurations for your LocalStack container.
64
63
65
-
<imgsrc="localstack-docker-extension-configuration-profile.png"title="Create your configuration profiles within LocalStack's Extension to affect the state of LocalStack"alt="Create your configuration profiles within LocalStack's Extension to affect the state of LocalStack"width="800px" />
64
+

0 commit comments