Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brthor/docker-push-ssh
Push docker images from your local machine to remote servers without the hassle.
https://github.com/brthor/docker-push-ssh
automation ci deployment docker docker-push kubernetes ssh
Last synced: about 2 months ago
JSON representation
Push docker images from your local machine to remote servers without the hassle.
- Host: GitHub
- URL: https://github.com/brthor/docker-push-ssh
- Owner: brthor
- License: apache-2.0
- Created: 2018-09-12T00:51:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-15T19:42:10.000Z (almost 3 years ago)
- Last Synced: 2024-09-26T09:25:34.806Z (3 months ago)
- Topics: automation, ci, deployment, docker, docker-push, kubernetes, ssh
- Language: Python
- Size: 36.1 KB
- Stars: 125
- Watchers: 6
- Forks: 19
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-push-ssh
[](https://pypi.org/project/docker-push-ssh)
[](https://travis-ci.org/brthor/docker-push-ssh)
Push docker images from your local machine to remote servers without the hassle.
## Overview
`docker-push-ssh` is a command line utility to push docker images from your local machine to your remote machine via ssh.
It creates a private docker registry on your server, establishes a ssh tunnel (so the registry is never exposed to the public),
and uploads your docker image over this ssh tunnel.
Tested on OS X with "Docker for Mac".
## Install
1. Install via pip:
`pip install docker-push-ssh`
2. Add `localhost:5000` to your docker client's insecure registries (requires restart of docker):
[[OS X] How to Add Insecure Registry](https://stackoverflow.com/questions/32808215/where-to-set-the-insecure-registry-flag-on-mac-os)
[[Linux] How to Add Insecure Registry](https://stackoverflow.com/questions/42211380/add-insecure-registry-to-docker)
Adding `localhost:5000` to your client's insecure registries is inconvenient but a side-effect of docker's design.
It only needs to be done once from each machine using `docker-push-ssh`. This allows the tool to push through the ssh
tunnel at `localhost:5000` to the temporary registry on your remote host, without needing ssl certificates for your server.
## Usage:
```bash
$ docker-push-ssh --help
usage: cli.py [-h] [-i SSH_IDENTITY_FILE] [-p SSH_PORT] [-r REGISTRY_PORT]
[--prime-image PRIME_IMAGE]
ssh_host docker_image [docker_image ...]
A utility to securely push a docker image from your local host to a remote
host over ssh without using docker save/load or needing to setup a private
registry.
positional arguments:
ssh_host Host to push docker image to. (ex.
[email protected])
docker_image Docker image tag(s) to push. Specify one or more
separated by spaces.
optional arguments:
-h, --help show this help message and exit
-i SSH_IDENTITY_FILE, --ssh-identity-file SSH_IDENTITY_FILE
[required] Path to the ssh identity file on your local
host. Required, password auth not supported.
-p SSH_PORT, --ssh-port SSH_PORT
[optional] Port on ssh host to connect to. (Default is
22)
-r REGISTRY_PORT, --registry-port REGISTRY_PORT
[optional] Remote registry port on ssh host to forward
to. (Default is 5000)
--prime-image PRIME_IMAGE
[optional] [list] Base images with which to prime the
registry from the remote host. Docker pull is
performed on the remote host.
```
## Examples
First create a test image we can use:
```bash
$ mkdir /tmp/testimage && cd /tmp/testimage
$ echo "FROM alpine" >> ./Dockerfile
$ echo "RUN touch /etc/testimage" >> ./Dockerfile
$ docker build -t testimage .
```
Now push that test image to our remote server:
```bash
$ docker-push-ssh -i ~/my_identity_file [email protected] testimage
...
```
Now the `testimage` will be present on your server.
## Caveats
1. SSH password authentication is not supported. Only key files.
2. Password-protected SSH keys may not be supported. You can generate a temporary, non-protected key using `ssh-keygen -P "" -f /tmp/my-tmpkey`