Getting Started

    Make sure to read you read the Kubernetes community guidelines. In specific, read through the .

    Additionally, note that kind is developed on GitHub and will require an account to contribute.

    Our source code is managed with , to develop locally you will need to install git.

    You can check if is already on your system and properly installed with the following command:

    If you wish to contribute to the documentation, it is recommended but not required to install hugo, which we use to develop this site.

    Please see:

    Install or upgrade Go using the instructions for your operating system. You can check if Go is in your system with the following command:

    Preferably Go 1.13 or greater should be installed.

    Correct automatic formatting of the source with requires at least 1.11.0.

    Working with Go (which we use for dependency management) requires at least due to checksum bugs in lower versions.

    Currently, to create clusters you will need to install Docker.

    If you haven’t already, , following the official instructions. If you have an existing installation, check your version and make sure you have the latest Docker.

    This documentation is written using Docker version 18.09.2.

    The , 1.0 roadmap, , and initial design may be helpful to review before contributing.

    Issues are tracked on GitHub. Please check to see if there is any existing discussion or work related to your interests.

    If you do not see anything, please file a new issue.

    Please reach out for bugs, feature requests, and other issues!
    The maintainers of this project are reachable via:

    Current maintainers are and @munnerz - feel free to reach out if you have any questions!