Metadata-Version: 2.1
Name: kindtool
Version: 0.0.4
Summary: Generator for kind k8s clusters
Home-page: https://github.com/egandro/kindtool
Author: Harald Fielker
Author-email: harald.fielker@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/egandro/kindtool/issues
Project-URL: Source, https://github.com/egandro/kindtool/
Description: # kindtool
        
        Python program for simplyfing workflows with kind.
        
        [kind](https://kind.sigs.k8s.io/) is a tool for running local Kubernetes clusters using Docker container “nodes”.
        
        With [kindtool](https://github.com/egandro/kindtool/) you can add a simple `Kindfile` to your project. You can crate, destroy, start and maintain a `k8s` cluster for ci or development.
        
        
        ## Installation
        
        Requirements:
        
        - docker
        - python3
        - kind
        - kubectl
        - optional: helm
        
        ### Kind installation
        
        Official documentation: <https://kind.sigs.k8s.io/docs/user/quick-start/>
        
        Fast lane:
        
        
        ```
        get_latest_release() {
          curl --silent "https://api.github.com/repos/$1/releases/latest" | # Get latest release from GitHub api
            grep '"tag_name":' |                                            # Get tag line
            sed -E 's/.*"([^"]+)".*/\1/'                                    # Pluck JSON value
        }
        KIND_LATEST=$(get_latest_release kubernetes-sigs/kind)
        ARCH=$(dpkg --print-architecture 2>/dev/null || echo "amd64")
        
        curl -Lo ./kind https://kind.sigs.k8s.io/dl/${KIND_LATEST}/kind-linux-${ARCH}
        chmod +x ./kind
        sudo mv ./kind /usr/local/bin/kind
        ```
        
        ### Kindtool installation
        
        ```
        $ pip3 install kindtool
        ```
        
        ### Kubectl installation
        
        - Linux: https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/
        - Windows: https://kubernetes.io/docs/tasks/tools/install-kubectl-windows/
        
        ### Helm installation
        
        - https://helm.sh/docs/intro/install/
        
        ## Workflow
        
        ```
        # creates a new Kindfile (edit for your needs)
        $ kindtool init -d <projectdir>
        
        # creates the cluster - this will create a .kind directory next to Kindfile
        $ kindtool up
        
        # kills the kind cluster - configuration, k8s config is removed,
        # the persistent data will be kept in .kind/data
        $ kindtool destroy
        
        # kills the kind cluster  and removes the data folder
        # this needs to be run as root! Docker might created files that have 0/0 uids/gids
        $ sudo kindtool destroy -f
        
        # is kind running - print status information
        $ kindtool status
        
        # start the k8s dashboard
        $ kindtool dashboard
        
        # returns the directory with the config files
        # can be used as export KUBECONFIG=$(kindfile get kubeconfig)
        $ kindtool get kubeconfig
        ```
        
        
        ## Examples
        
        https://github.com/egandro/kindtool-examples
        
Keywords: kind,k8s,generator,development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.7, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
