## 1. Project Overview & Quickstart (kubernetes/minikube) # minikube [](https://github.com/kubernetes/minikube/actions) [![GoReport Widget]][GoReport Status] [](https://github.com/kubernetes/minikube/releases/latest) [](https://github.com/kubernetes/minikube/releases/latest) [](https://codespaces.new/kubernetes/minikube?quickstart=1) [GoReport Status]: https://goreportcard.com/report/github.com/kubernetes/minikube [GoReport Widget]: https://goreportcard.com/badge/github.com/kubernetes/minikube minikube implements a local Kubernetes cluster on macOS, Linux, and Windows. minikube's [primary goals](https://minikube.sigs.k8s.io/docs/concepts/principles/) are to be the best tool for local Kubernetes application development and to support all Kubernetes features that fit. ## Features minikube runs the latest stable release of Kubernetes, with support for standard Kubernetes features like: * [LoadBalancer](https://minikube.sigs.k8s.io/docs/handbook/accessing/#loadbalancer-access) - using `minikube tunnel` * Multi-cluster - using `minikube start -p ` * [NodePorts](https://minikube.sigs.k8s.io/docs/handbook/accessing/#nodeport-access) - using `minikube service` * [Persistent Volumes](https://minikube.sigs.k8s.io/docs/handbook/persistent_volumes/) * [Dashboard](https://minikube.sigs.k8s.io/docs/handbook/dashboard/) - `minikube dashboard` * [Container runtimes](https://minikube.sigs.k8s.io/docs/handbook/config/#runtime-configuration) - `minikube start --container-runtime` * [Configure apiserver and kubelet options](https://minikube.sigs.k8s.io/docs/handbook/config/#modifying-kubernetes-defaults) via command-line flags * Supports common [CI environments](https://github.com/minikube-ci/examples) As well as developer-friendly features: * [Addons](https://minikube.sigs.k8s.io/docs/handbook/deploying/#addons) - a marketplace for developers to share configurations for running services on minikube * [NVIDIA GPU support](https://minikube.sigs.k8s.io/docs/tutorials/nvidia/) - for machine learning * [AMD GPU support](https://minikube.sigs.k8s.io/docs/tutorials/amd/) - for machine learning * [Filesystem mounts](https://minikube.sigs.k8s.io/docs/handbook/mount/) **For more information, see the official [minikube website](https://minikube.sigs.k8s.io)** ## Installation See the [Getting Started Guide](https://minikube.sigs.k8s.io/docs/start/) :mega: **Please fill out our [fast 5-question survey](https://forms.gle/Gg3hG5ZySw8c1C24A)** so that we can learn how & why you use minikube, and what improvements we should make. Thank you! :dancers: ## GitHub Codespace You can run minikube in a GitHub Codespace by clicking here: [](https://codespaces.new/kubernetes/minikube?quickstart=1) This will launch a Github Codespace. You can then run `minikube start` and `minikube dashboard` - You can then open Minikube Dashboard by clicking opening the link displayed in the terminal. You can also run Minikube in a Dev Container locally using your favorite IDE, for more information see Dev Containers ## Documentation See ## More Examples See minikube in action in the [controls handbook](https://minikube.sigs.k8s.io/docs/handbook/controls/) ## Governance Kubernetes project is governed by a framework of principles, values, policies and processes to help our community and constituents towards our shared goals. The [Kubernetes Community](https://github.com/kubernetes/community/blob/master/governance.md) is the launching point for learning about how we organize ourselves. The [Kubernetes Steering community repo](https://github.com/kubernetes/steering) is used by the Kubernetes Steering Committee, which oversees governance of the Kubernetes project. ## Community minikube is a Kubernetes [#sig-cluster-lifecycle](https://github.com/kubernetes/community/tree/master/sig-cluster-lifecycle) project. * [**#minikube on Kubernetes Slack**](https://kubernetes.slack.com/messages/minikube) - Live chat with minikube developers! * [minikube-users mailing list](https://groups.google.com/g/minikube-users) * [minikube-dev mailing list](https://groups.google.com/g/minikube-dev) * [Contributing](https://minikube.sigs.k8s.io/docs/contrib/) * [Development Roadmap](https://minikube.sigs.k8s.io/docs/contrib/roadmap/) Join our community meetings: * [Bi-weekly office hours, Mondays @ 11am PST](https://tinyurl.com/minikube-oh) * [Triage Party](https://minikube.sigs.k8s.io/docs/contrib/triage/) ## 2. Official Technical Reference & Guides (kubernetes/kubernetes.github.io) # The Kubernetes documentation [](https://app.netlify.com/sites/kubernetes-io-main-staging/deploys) [](https://github.com/kubernetes/website/releases/latest) This repository contains the assets required to build the [Kubernetes website and documentation](https://kubernetes.io/). We're glad that you want to contribute! - [Contributing to the docs](#contributing-to-the-docs) - [Localization READMEs](#localization-readmes) ## Using this repository You can run the website locally using [Hugo (Extended version)](https://gohugo.io/), or you can run it in a container runtime. We strongly recommend using the container runtime, as it gives deployment consistency with the live website. ## Prerequisites To use this repository, you need the following installed locally: - [npm](https://www.npmjs.com/) - [Go](https://go.dev/) - [Hugo (Extended version)](https://gohugo.io/) - A container runtime, like [Docker](https://www.docker.com/). > [!NOTE] Make sure to install the Hugo extended version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L11) file. Before you start, install the dependencies. Clone the repository and navigate to the directory: ```bash git clone https://github.com/kubernetes/website.git cd website ``` The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme), which can be installed via npm. You can also download a pre-configured development container image that includes Hugo and Docsy. Additionally, a Git submodule is used for tools that generate the reference documentation. ### Windows ```powershell # fetch submodule dependencies git submodule update --init --recursive --depth 1 ``` ### Linux / other Unix ```bash # fetch submodule dependencies make module-init ``` ## Running the website using a container To build the site in a container, run the following: ```bash # You can set $CONTAINER_ENGINE to the name of any Docker-like container tool # Render the full website make container-serve # Render only a specific language segment (e.g., English) make container-serve segments=en # Render multiple languages (e.g., English and Korean) make container-serve segments=en,ko ``` **💡 Tip:** Using _Hugo segments_ speeds up local preview builds, by rendering only selected language(s). If you see errors, it probably means that the Hugo container did not have enough computing resources available. To solve it, increase the amount of allowed CPU and memory usage for Docker on your machine ([macOS](https://docs.docker.com/desktop/settings/mac/) and [Windows](https://docs.docker.com/desktop/settings/windows/)). Open up your browser to to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh. ## Running the website locally using Hugo To install dependencies, deploy and test the site locally, run: - For macOS and Linux ```bash npm ci # Render the full site (default) make serve # Render only a specific language segment make serve segments=en # Render multiple language segments make serve segments=en,ko ``` **💡 Tip:** Hugo segments are defined in `hugo.toml` and allow faster rendering by limiting the scope to specific language(s). - For Windows (PowerShell) ```powershell npm ci hugo.exe server --config hugo.toml,hugo.server.toml --buildFuture --environment development ``` This will start the local Hugo server on port 1313. Open up your browser to to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh. ## Building the API reference pages The API reference pages located in `content/en/docs/reference/kubernetes-api` are built from the Swagger specification, also known as OpenAPI specification, using . To update the reference pages for a new Kubernetes release follow these steps: 1. Pull in the `api-ref-generator` submodule: ```bash git submodule update --init --recursive --depth 1 ``` 2. Update the Swagger specification: ```bash curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json ``` 3. In `api-ref-assets/config/`, adapt the files `toc.yaml` and `fields.yaml` to reflect the changes of the new release. 4. Next, build the pages: ```bash make api-reference ``` You can test the results locally by building and serving the site from a container: ```bash make container-serve ``` In a web browser, go to to view the API reference. 5. When all changes of the new contract are reflected into the configuration files `toc.yaml` and `fields.yaml`, create a Pull Request with the newly generated API reference pages. ## Troubleshooting If you experience any issues with running website locally, please refer to the [Troubleshooting section](https://kubernetes.io/docs/contribute/new-content/preview-locally/#troubleshooting) of the contributing documentation. ## Get involved with SIG Docs Learn more about SIG Docs Kubernetes community and meetings on the [community page](https://github.com/kubernetes/community/tree/main/sig-docs#meetings). You can also reach the maintainers of this project at: - [Slack](https://kubernetes.slack.com/messages/sig-docs) - [Get an invite for this Slack](https://slack.k8s.io/) - [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) ## Contributing to the docs You can click the **Fork** button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a _fork_. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it. Once your pull request is created, a Kubernetes reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, **it is your responsibility to modify your pull request to address the feedback that has been provided to you by the Kubernetes reviewer.** Also, note that you may end up having more than one Kubernetes reviewer provide you feedback or you may end up getting feedback from a Kubernetes reviewer that is different than the one initially assigned to provide you feedback. Furthermore, in some cases, one of your reviewers might ask for a technical review from a Kubernetes tech reviewer when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances. For more information about contributing to the Kubernetes documentation, see: - [Contribute to Kubernetes docs](https://kubernetes.io/docs/contribute/) - [Page Content Types](https://kubernetes.io/docs/contribute/style/page-content-types/) - [Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/) - [Localizing Kubernetes Documentation](https://kubernetes.io/docs/contribute/localization/) - [Introduction to Kubernetes Docs](https://www.youtube.com/watch?v=pprMgmNzDcw) ### New contributor ambassadors If you need help at any point when contributing, the [New Contributor Ambassadors](https://kubernetes.io/docs/contribute/advanced/#serve-as-a-new-contributor-ambassador) are a good point of contact. These are SIG Docs approvers whose responsibilities include mentoring new contributors and helping them through their first few pull requests. The best place to contact the New Contributors Ambassadors would be on the [Kubernetes Slack](https://slack.k8s.io/). Current New Contributors Ambassadors for SIG Docs: | Name | Slack | GitHub | | -------------------------- | -------------------------- | -------------------------- | | Sreeram Venkitesh | @sreeram.venkitesh | @sreeram-venkitesh | ## Localization READMEs | Language | Language | | -------------------------- | -------------------------- | | [Bengali](./content/bn/README.md) | [Korean](./content/ko/README.md) | | [Chinese](./content/zh-cn/README.md) | [Polish](./content/pl/README.md) | | [French](./content/fr/README.md) | [Portuguese](./content/pt-br/README.md) | | [German](./content/de/README.md) | [Russian](./content/ru/README.md) | | [Hindi](./content/hi/README.md) | [Spanish](./content/es/README.md) | | [Indonesian](./content/id/README.md) | [Ukrainian](./content/uk/README.md) | | [Italian](./content/it/README.md) | [Vietnamese](./content/vi/README.md) | | [Japanese](./content/ja/README.md) | | ## Code of conduct Participation in the Kubernetes community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). ## Thank you Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation!