Metadata-Version: 2.4
Name: xrepomirror
Version: 0.2.0
Summary: A CLI tool to mirror helm charts and docker images from public registries to local/private repositories.
Project-URL: Homepage, https://github.com/tkdpython/xrepomirror
Project-URL: Repository, https://github.com/tkdpython/xrepomirror
Project-URL: Issues, https://github.com/tkdpython/xrepomirror/issues
License: MIT License
        
        Copyright (c) 2026 tkdpython
        
        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-File: LICENSE
Keywords: devops,docker,helm,mirror,registry
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Requires-Dist: pyyaml>=5.1
Requires-Dist: requests>=2.20.0
Description-Content-Type: text/markdown

# xrepomirror

A CLI tool to mirror Docker images and Helm charts from public registries to local/private repositories. Designed for air-gapped or restricted environments where workloads cannot pull directly from the internet.

---

## Features

- Mirror Docker images via `docker pull` / `docker tag` / `docker push`
- Mirror Helm charts via `helm pull` / `helm push` (OCI) or Nexus 3 REST API upload
- Proxy support via configurable environment variables
- Single `sources.yaml` configuration file, or recursively process a directory tree of sources files
- Optional per-image `destination:` override to control the destination image name and tag
- Supports Python 3.6 and above

---

## Requirements

- Python 3.6+
- `docker` CLI — available and authenticated to the destination registry
- `helm` CLI (v3) — available and authenticated to the destination registry (for Helm mirroring)

---

## Installation

```bash
pip install xrepomirror
```

Or install from source:

```bash
git clone https://github.com/tkdpython/xrepomirror.git
cd xrepomirror
pip install .
```

---

## Configuration

Create a `sources.yaml` file in your working directory. The file has two top-level keys: `sources` and `settings`.

### Full example

```yaml
sources:
  docker_images:
    - source: docker.io/grafana/grafana:12.3.0
    - source: ghcr.io/grafana/grafana-operator:v5.21.3
      destination: grafana-operator        # keeps source tag, renames image
    - source: quay.io/prometheus/prometheus:v3.9.1
      destination: prometheus:v3.9.1-local # explicit name and tag

  helm_charts:
    - chart: kube-prometheus-stack
      repo: https://prometheus-community.github.io/helm-charts
      version: 80.13.3
    - chart: grafana-operator
      repo: https://grafana.github.io/helm-charts
      version: 5.21.4

settings:
  destination_repositories:
    docker:
      repo: ctr.example.com
    helm:
      repo: repo.example.com/helm
      type: nexus3   # "nexus3" or "oci" (default: "oci")
  env_vars:
    HTTP_PROXY: http://proxy.local:8080
    HTTPS_PROXY: http://proxy.local:8080
    NO_PROXY: .mycompany.co.uk,.svc,.local,localhost
```

### `sources`

| Key | Description |
| --- | --- |
| `docker_images` | List of Docker image references to mirror. Each entry requires a `source` key with the full image reference including tag. An optional `destination` key overrides the destination image name (see [Docker image destination naming](#docker-image-destination-naming)). |
| `helm_charts` | List of Helm charts to mirror. Each entry requires `chart` (chart name), `repo` (upstream Helm repo URL), and `version`. |

### `settings`

| Key | Description |
| --- | --- |
| `destination_repositories.docker.repo` | Destination Docker registry host/prefix (e.g. `ctr.example.com`). |
| `destination_repositories.helm.repo` | Destination Helm repository. For OCI this is the registry path; for Nexus 3 this is `<host>/<repo-name>`. |
| `destination_repositories.helm.type` | How to upload Helm charts — `"oci"` (default, uses `helm push`) or `"nexus3"` (uses the Nexus 3 REST API). |
| `env_vars` | Key/value pairs to set as environment variables before any operations. Existing variables are not overwritten, so values can be overridden at runtime. |

---

## Usage

```text
xrepomirror [--sources FILE | --sources-tree DIR] [--skip-docker] [--skip-helm]
```

| Flag | Description |
| --- | --- |
| `--sources FILE` | Path to a single sources YAML file (default: `sources.yaml` in the current directory). Mutually exclusive with `--sources-tree`. |
| `--sources-tree DIR` | Recursively search `DIR` for `sources.yaml` / `sources.yml` files and process each valid one in turn. Mutually exclusive with `--sources`. |
| `--skip-docker` | Skip mirroring Docker images. |
| `--skip-helm` | Skip mirroring Helm charts. |
| `--version` | Print the version and exit. |

### Examples

Mirror everything using the default `sources.yaml`:

```bash
xrepomirror
```

Mirror only Helm charts:

```bash
xrepomirror --skip-docker
```

Mirror only Docker images using a custom config file:

```bash
xrepomirror --sources /path/to/my-sources.yaml --skip-helm
```

Process all sources files found under a directory tree:

```bash
xrepomirror --sources-tree ./mirror-configs
```

---

## Docker image destination naming

The destination image reference is determined by an optional `destination` key on each docker image entry:

| Entry | Destination (`ctr.example.com`) |
| --- | --- |
| `source: docker.io/grafana/grafana:12.3.0` *(no destination)* | `ctr.example.com/docker.io/grafana/grafana:12.3.0` |
| `source: docker.io/grafana/grafana:12.3.0`<br>`destination: grafana` *(name only)* | `ctr.example.com/grafana:12.3.0` *(source tag preserved)* |
| `source: docker.io/grafana/grafana:12.3.0`<br>`destination: grafana:superversion` *(name + tag)* | `ctr.example.com/grafana:superversion` |

When no `destination` is given the full source reference (including the original registry) is appended to the destination repo, preserving the complete image path.

---

## Helm destination types

### OCI (default)

Charts are pushed using `helm push` to an OCI-compatible registry:

```yaml
settings:
  destination_repositories:
    helm:
      repo: ctr.example.com/helm-charts
      type: oci
```

### Nexus 3

Charts are uploaded via the Nexus 3 REST API (`POST /service/rest/v1/components`). The `repo` value must be in the format `<host>/<repository-name>`:

```yaml
settings:
  destination_repositories:
    helm:
      repo: repo.example.com/helm
      type: nexus3
```

---

## Proxy support

Set `env_vars` in `sources.yaml` to inject proxy settings before any network operations. Standard proxy variables are supported: `HTTP_PROXY`, `HTTPS_PROXY`, `NO_PROXY` (and their lowercase equivalents). Variables that are already set in the shell environment take precedence over values in `sources.yaml`.

---

## Dependencies

| Package | Purpose |
| --- | --- |
| `PyYAML>=5.1` | Parsing `sources.yaml` |
| `requests>=2.20.0` | Nexus 3 REST API uploads |

---

## License

MIT
