Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plexsystems/sinker
A tool to sync images from one container registry to another
https://github.com/plexsystems/sinker
Last synced: 9 days ago
JSON representation
A tool to sync images from one container registry to another
- Host: GitHub
- URL: https://github.com/plexsystems/sinker
- Owner: plexsystems
- License: mit
- Created: 2020-05-08T20:23:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-13T22:25:52.000Z (5 months ago)
- Last Synced: 2024-08-01T19:46:42.865Z (3 months ago)
- Language: Go
- Homepage:
- Size: 1.35 MB
- Stars: 603
- Watchers: 14
- Forks: 53
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-repositories - plexsystems/sinker - A tool to sync images from one container registry to another (Go)
- awesome-k8s - Sinker
- awesome-cloud-native - Sinker - A tool to sync images from one container registry to another. (Image)
README
# Sinker
[](https://goreportcard.com/report/github.com/plexsystems/sinker)
[](https://github.com/plexsystems/sinker/releases)
`sinker` syncs container images from one registry to another. This is useful in cases when you rely on images that exist in a public container registry, but need to pull from a private registry.
Images can be sync'd either by using [The image manifest](#the-image-manifest) or via the command line.
See the [example](https://github.com/plexsystems/sinker/tree/main/example) folder for more details on the produced files.
## Installation
`go install github.com/plexsystems/sinker@latest`
Releases are also provided in the [releases](https://github.com/plexsystems/sinker/releases) tab on GitHub.
## The image manifest
### The target section
```yaml
target:
host: mycompany.com
repository: myteam
```
The `target` section is where the images will be synced to. The above yaml would sync all images to the `myteam` repository hosted at `mycompany.com` (`mycompany.com/myteam/...`)
### The images section
```yaml
target:
host: mycompany.com
repository: myteam
sources:
- repository: coreos/prometheus-operator
host: quay.io
tag: v0.40.0
- repository: super/secret
tag: v0.3.0
auth:
username: DOCKER_USER_ENV
password: DOCKER_PASSWORD_ENV
- repository: nginx
digest: sha256:bbda10abb0b7dc57cfaab5d70ae55bd5aedfa3271686bace9818bba84cd22c29
```
### Optional host defaults to Docker Hub
In both the `target` and `sources` section, the `host` field is _optional_. When no host is set, the host is assumed to be Docker Hub.
### Auth
All auth is handled by looking at the clients Docker auth. If the client can perform a `docker push` or `docker pull`, sinker will be able to as well.
Optionally, the `auth` section allows you to set the names of _environment variables_ that will be used for creating basic auth to the registry. This could be useful in pipelines where auth is stored in environment variables.
## Sync behavior
If the `target` registry supports nested paths, the entire source repository will be pushed to the target. For example, the `prometheus-operator` would be pushed to:
```text
mycompany.com/myteam/coreos/prometheus-operator:v0.40.0
```
**Registries that support nested paths:** Azure Container Registry (ACR), Amazon Elastic Container Registry (ECR), Google Container Registry (GCR)
If the `target` registry does _not_ support nested paths, only the base path of the source will be pushed to the target registry. For example, the `prometheus-operator` would be pushed to:
```text
mycompany.com/myteam/prometheus-operator:v0.40.0
```
**Registries that do not support nested paths:** Docker Hub, GitHub Container Registry, Quay.io
## Demo
An example run of the `sinker pull` command which pulls all images specified in the image manifest.
For additional help, you can run `sinker help`.