Skip to main content

kubelink automatically sync files to kubernetes pods. It speed up your development. You just work with your local files and kubelink automatically syncing them to your kubernetes cluster.

Using kubelink is as simple as:

  1. kubelink create --name mypreset --source ./ --destination /code --namespace default --selector "app=backend" to create a preset with your settings
  2. kubelink watch mypreset to start syncing files

kubelink based on kubectl cp and kubectl exec commands. So, kubelink is lightweight utility.

Requirements

  • Python >= 3.7
  • kubelink requires that the tar binary is present in your kubernetes container. If tar is not present, kubelink will fail.

Installation

Via pip

pip install kubelink

From source code

git clone https://github.com/waverage/kubelink.git
cd kubelink
python setup.py buiild
python setup.py install

Usage

kubelink create

Create a kubelink config preset with your sync settings.

kubelink create --name mypreset --source /Users/bob/myproject --destination /code --namespace default --selector "app=backend"
  • --name - kubelink preset name
  • -s, --source - Local source directory to sync
  • -d, --destination - Destination directory in kubernetes pod
  • --namespace - Kubernetes namespace
  • -l, --selector - Label selector to find pod. For example: -s "app=php"
  • -c, --container - Container name. Required if pod contains more than one container
  • -h, --help - Show help
  • --log - Set log level. Default: info. Available levels: info, debug, error

The presets file location is ~/.kubelink/config.yaml. You can create multiple config presets.

Help available by command:

kubelink create -h

kubelink watch

Start watching for real-time synchronizations.

kubelink watch mypreset
  • name - kubelink preset name
  • -h, --help - Show help
  • --log - Set log level. Default: info. Available levels: info, debug, error

Help available by command:

kubelink watch -h

How to build and publish package

  1. Build setup.py
python setup.py sdist bdist_wheel
  1. Upload package to Pypi
twine upload dist/*

Metadata

Release files for kubelink 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kubelink 0.0.4
File Size Uploaded Provenance
kubelink-0.0.4.tar.gz 7.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for kubelink 0.0.4
File Interpreter ABI Platform
kubelink-0.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 15.7 kB

Security for kubelink 0.0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page