Skip to content

Installation

This document provides detailed instructions for installing K8s Tools, including system requirements, installation steps, and initial setup guidelines.

System Requirements

  • Operating System: Windows, macOS, or Linux
  • Python Version: >= 3.10
  • Kubernetes Cluster: Version >= 1.21 (for Kubernetes resources)
  • Access: Ability to access the Kubernetes API server

Installation Options

Using pipx

We recommend using pipx for isolated installations. If pipx is not installed, you can install it first:

python3 -m pip install --user pipx
python3 -m pipx ensurepath

To install K8s Tools using pipx:

pipx install k8s-tools

Using pip

Alternatively, you can install K8s Tools directly with pip:

pip install k8s-tools

From Source

To install from source, clone the repository and install using pip:

git clone https://github.com/k8s-tools/k8s-tools.git
cd k8s-tools
pip install .

Using Docker

K8s Tools can also be run in a Docker container:

# Pull Docker image
docker pull k8stools/k8s-tools

# Run container
docker run -it --rm -v ~/.kube:/home/user/.kube k8stools/k8s-tools analyze

Setup and Configuration

Kubernetes Configuration

Ensure that your kubeconfig is set up correctly:

  • By default, K8s Tools uses the kubeconfig located at ~/.kube/config
  • You can specify a different kubeconfig path with the --kubeconfig option:
k8s-tools analyze --kubeconfig /path/to/config

Environment Variables

You may set environment variables to customize behavior:

  • K8S_TOOLS_CONFIG - Path to the configuration file
  • KUBECONFIG - Override kubeconfig location

Pre-Commit Hooks

Set up pre-commit hooks for development:

pre-commit install

Initial Testing

Run initial tests to verify installation:

# Run unit tests
pytest
test/test_initialization.py

# Check version
k8s-tools --version

Troubleshooting

Common Issues

  • Dependency Resolution: Conflicts with existing packages

  • Use pip check to identify conflicts

  • Kubeconfig Errors: Issues with Kubernetes configuration

  • Ensure the correct context is set in kubeconfig

Getting Help

  • Documentation: Refer to detailed usage guides and examples
  • Community Support: Reach out via GitHub issues or discussions

Uninstallation

To remove K8s Tools:

pipx uninstall k8s-tools
# or if installed with pip
pip uninstall k8s-tools

0citations1 0document1 0document_type1RULE0/document_type1 0document_id1mHRxidOov0WLb90jeiS2uG0/document_id1 0/document1 0document1 0document_type1RULE0/document_type1 0document_id1FtUk1rgWdKE6veAClNpAqC0/document_id1 0/document1 0/citations1