kvaps/kubectl-node-shell
Kubectl Node Shell
This project is a command-line plugin for Kubernetes that provides direct root shell access to the underlying host operating system of a cluster node. It is designed to facilitate administrative tasks, system maintenance, and diagnostic operations on nodes, including those running immutable or container-optimized operating systems that lack native shell environments.
The tool functions by dynamically scheduling ephemeral, privileged pods that share the host's process, network, and filesystem namespaces. By leveraging node affinity constraints, it ensures that these diagnostic sessions are executed on the specific target host, allowing users to interact with the node's root directory and system processes as if they were logged in locally.
Beyond interactive shell sessions, the utility supports remote command execution for automating configuration changes or retrieving diagnostic data across the cluster. It also provides capabilities for attaching persistent storage volumes to these temporary environments, enabling data recovery and the transfer of information between local node devices and external storage systems.
Features
- Kubernetes Node Debugging - Provides direct host-level access to troubleshoot hardware and system issues on Kubernetes nodes.
- Device Shell Access - Grants root-level shell access to the host operating system of a Kubernetes node for administrative and diagnostic tasks.
- Cluster Administration - Facilitates cluster-wide administration by allowing remote command execution across node host environments.
- Node Affinity Rules - Uses node affinity rules to ensure diagnostic pods are scheduled on the specific target host requiring maintenance.
- Workload Scheduling - Schedules ephemeral diagnostic pods onto specific cluster nodes to facilitate system-level maintenance tasks.
- Infrastructure Debugging Utilities - Enables inspection and repair of immutable or container-optimized operating systems by launching temporary diagnostic environments.
- Kubernetes Cluster Management - Acts as a maintenance utility for managing node infrastructure and executing administrative tasks within a cluster.
- Root Filesystem Mounting - Mounts the host root filesystem into a container to enable direct inspection and modification of system files.
- Remote Command Execution - Executes remote commands and scripts on host nodes to automate configuration changes and retrieve diagnostic data.
- Namespace-Based Resource Sharings - Joins host process and network namespaces to allow diagnostic tools to interact directly with the underlying node environment.
- Ephemeral Sidecar Injections - Injects privileged ephemeral sidecar containers into the node environment to bypass OS limitations for diagnostic access.
- Troubleshooting Utilities - Offers diagnostic capabilities for inspecting and repairing nodes that lack native shell environments.
