Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

migrate docker desktop extension to integrations #994

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ See [LocalStack Desktop]({{< ref "localstack-desktop" >}}).
### LocalStack Docker Extension

Install our [official Docker Desktop extension](https://hub.docker.com/extensions/localstack/localstack-docker-desktop) to manage LocalStack.
See [LocalStack Docker Extension]({{< ref "localstack-docker-extension" >}}).
See [LocalStack Docker Extension]({{< ref "docker-desktop" >}}).

### Docker-Compose

Expand Down
Original file line number Diff line number Diff line change
@@ -1,58 +1,60 @@
---
title: "LocalStack Docker Extension"
weight: 8
description: >
Getting started with LocalStack Extension for Docker Desktop
tags: ["docker-desktop", "docker"]
title: "Docker Desktop"
linkTitle: "Docker Desktop"
weight: 90
description: Use the LocalStack Extension for Docker Desktop to manage your LocalStack container
aliases:
- /tools/docker-desktop-extension/
- /user-guide/tools/docker-desktop-extension/
- /user-guide/tools/localstack-docker-extension
---

## Introduction

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. 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).

<img src="localstack-docker-extension.png" alt="LocalStack Extension for Docker Desktop" title="LocalStack Extension for Docker Desktop" width="900" />
<img src="localstack-docker-extension.png" alt="LocalStack Extension for Docker Desktop" title="LocalStack Extension for Docker Desktop" width="800px" class="img-fluid shadow rounded" />

## Installation

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. To enable the extension, access the **Preferences** tab and select the **Enable Docker Extensions** option within the **Extensions** tab.

<img src="localstack-docker-extension-preferences.png" title="Enable Docker Extensions in the Preferences within the Extensions tab" width="900" />
<img src="localstack-docker-extension-preferences.png" title="Enable Docker Extensions in the Preferences within the Extensions tab" width="800px" class="img-fluid shadow rounded" />
<br></br>

The LocalStack Extension for Docker Desktop has been validated and can be accessed on the Extensions Marketplace. To begin using it, navigate to the **Extensions Marketplace**, search for **LocalStack**, and click the **Install** button to proceed with the installation.

<img src="localstack-docker-extension-marketplace.png" title="Discover the LocalStack Extension on the Docker Desktop Marketplace and install it!" width="900" />
<img src="localstack-docker-extension-marketplace.png" title="Discover the LocalStack Extension on the Docker Desktop Marketplace and install it!" width="800px" class="img-fluid shadow rounded" />
<br></br>

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!

{{< command >}}
$ docker extension install localstack/localstack-docker-desktop:0.3.1
$ docker extension install localstack/localstack-docker-desktop:0.5.2
{{< /command >}}

After installation, you can access the LocalStack Extension for Docker Desktop from the **Extensions** tab. Upon the initial launch of the extension, a prompt to select a mount point for the LocalStack container will appear. 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.

<img src="localstack-docker-extension-mount-point.png" title="Select the mount point upon the launch of LocalStack's Docker extension" width="900" />
<img src="localstack-docker-extension-mount-point.png" title="Select the mount point upon the launch of LocalStack's Docker extension" width="800px" class="img-fluid shadow rounded" />

## Features

LocalStack's Docker Extension helps users to manage their LocalStack container with a simple and intuitive user interface through Docker Desktop. The extension includes container management, configuration profile management, service status, and container logs!

### Control LocalStack
### Container management

You can start, stop, and restart LocalStack from the Docker Desktop. You can also see the current status of your LocalStack container and navigate to LocalStack Web Application.

<img src="localstack-docker-extension-start.png" title="Start and Stop your LocalStack container with a single click of a button with LocalStack's extension" width="900" />
<img src="localstack-docker-extension-start.png" title="Start and Stop your LocalStack container with a single click of a button with LocalStack's extension" width="800" class="img-fluid shadow rounded" />

### LocalStack insights
### Container logs

You can see the log information of the LocalStack container and all the available services and their status on the service page.

<img src="localstack-docker-extension-logs.png" title="Check the logs of your running LocalStack container through LocalStack's Docker extension" width="900" />
<img src="localstack-docker-extension-logs.png" title="Check the logs of your running LocalStack container through LocalStack's Docker extension" width="800px" class="img-fluid shadow rounded" />

### LocalStack configurations
### Configuration management

You can manage and use your profiles via configurations and create new configurations for your LocalStack container.

<img src="localstack-docker-extension-configuration-profile.png" title="Create your configuration profiles within LocalStack's Extension to affect the state of LocalStack" width="900" />
<img src="localstack-docker-extension-configuration-profile.png" title="Create your configuration profiles within LocalStack's Extension to affect the state of LocalStack" width="800px" class="img-fluid shadow rounded" />
59 changes: 59 additions & 0 deletions content/en/user-guide/integrations/rancher-desktop/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Rancher Desktop"
linkTitle: "Rancher Desktop"
weight: 91
description: Use the Rancher Desktop to manage your LocalStack container in a Kubernetes cluster
---

## Introduction

Rancher Desktop is a desktop application designed to simplify the local deployment of Kubernetes clusters. It leverages `k3s`, a lightweight and certified Kubernetes distribution offered by Rancher. For container management, Rancher Desktop provides flexibility by supporting either the `docker` CLI (powered by Moby/dockerd) or `nerdctl` (`containerd`) as container runtimes.

## Installation

To use LocalStack with Rancher Desktop, the following prerequisites need to be met:

* [Rancher Desktop](https://rancherdesktop.io) installed on your machine
* [Helm](https://helm.sh) installed on your machine
* [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) installed on your machine

### Setup a Kubernetes Cluster

Launch Rancher Desktop and create a new Kubernetes cluster. You can switch your `kubectl` context to the new cluster by running the following command:

{{< command >}}
$ kubectl config use-context rancher-desktop
{{< /command >}}

### Deploy LocalStack via Helm

To deploy LocalStack in the Kubernetes cluster, we can use the [LocalStack Helm chart](https://github.com/localstack/helm-charts) as follows:

{{< command >}}
$ helm repo add localstack https://localstack.github.io/helm-charts
$ helm repo update
{{< /command >}}

You can install LocalStack in the Kubernetes cluster by running the following command:

{{< command >}}
$ helm upgrade --install localstack localstack/localstack --namespace localstack --create-namespace --wait
{{< /command >}}

### Access LocalStack

Once the installation is complete, you can query the status of the LocalStack deployment by running the following command:

{{< command >}}
$ export NODE_PORT=$(kubectl get --namespace "localstack" -o jsonpath="{.spec.ports[0].nodePort}" services localstack)
{{< /command >}}

You can now configure `AWS_ENDPOINT_URL` to allow your integrations, such as the AWS CLI, to connect to LocalStack:

{{< command >}}
export NODE_IP=127.0.0.1
export AWS_ENDPOINT__URL=http://$NODE_IP:$NODE_PORT
awslocal s3api create-bucket --bucket test-bucket
{{< /command >}}

The `awslocal` CLI will now connect to LocalStack running in the Kubernetes cluster and create a new S3 bucket named `test-bucket`.