extension intro

Author: dzsquared

.dockerignore

@@ -0,0 +1 @@
+ui/node_modules

.github/workflows/ci-container-build.yml

@@ -0,0 +1,19 @@
+name: "CI - Docker image build"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Build the Docker image
+      run: docker build . --file Dockerfile --tag drewsk/docker-sql-extension:$(date +%s)

.github/workflows/ci-go-test.yml

@@ -0,0 +1,20 @@
+name: "CI - go tests"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+
+  gotest:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: 'run go tests'
+      working-directory: ./backend
+      run: go test -v ./...

.github/workflows/docker-publish.yml

@@ -0,0 +1,89 @@
+name: Docker image publish
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  workflow_dispatch:
+    inputs:
+      vTag:
+        required: true
+        type: string
+
+env:
+  REGISTRY: docker.io
+  IMAGE_NAME: drewsk/docker-sql-extension
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # https://github.com/sigstore/cosign-installer
+      - name: Install cosign
+        uses: sigstore/cosign-installer@59acb6260d9c0ba8f4a2f9d9b48431a222b68e20 #v3.5.0
+        with:
+          cosign-release: 'v2.2.4'
+
+      # Set up BuildKit Docker container builder to be able to build
+      # multi-platform images and export cache
+      # https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
+
+      # Login against a Docker registry
+      # https://github.com/docker/login-action
+      - name: Log into dockerhub
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+        with:
+          username: ${{ secrets.DH_USER }}
+          password: ${{ secrets.DH_PAT }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # Build and push Docker image with Buildx
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      # Sign the resulting Docker image digest except on PRs.
+      # This will only write to the public Rekor transparency log when the Docker
+      # repository is public to avoid leaking data.  If you would like to publish
+      # transparency data even for private images, pass --force to cosign below.
+      # https://github.com/sigstore/cosign
+      - name: Sign the published Docker image
+        env:
+          # https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
+          TAGS: ${{ steps.meta.outputs.tags }}
+          DIGEST: ${{ steps.build-and-push.outputs.digest }}
+        # This step uses the identity token to provision an ephemeral certificate
+        # against the sigstore community Fulcio instance.
+        run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+ui/build

Database.png

@@ -0,0 +1,59 @@
+FROM golang:1.23-alpine3.20 AS builder
+ENV CGO_ENABLED=0
+WORKDIR /backend
+COPY backend/go.* .
+RUN --mount=type=cache,target=/go/pkg/mod \
+    --mount=type=cache,target=/root/.cache/go-build \
+    go mod download
+COPY backend/. .
+RUN --mount=type=cache,target=/go/pkg/mod \
+    --mount=type=cache,target=/root/.cache/go-build \
+    go build -trimpath -ldflags="-s -w" -o bin/service
+
+FROM --platform=$BUILDPLATFORM node:20.18-alpine3.20 AS client-builder
+WORKDIR /ui
+# cache packages in layer
+COPY ui/package.json /ui/package.json
+COPY ui/package-lock.json /ui/package-lock.json
+RUN --mount=type=cache,target=/usr/src/app/.npm \
+    npm set cache /usr/src/app/.npm && \
+    npm ci
+# install
+COPY ui /ui
+RUN npm run build
+
+
+FROM debian:bullseye AS cli-stage
+ARG TARGETARCH
+COPY cli-${TARGETARCH}.sh .
+RUN apt-get update && apt-get install -y curl bzip2 && \
+    chmod +x cli-${TARGETARCH}.sh
+RUN ./cli-${TARGETARCH}.sh
+
+FROM debian:bullseye-slim
+LABEL org.opencontainers.image.title="Docker SQL Dev: SQL dev container manager" \
+    org.opencontainers.image.description="SQL databases on demand, locally and easily" \
+    org.opencontainers.image.vendor="DrewSK.Tech" \
+    com.docker.desktop.extension.api.version="0.3.4" \
+    com.docker.extension.screenshots="[{\"alt\":\"SQL extension with container details expanded.\", \"url\":\"https://raw.githubusercontent.com/dzsquared/docker-sql-extension/main/images/screenshot2.png\"}, {\"alt\":\"SQL extension with two containers listed.\", \"url\":\"https://raw.githubusercontent.com/dzsquared/docker-sql-extension/main/images/screenshot1.png\"}]" \
+    com.docker.desktop.extension.icon="https://raw.githubusercontent.com/dzsquared/docker-sql-extension/main/Database.png" \
+    com.docker.extension.detailed-description="With the SQL extension you can create a new SQL container quickly in Docker Desktop. Select the version of SQL Server you want to use, enter a container name, SQL port, and generate a password before clicking the plus button to create the container. Once a container is created, you can start, stop, and delete it using the buttons in the extension tab. Connect to the container directly in the extension with the embedded sqlcmd tool or by using your preferred SQL client. For convenience the connection string is displayed in the extension tab and a button for launching Azure Data Studio is provided." \
+    com.docker.extension.publisher-url="https://github.com/dzsquared/docker-sql-extension" \
+    com.docker.extension.additional-urls="[{\"title\":\"Source code and notices\",\"url\":\"https://github.com/dzsquared/docker-sql-extension/blob/main/README.md\"},\
+    {\"title\":\"License\",\"url\":\"https://github.com/dzsquared/docker-sql-extension/blob/main/LICENSE\"}]" \
+    com.docker.extension.categories="database" \
+    com.docker.extension.changelog="<h3>1.0, Initial release</h3><ul><li>SQL container creation</li><li>Connection strings</li><li>Add and list databases</li><li>Embedded sqlcmd CLI</li></ul>"
+
+COPY --from=builder /backend/bin/service /
+COPY --from=client-builder /ui/build ui
+COPY --from=cli-stage /usr/bin/ttyd /usr/bin/ttyd
+COPY --from=cli-stage /usr/bin/sqlcmd /usr/bin/sqlcmd
+COPY docker-compose.yaml .
+COPY metadata.json .
+COPY database.svg .
+COPY host /host
+
+COPY sql.sh /cli/sql.sh
+RUN chmod +x /cli/sql.sh 
+
+CMD /service -socket /run/guest-services/backend.sock

Dockerfile

@@ -0,0 +1,7 @@
+Copyright 2025 Drew Skwiers-Koballa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE

@@ -0,0 +1,111 @@
+# Local SQL
+
+This repository contains the code for the Docker [SQL extension](), which enables you to create and manage SQL containers in Docker Desktop.
+
+## Get started
+
+After installing the extension, you can create a new SQL container by clicking on the "SQL containers" extension tab in Docker Desktop. Select the version of SQL Server you want to use, enter a container name, SQL port, and generate a password before clicking the plus button to create the container.
+
+Once a container is created, you can start, stop, and delete it using the buttons in the extension tab. You can connect to the container directly in the extension with the embedded sqlcmd tool or by using your preferred SQL client. For convenience the connection string is displayed in the extension tab and a button for launching Azure Data Studio is provided.
+
+_When launching Azure Data Studio from the extension the sa password is automatically copied into the clipboard, paste it in the connection dialog when Azure Data Studio opens._
+
+![Docker SQL extension](./images/screenshot2.png)
+
+A full help guide is available in the extension tab under the question mark icon.
+
+## Support
+
+This extension is a hobby project and is not officially supported by Microsoft or Docker. If you encounter any issues, please open an issue in this repository.
+
+## Contributing
+
+The extension is licensed under the [MIT license](./LICENSE). Feel free to open issues and pull requests to improve the extension. I'm interested in investment in:
+
+- cross compatibility as a Podman desktop extension
+- selected options for container creation (eg Express vs Developer SKU)
+- deploying dacpac files to the container
+- your good ideas
+
+This extension code is composed of:
+
+- A [frontend](./ui) app in React that dictates the display in Docker Desktop.
+- A [backend](./backend) container that runs an API in Go. It exposes the endpoints which interact with the docker daemon and with SQL endpoints.
+- A [host](./host) folder that contains executables the extension needs to create and delete SQL containers.
+- A [Dockerfile](./Dockerfile) that builds the extension.
+
+## Local development
+
+To build the extension, use:
+
+```shell
+  docker build -t drewsk/docker-sql-extension:latest --no-cache .
+```
+
+To install the extension, use :
+
+```shell
+  docker extension install drewsk/docker-sql-extension:latest
+```
+
+> If you want to automate this command, use the `-f` or `--force` flag to accept the warning message.
+
+To preview the extension in Docker Desktop, open Docker Dashboard once the installation is complete. The left-hand menu displays a new tab with the name of your extension. You can also use `docker extension ls` to see that the extension has been installed successfully.
+
+To update the extension after making changes, use:
+
+```shell
+  docker extension update drewsk/docker-sql-extension:latest
+```
+
+### Frontend development
+
+During the development of the frontend part, it's helpful to use hot reloading to test your changes without rebuilding the entire extension. To do this, you can configure Docker Desktop to load your UI from a development server.
+
+To start the local development server, run:
+
+```shell
+  cd ui
+  npm install
+  npm run dev
+```
+
+You can now tell Docker Desktop to use this as the frontend source. In another terminal run:
+
+```shell
+  docker extension dev ui-source drewsk/docker-sql-extension:latest http://localhost:5173
+```
+
+In order to open the Chrome Dev Tools for the extension when you click on the extension tab, run:
+
+```shell
+  docker extension dev debug drewsk/docker-sql-extension:latest
+```
+
+Each subsequent click on the extension tab will also open Chrome Dev Tools. To stop this behaviour, run:
+
+```shell
+  docker extension dev reset drewsk/docker-sql-extension:latest
+```
+
+### Backend development
+
+This extension includes an API in Go that is deployed as a backend container when the extension is installed. This backend container is responsible for handling requests from the frontend and hosts go-sqlcmd for on-demand CLI access to SQL containers.
+
+Whenever you make changes in the [backend](./backend) source code, you will need to compile them and re-deploy a new version of your backend container.
+Use the `docker extension update` command to remove and re-install the extension automatically:
+
+```shell
+docker extension update drewsk/docker-sql-extension:latest
+```
+
+> [!TIP]
+> Extension containers are hidden from the Docker Dashboard by default. You can change this in Settings > Extensions > Show Docker Extensions system containers.
+
+## Notices
+
+The extension is licensed under the [MIT license](./LICENSE).
+
+The SQL containers extension is designed for local development and testing purposes. The extension does not support production workloads or high availability scenarios. SQL Server instances created by this extension are configured with the default settings and the SQL Server Express license.
+
+This extension collects anonymous usage data to help improve the extension. The data collected includes the number of containers created and instances of other actions taken with the extension. The data is used for improving the extension. To disable data collection, obtain the extension source from GitHub and build the extension locally with the Application Insights connection string removed from App.tsx.