diff --git a/README.md b/README.md index f802472a..1c3d542b 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,37 @@ scoop install sq go install github.com/neilotoole/sq ``` +### Docker + +The [`ghcr.io/neilotoole/sq`](https://github.com/neilotoole/sq/pkgs/container/sq) +image is preloaded with `sq` and a handful of related tools like `jq`. + +#### Local + +```shell +# Shell into a one-time container. +$ docker run -it ghcr.io/neilotoole/sq zsh + +# Start detached (background) container named "sq-shell". +$ docker run -d --name sq-shell ghcr.io/neilotoole/sq +# Shell into that container. +$ docker exec -it sq-shell zsh +``` + +#### Kubernetes + +Running `sq` in a Kubernetes environment is useful for DB migrations, +as well as general data wrangling. + +```shell +# Start pod named "sq-shell". +$ kubectl run sq-shell --image ghcr.io/neilotoole/sq +# Shell into the pod. +$ kubectl exec -it sq-shell -- zsh +``` + + + See other [install options](https://sq.io/docs/install/). ## Overview diff --git a/packages/docker/README.md b/packages/docker/README.md index 19c549d0..5b6c31e7 100644 --- a/packages/docker/README.md +++ b/packages/docker/README.md @@ -11,7 +11,7 @@ includes a bunch of additional tools. # Shell into a one-time container. $ docker run -it ghcr.io/neilotoole/sq zsh -# Start container named "sq-shell" as a daemon. +# Start container named "sq-shell" detached (in the background). $ docker run -d --name sq-shell ghcr.io/neilotoole/sq # Shell into that container. $ docker exec -it sq-shell zsh @@ -23,5 +23,5 @@ $ docker exec -it sq-shell zsh # Start pod named "sq-shell". $ kubectl run sq-shell --image ghcr.io/neilotoole/sq # Shell into the pod. -$ k exec -it sq-shell -- zsh +$ kubectl exec -it sq-shell -- zsh ``` diff --git a/packages/docker/alpine.Dockerfile b/packages/docker/alpine.Dockerfile index 008880b7..0148d90f 100644 --- a/packages/docker/alpine.Dockerfile +++ b/packages/docker/alpine.Dockerfile @@ -1,5 +1,9 @@ FROM alpine:3.19 +LABEL org.opencontainers.image.source='https://github.com/neilotoole/sq' +LABEL org.opencontainers.image.description='sq data wrangler, on Alpine Linux' +LABEL org.opencontainers.image.licenses=MIT + WORKDIR /root RUN apk add --update --no-cache curl gnupg wget bash bash-completion zsh \