...

Text file src/k8s.io/kubernetes/README.md

Documentation: k8s.io/kubernetes

     1# Kubernetes (K8s)
     2
     3[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/569/badge)](https://bestpractices.coreinfrastructure.org/projects/569) [![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/kubernetes)](https://goreportcard.com/report/github.com/kubernetes/kubernetes) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kubernetes/kubernetes?sort=semver)
     4
     5<img src="https://github.com/kubernetes/kubernetes/raw/master/logo/logo.png" width="100">
     6
     7----
     8
     9Kubernetes, also known as K8s, is an open source system for managing [containerized applications]
    10across multiple hosts. It provides basic mechanisms for the deployment, maintenance,
    11and scaling of applications.
    12
    13Kubernetes builds upon a decade and a half of experience at Google running
    14production workloads at scale using a system called [Borg],
    15combined with best-of-breed ideas and practices from the community.
    16
    17Kubernetes is hosted by the Cloud Native Computing Foundation ([CNCF]).
    18If your company wants to help shape the evolution of
    19technologies that are container-packaged, dynamically scheduled,
    20and microservices-oriented, consider joining the CNCF.
    21For details about who's involved and how Kubernetes plays a role,
    22read the CNCF [announcement].
    23
    24----
    25
    26## To start using K8s
    27
    28See our documentation on [kubernetes.io].
    29
    30Take a free course on [Scalable Microservices with Kubernetes].
    31
    32To use Kubernetes code as a library in other applications, see the [list of published components](https://git.k8s.io/kubernetes/staging/README.md).
    33Use of the `k8s.io/kubernetes` module or `k8s.io/kubernetes/...` packages as libraries is not supported.
    34
    35## To start developing K8s
    36
    37The [community repository] hosts all information about
    38building Kubernetes from source, how to contribute code
    39and documentation, who to contact about what, etc.
    40
    41If you want to build Kubernetes right away there are two options:
    42
    43##### You have a working [Go environment].
    44
    45```
    46git clone https://github.com/kubernetes/kubernetes
    47cd kubernetes
    48make
    49```
    50
    51##### You have a working [Docker environment].
    52
    53```
    54git clone https://github.com/kubernetes/kubernetes
    55cd kubernetes
    56make quick-release
    57```
    58
    59For the full story, head over to the [developer's documentation].
    60
    61## Support
    62
    63If you need support, start with the [troubleshooting guide],
    64and work your way through the process that we've outlined.
    65
    66That said, if you have questions, reach out to us
    67[one way or another][communication].
    68
    69[announcement]: https://cncf.io/news/announcement/2015/07/new-cloud-native-computing-foundation-drive-alignment-among-container
    70[Borg]: https://research.google.com/pubs/pub43438.html
    71[CNCF]: https://www.cncf.io/about
    72[communication]: https://git.k8s.io/community/communication
    73[community repository]: https://git.k8s.io/community
    74[containerized applications]: https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/
    75[developer's documentation]: https://git.k8s.io/community/contributors/devel#readme
    76[Docker environment]: https://docs.docker.com/engine
    77[Go environment]: https://go.dev/doc/install
    78[kubernetes.io]: https://kubernetes.io
    79[Scalable Microservices with Kubernetes]: https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615
    80[troubleshooting guide]: https://kubernetes.io/docs/tasks/debug/
    81
    82## Community Meetings 
    83
    84The [Calendar](https://www.kubernetes.dev/resources/calendar/) has the list of all the meetings in the Kubernetes community in a single location.
    85
    86## Adopters
    87
    88The [User Case Studies](https://kubernetes.io/case-studies/) website has real-world use cases of organizations across industries that are deploying/migrating to Kubernetes.
    89
    90## Governance 
    91
    92Kubernetes project is governed by a framework of principles, values, policies and processes to help our community and constituents towards our shared goals.
    93
    94The [Kubernetes Community](https://github.com/kubernetes/community/blob/master/governance.md) is the launching point for learning about how we organize ourselves.
    95
    96The [Kubernetes Steering community repo](https://github.com/kubernetes/steering) is used by the Kubernetes Steering Committee, which oversees governance of the Kubernetes project.
    97
    98## Roadmap 
    99
   100The [Kubernetes Enhancements repo](https://github.com/kubernetes/enhancements) provides information about Kubernetes releases, as well as feature tracking and backlogs.

View as plain text