miniDevOps is a Docker image designed to provide a comprehensive set of DevOps tools and utilities, all within a Debian Linux environment.
- miniDevOps: A DevOps Toolkit Operated within Docker
- kubectl (aliased with
kubecolor) - k9s
- kube-shell
- helm
- terraform
- flux
- operator-sdk
- kind
- docker compose v2
- krew (kubectl's plugin manager)
- kubens
- kubectx
- stern
- skaffold
- kubeseal
- kubelogin
- lazydocker
- usql
- popeye
- bash (with completion functionality)
- nano (featuring syntax highlighting)
- vim
- git
- gcc
- go
- python3
- pip3
- make
- zip
- lynx
- curl
- wget
- jq
- ncurses
- apache2-ssl, accompanied by apache2-utils
miniDevOps includes Python and Pipenv, making it a convenient environment for Python development. Whether you're creating scripts to manage your infrastructure or developing full-fledged applications, this Docker image is equipped to handle your Python needs.
-
Python: The image includes Python 3, allowing you to run and develop Python applications.
-
Pipenv: It automatically creates and manages a virtual environment for your projects, as well as adds/removes packages from your Pipfile as you install/uninstall packages. It also generates the Pipfile.lock, which is used to produce deterministic builds.
Example usage:
pipenv install requests
pipenv run python my_script.pyThe config.yml file contains a suggested Kind cluster configuration. Feel free to modify it according to your specific needs.
To run the miniDevOps Docker image, execute the following command:
docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -v $PWD:/workspace --network=host --workdir /home/minidevops brakmic/devops:latestThe /var/run/docker.sock volume binding allows for communication with the host's Docker instance.
Once inside the container's shell, establish a new cluster using the command:
kind create cluster --name my-cluster
With this setup, you can now establish a new cluster and then copy the updated .kube/config into /home/minidevops/local. This directory will persist its content, even after a Docker shutdown.
Additionally, a shell script titled create_cluster.sh is available. This script sets up the cluster and deploys the NGINX IngressController.
Execute it with:
./create_cluster.sh my-cluster
If you are running Docker on Windows, an alternative PowerShell script is available. This script provides a similar functionality as the bash script for setting up the cluster and deploying the NGINX IngressController. You can run this script in PowerShell with:
.\create_cluster.ps1 -CLUSTERNAME MyClusterNamePlease ensure that both kind and kubectl command-line tools are installed and available in your PATH when you run this PowerShell script.
To retain your cluster between sessions, copy the current .kube/config to a local volume. Upon your next miniDevOps launch, replace the default .kube/config with the one you saved. Here's an example:
docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -v ${PWD}:/home/minidevops/local --network=host --workdir /home/minidevops brakmic/devops:latestThis setup allows you to create a new cluster and then copy the updated .kube/config to /home/minidevops/local. The contents of this directory will be preserved, even after the Docker system is shut down.
The Docker image for miniDevOps is available at: Docker Hub
The following guides provide detailed instructions on how to use some of the included DevOps tools in the miniDevOps Docker image:
-
kubeseal: Learn how to seal a secret in Kubernetes.
-
skaffold: Understand the automated workflow for building, pushing, and deploying applications with Skaffold.
-
stern: Get to know how to stream logs from multiple pods in real-time.
-
nginx-ingress: Learn how to install and configure the NGINX Ingress Controller v1.22.2 on your Kubernetes cluster.
Check the status of all the nodes within namespace dev in your Kubernetes cluster:
kubectl get nodes -n devLearn more with the Kubernetes Official Documentation
Install a package on your Kubernetes cluster. In this example, we are installing the stable release of Prometheus:
helm install prometheus stable/prometheusGet started with the Helm Official Documentation
Initialize a new Terraform working directory and apply the configurations:
terraform init
terraform applyExplore more with the Terraform Learn
Operator SDK is a toolkit to accelerate building Kubernetes native applications. With the Operator SDK, developers can build, test, and deploy Operators - applications that can manage and automate complex systems within a Kubernetes cluster. The SDK provides high-level APIs, useful abstractions, and project scaffolding that facilitates the fast development of Operators, without requiring deep Kubernetes API knowledge. The Operator SDK supports various operator types including Helm, Ansible, and Go, allowing developers to choose the best tool for their use case.
Example usage:
# Create a new operator project
operator-sdk init --domain=example.com --repo=github.com/example-inc/memcached-operator
# Create a new API for the custom resource
operator-sdk create api --group cache --version v1alpha1 --kind Memcached --resource --controller
# Build and push the operator image
make docker-build docker-push IMG=<some-registry>/memcached-operator:v0.0.1
# Deploy the operator to a cluster
make install
make deploy IMG=<some-registry>/memcached-operator:v0.0.1This sets up the basic scaffolding for your operator project, creates the necessary CRDs (Custom Resource Definitions), and allows you to push your operator to a container registry and deploy it to a Kubernetes cluster. From here, you can define your operator's logic and specify how it should manage the application's lifecycle.
Flux is a toolset for keeping Kubernetes clusters in sync with infrastructure-as-code systems, like Git repositories, and automating updates to configuration and images. It uses a pull-based approach to continuously deploy and monitor applications. With Flux, you can ensure that your cluster's state matches the versioned sources, allowing for GitOps practices in your workflow.
Flux supports multi-tenancy and scales to multiple clusters, ensuring declarative infrastructure for both small-scale applications and large-scale operations. It comes with powerful features like automatic updates, policy-driven deployments, and integrations with prominent Kubernetes-native tools.
Example usage:
# Bootstrap Flux on your cluster
flux bootstrap github \
--owner=<your-user> \
--repository=<your-repository> \
--branch=main \
--path=./clusters/your-cluster \
--personal
# Check components status
flux check
# Sync your cluster state with the Git repository
flux reconcile source git flux-systemWith these commands, you've set up Flux to manage your Kubernetes cluster according to the infrastructure-as-code definitions in your Git repository. Flux will now automatically ensure that your cluster's state matches the configurations in the Git repository, and any change to the repository will be promptly applied to the cluster.
Dive deeper with the Flux Official Documentation.
Start all services defined in a docker-compose.yml file in detached mode:
docker compose up -dRead more in the Docker Compose Documentation
Create a Kubernetes cluster with a specific name:
kind create cluster --name my-clusterLearn how to get started with the kind GitHub Quick Start Guide
A simple terminal UI for both docker and docker-compose, to quickly manage projects with containers:
lazydockerCheck out the lazydocker GitHub Repository for more information.
Popeye is a utility that scans your Kubernetes clusters for potential issues and misconfigurations. It helps identify resource issues, validates configurations against best practices, and suggests improvements to enhance your cluster's security, efficiency, and reliability. Popeye can detect issues like unused resources, security vulnerabilities, and configuration problems before they cause production issues.
# Scan your Kubernetes cluster and report issues
popeye
# Scan with a specific output format (yaml, json, html, junit, etc.)
popeye -o yaml
# Scan a specific namespace
popeye -n kube-systemSeal a Kubernetes secret using a public certificate:
kubeseal --cert=publicCert.pem --format=yaml < secret.yaml > sealedsecret.yamlRead the kubeseal GitHub Usage Guide to learn more.
Stream logs from multiple pods in real-time. For example, to stream logs from all pods with the label app=myapp in the dev namespace:
stern -n dev app=myappLearn more about Stern with its GitHub Repository
Automate the workflow for building, pushing, and deploying applications in a Kubernetes environment. Here's how to start a development cycle on your local cluster:
skaffold devGet started with Skaffold Documentation
Authenticate to a Kubernetes cluster using an OpenID Connect identity provider. For example:
kubelogin convert-kubeconfig -l azureLearn more from kubelogin GitHub Repository
Krew is a plugin manager for kubectl. Use it to install and manage kubectl plugins. For example, to list all available plugins:
kubectl krew searchExplore krew GitHub Repository to learn more.
Switch between Kubernetes namespaces smoothly. For example, to switch to the dev namespace:
kubens devCheck out kubens GitHub Repository for more information.
Switch between Kubernetes contexts (clusters). For example, to switch to a context named my-cluster:
kubectx my-clusterLearn more from the kubectx GitHub Repository
uSQL is a modern query language and execution engine that facilitates data querying across different platforms and data sources. It provides a unified SQL interface for various databases and file formats. uSQL supports a wide range of databases and file formats including MySQL, PostgreSQL, SQLite, CSV, Excel, and more.
You can execute queries using the uSQL command-line interface:
usql "SELECT * FROM file.csv WHERE column > 10"For more detailed information, visit the official documentation.