README
¶
🚀 D8 - Deckhouse CLI
Command-line client for Deckhouse Kubernetes Platform
📖 Overview
D8 (Deckhouse CLI) is a powerful command-line client for managing and interacting with the Deckhouse Kubernetes Platform. It provides essential tools for cluster operations, module management, backup/restore, and system administration.
Why D8?
- ✅ Cluster Management: Comprehensive cluster status and control
- 🚀 Module Operations: Mirror, backup, and manage Deckhouse modules
- 🔧 System Tools: Debug info collection and system diagnostics
- 🎯 CI/CD Ready: Perfect for automated deployment pipelines
- 📦 Multi-platform: Native binaries for Linux, macOS, and Windows
🎯 Features
🔍 Cluster Operations
D8 provides comprehensive cluster management capabilities:
| Command | Purpose | Key Features |
|---|---|---|
| backup | Backup operations | ETCD snapshots, configuration backups, data export |
| cr | Container registry tool | Pull/push images, list tags & repos, inspect manifests/configs, browse image filesystems |
| mirror | Module mirroring | Registry operations, image synchronization, air-gapped deployments |
| system | System diagnostics | Debug info collection, logs analysis, troubleshooting |
| user-operation | Local user operations | Request UserOperation in user-authn (ResetPassword/Reset2FA/Lock/Unlock) |
🚀 Module Management
Advanced tools for Deckhouse module lifecycle management:
- Mirror Operations: Copy modules to local registries or air-gapped environments
- Backup/Restore: Full cluster and module backup capabilities
- Data Export: Extract and export cluster data for migration or analysis
- Virtualization: Manage virtual machines in Kubernetes clusters
⚙️ System Administration
Essential tools for system administrators:
- Debug Collection: Automated system information gathering
- Log Analysis: Centralized logging and troubleshooting
- Platform Updates: Safe update management for Deckhouse installations
- Security Tools: Stronghold integration for secure operations
📦 Installation
Method 1: Install Script (Recommended)
Quick one-line installation for Linux and macOS:
sh -c "$(curl -fsSL https://raw.githubusercontent.com/deckhouse/deckhouse-cli/main/tools/install.sh)"
Alternative installation commands
Using wget:
sh -c "$(wget -qO- https://raw.githubusercontent.com/deckhouse/deckhouse-cli/main/tools/install.sh)"
Install specific version:
sh -c "$(curl -fsSL https://raw.githubusercontent.com/deckhouse/deckhouse-cli/main/tools/install.sh)" "" --version v1.0.0
Install to custom directory:
sh -c "$(curl -fsSL https://raw.githubusercontent.com/deckhouse/deckhouse-cli/main/tools/install.sh)" "" --install-dir ~/bin
See installation guide for more options.
Method 2: Download Binary
Download the latest release for your platform from the releases page.
Supported Platforms:
- Linux (amd64, arm64)
- macOS (amd64, arm64)
- Windows (amd64)
Method 3: Using trdl (Recommended for Updates)
trdl is a tool release delivery system that provides automatic updates and channel management:
URL=https://deckhouse.ru/downloads/deckhouse-cli-trdl
ROOT_VERSION=1
ROOT_SHA512=343bd5f0d8811254e5f0b6fe292372a7b7eda08d276ff255229200f84e58a8151ab2729df3515cb11372dc3899c70df172a4e54c8a596a73d67ae790466a0491
REPO=d8
trdl add $REPO $URL $ROOT_VERSION $ROOT_SHA512
Validate that the d8 binary is installed:
. $(trdl use d8 0 stable) && d8 --version
If you don't want to call . $(trdl use d8 0 stable) every time you need to use d8, consider adding alias d8='trdl exec d8 0 stable -- "$@"' to your shell RC file.
Method 4: Go Install
If you have Go installed:
go install github.com/deckhouse/deckhouse-cli@main
Note: Ensure
~/go/binis in your PATH after installation.
Verify Installation
d8 --version
🧰 User management (user-authn)
Manage Dex static users via UserOperation custom resources.
# Reset user's 2FA (TOTP)
d8 user reset2fa test-user --timeout 5m
# Lock user for 10 minutes
d8 user lock test-user 10m --timeout 5m
# Unlock user
d8 user unlock test-user --timeout 5m
# Reset password (bcrypt hash is required)
HASH="$(echo -n 'Test12345!' | htpasswd -BinC 10 \"\" | cut -d: -f2 | tr -d '\n')"
d8 user reset-password test-user "$HASH" --timeout 5m
🤝 Contributing
We welcome contributions! Here's how you can help:
- Report Bugs: Open an issue describing the problem
- Suggest Features: Share your ideas for improvements
- Submit PRs: Fix bugs or add features
- Improve Docs: Help make documentation better
Building from Source
You need to have access to private repositories for pulling dependencies.
Install Task with any suitable method:
go install github.com/go-task/task/v3/cmd/task@latest
To correctly access private repository run:
export PRIVATE_REPO=private.repo.com # replace with correct domain
git config --global url."ssh://git@${PRIVATE_REPO}/".insteadOf "https://flant.internal/"
export GOPRIVATE="flant.internal"
go mod tidy
To build for all platforms run:
task build:dist:all
For any specific platform:
task build:dist:linux:amd64
task build:dist:darwin:amd64
task build:dist:darwin:arm64
task build:dist:windows:amd64
🔗 Links
- Website: deckhouse.io
- Issues: Report a bug or request a feature
- Releases: Download binaries
- Documentation: Deckhouse Documentation
🌟 Support
If you find D8 helpful, please consider:
- ⭐ Starring the repository
- 🐛 Reporting bugs
- 💡 Suggesting features
- 📖 Contributing to documentation
- 🔀 Submitting pull requests
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
d8
command
|
|
|
cr/cmd
Package cr wires the `d8 cr` subtree.
|
Package cr wires the `d8 cr` subtree. |
|
cr/cmd/completion
Package completion provides shell-completion helpers for the `d8 cr` subtree.
|
Package completion provides shell-completion helpers for the `d8 cr` subtree. |
|
cr/cmd/fs
Package fs implements the `d8 cr fs` subtree - filesystem inspection of container images.
|
Package fs implements the `d8 cr fs` subtree - filesystem inspection of container images. |
|
cr/cmd/rootflagnames
Package rootflagnames holds the persistent-flag names of the `d8 cr` root command in one place.
|
Package rootflagnames holds the persistent-flag names of the `d8 cr` root command in one place. |
|
cr/internal/image
Package image holds pure operations over v1.Image / v1.ImageIndex values that stand on their own (multi-arch resolution, future diff helpers, ...).
|
Package image holds pure operations over v1.Image / v1.ImageIndex values that stand on their own (multi-arch resolution, future diff helpers, ...). |
|
cr/internal/imagefs
Package imagefs reads the filesystem of an OCI/Docker image as the merged view that a running container would see, and extracts it to disk with path-traversal and absolute-symlink-rewrite protection.
|
Package imagefs reads the filesystem of an OCI/Docker image as the merged view that a running container would see, and extracts it to disk with path-traversal and absolute-symlink-rewrite protection. |
|
cr/internal/imageio
Package imageio bridges v1.Image / v1.ImageIndex and the local filesystem: loading and saving tarballs (docker format) and OCI image layouts.
|
Package imageio bridges v1.Image / v1.ImageIndex and the local filesystem: loading and saving tarballs (docker format) and OCI image layouts. |
|
cr/internal/output
Package output renders imagefs data for `d8 cr fs` subcommands as human-readable text.
|
Package output renders imagefs data for `d8 cr fs` subcommands as human-readable text. |
|
cr/internal/registry
Package registry is the thin domain layer of `d8 cr` on top of go-containerregistry/pkg/v1/*.
|
Package registry is the thin domain layer of `d8 cr` on top of go-containerregistry/pkg/v1/*. |
|
iam/listget/cmd
Package listget hosts the top-level read-only commands `d8 iam get` and `d8 iam list`.
|
Package listget hosts the top-level read-only commands `d8 iam get` and `d8 iam list`. |
|
iam/types
Package types holds the constants and GVRs shared across the iam subpackages (access, group, user).
|
Package types holds the constants and GVRs shared across the iam subpackages (access, group, user). |
|
mirror/cmd/pull/errdetect
Package errdetect classifies registry errors for d8 mirror pull with pull-specific causes and solutions.
|
Package errdetect classifies registry errors for d8 mirror pull with pull-specific causes and solutions. |
|
mirror/cmd/push/errdetect
Package errdetect classifies registry errors for d8 mirror push with push-specific causes and solutions.
|
Package errdetect classifies registry errors for d8 mirror push with push-specific causes and solutions. |
|
mirror/errmatch
Package errmatch provides error matchers for container registry responses.
|
Package errmatch provides error matchers for container registry responses. |
|
mirror/pack
Package pack contains the atomic-write helper shared by every component that emits a tar artifact into the user's bundle directory (platform, installer, security, per-module).
|
Package pack contains the atomic-write helper shared by every component that emits a tar artifact into the user's bundle directory (platform, installer, security, per-module). |
|
plugins/cmd
Package plugins implements the d8-cli plugin system.
|
Package plugins implements the d8-cli plugin system. |
|
plugins/cmd/flags
Package flags defines the shared CLI flag set used by the d8 plugins management subcommands and consumed during registry client initialisation.
|
Package flags defines the shared CLI flag set used by the d8 plugins management subcommands and consumed during registry client initialisation. |
|
plugins/cmd/layout
Package layout centralizes the on-disk filesystem layout used by the d8 plugins subsystem: directory names, suffixes, and helpers that build concrete paths from the install root.
|
Package layout centralizes the on-disk filesystem layout used by the d8 plugins subsystem: directory names, suffixes, and helpers that build concrete paths from the install root. |
|
diagnostic
Package diagnostic provides HelpfulError - a wrapper around standard Go errors that adds possible causes and actionable solutions for the user.
|
Package diagnostic provides HelpfulError - a wrapper around standard Go errors that adds possible causes and actionable solutions for the user. |
|
testing
|
|
Click to show internal directories.
Click to hide internal directories.