README
¶
kubedog
Kubedog is a library to watch and follow Kubernetes resources in CI/CD deploy pipelines.
This library is used in the werf CI/CD tool to track resources during deploy process.
NOTE: Kubedog also includes a CLI, however it provides a minimal interface to access library functions. CLI was created to check library features and for debug purposes. Currently, we have no plans on further improvement of CLI.
Table of Contents
Install kubedog CLI
Linux/macOS
Install trdl to ~/bin/trdl, which will manage kubedog installation and updates. Add ~/bin to your $PATH.
Add kubedog repo to trdl:
trdl add kubedog https://tuf.kubedog.werf.io 1 2cc56abdc649a9699074097ba60206f1299e43b320d6170c40eab552dcb940d9e813a8abf5893ff391d71f0a84b39111ffa6403a3e038b81634a40d29674a531
To use kubedog on a workstation we recommend setting up kubedog automatic activation. For this the activation command should be executed for each new shell session. Often this is achieved by adding the activation command to ~/.bashrc (for Bash), ~/.zshrc (for Zsh) or to the one of the profile files, but this depends on the OS/shell/terminal. Refer to your shell/terminal manuals for more information.
This is the kubedog activation command for the current shell-session:
source "$(trdl use kubedog 0 stable)"
To use kubedog in CI prefer activating kubedog manually instead. For this execute the activation command in the beginning of your CI job, before calling the kubedog binary.
Windows (PowerShell)
Following instructions should be executed in PowerShell.
Install trdl to <disk>:\Users\<your username>\bin\trdl, which will manage kubedog installation and updates. Add <disk>:\Users\<your username>\bin\ to your $PATH environment variable.
Add kubedog repo to trdl:
trdl add kubedog https://tuf.kubedog.werf.io 1 2cc56abdc649a9699074097ba60206f1299e43b320d6170c40eab552dcb940d9e813a8abf5893ff391d71f0a84b39111ffa6403a3e038b81634a40d29674a531
To use kubedog on a workstation we recommend setting up kubedog automatic activation. For this the activation command should be executed for each new PowerShell session. For PowerShell this is usually achieved by adding the activation command to $PROFILE file.
This is the kubedog activation command for the current PowerShell-session:
. $(trdl use kubedog 0 stable)
To use kubedog in CI prefer activating kubedog manually instead. For this execute the activation command in the beginning of your CI job, before calling the kubedog binary.
Alternative binary installation
The recommended way to install kubedog is described above. Alternatively, although not recommended, you can download kubedog binary straight from the GitHub Releases page, optionally verifying the binary with the PGP signature.
Usage
Community
Please feel free to reach us via project's Discussions and werf's Telegram group (there's another one in Russian as well).
You're also welcome to follow @werf_io to stay informed about all important news, articles, etc.
License
Kubedog is an Open Source project licensed under the Apache License.
Documentation
Source Files
Directories