upstream/kubernetes
1
0
Fork 0
mirror of https://github.com/kubernetes/kubernetes.git synced 2026-03-19 17:12:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
kubernetes/README.md

87 lines
3.3 KiB
Markdown
Raw Normal View History

Use K8s in the README Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-11-12 14:23:23 -05:00
# Kubernetes (K8s)
First commit
2014-06-06 19:40:48 -04:00
Update godoc reference widget to pkg.go.dev godoc.org has been replaced with pgk.go.dev. A redirect exists for now, but will eventually be turned off. For more information see the go blog post on this migration: https://blog.golang.org/pkg.go.dev-2020
2021-01-26 09:34:07 -05:00
[![GoPkg Widget]][GoPkg] [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/569/badge)](https://bestpractices.coreinfrastructure.org/projects/569)
Add aliases for links and link widgets
2015-09-15 07:39:05 -04:00
improve readme for contributor experience
2016-11-15 09:02:29 -05:00
<img src="https://github.com/kubernetes/kubernetes/raw/master/logo/logo.png" width="100">
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
----
Markdown files in root updated by update-generated-docs.sh.
2016-03-29 14:18:06 -04:00
Use K8s in the README Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-11-12 14:23:23 -05:00
Kubernetes, also known as K8s, is an open source system for managing [containerized applications]
Made some spelling & grammar edits to the README
2019-08-29 23:07:25 -04:00
across multiple hosts. It provides basic mechanisms for deployment, maintenance,
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
and scaling of applications.
Add a note about pre-production.
2014-07-03 17:10:20 -04:00
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
Kubernetes builds upon a decade and a half of experience at Google running
production workloads at scale using a system called [Borg],
combined with best-of-breed ideas and practices from the community.
README: be more accurate about where k8s can run The README really undersells all of the places that can run Kubernetes. Direct users at the getting started guides and be more optimistics about the possibilities of running Kubernetes anywhere.
2016-05-15 14:59:31 -04:00
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
Kubernetes is hosted by the Cloud Native Computing Foundation ([CNCF]).
Made some spelling & grammar edits to the README
2019-08-29 23:07:25 -04:00
If your company wants to help shape the evolution of
technologies that are container-packaged, dynamically scheduled,
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
and microservices-oriented, consider joining the CNCF.
For details about who's involved and how Kubernetes plays a role,
read the CNCF [announcement].
Updated readme.md
2014-12-02 16:20:48 -05:00
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
----
Updated readme.md
2014-12-02 16:20:48 -05:00
Use K8s in the README Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-11-12 14:23:23 -05:00
## To start using K8s
Edit the community, discussion, and support section - add link to community page and cloud native computing foundation Also fixed urls: Changed: GoogleCloudPlatform To: kubernetes
2015-08-31 16:53:32 -04:00
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
See our documentation on [kubernetes.io].
add pointer to feature repo Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-08-23 17:22:08 -04:00
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
Try our [interactive tutorial].
Add community expectations about conduct and reviewing.
2016-09-05 23:30:29 -04:00
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
Take a free course on [Scalable Microservices with Kubernetes].
Update godoc badge from png to svg
2016-03-01 20:34:21 -05:00
Make k8s.io/kubernetes dependency policy explicit
2019-10-30 10:53:02 -04:00
To use Kubernetes code as a library in other applications, see the [list of published components](https://git.k8s.io/kubernetes/staging/README.md).
Use of the `k8s.io/kubernetes` module or `k8s.io/kubernetes/...` packages as libraries is not supported.
Use K8s in the README Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-11-12 14:23:23 -05:00
## To start developing K8s
Edit the community, discussion, and support section - add link to community page and cloud native computing foundation Also fixed urls: Changed: GoogleCloudPlatform To: kubernetes
2015-08-31 16:53:32 -04:00
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
The [community repository] hosts all information about
building Kubernetes from source, how to contribute code
and documentation, who to contact about what, etc.
Add build instructions for the impatient
2016-12-15 09:06:11 -05:00
If you want to build Kubernetes right away there are two options:
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
##### You have a working [Go environment].
Add build instructions for the impatient
2016-12-15 09:06:11 -05:00
```
Update kubernetes dev setup instructions
2019-09-06 11:16:38 -04:00
mkdir -p $GOPATH/src/k8s.io
cd $GOPATH/src/k8s.io
git clone https://github.com/kubernetes/kubernetes
cd kubernetes
Update README.md 1st PR - Removing '$' for standard and consistancy across Kubernetes documentation
2019-04-08 20:35:19 -04:00
make
Add build instructions for the impatient
2016-12-15 09:06:11 -05:00
```
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
##### You have a working [Docker environment].
Add build instructions for the impatient
2016-12-15 09:06:11 -05:00
```
Update README.md 1st PR - Removing '$' for standard and consistancy across Kubernetes documentation
2019-04-08 20:35:19 -04:00
git clone https://github.com/kubernetes/kubernetes
cd kubernetes
make quick-release
Add build instructions for the impatient
2016-12-15 09:06:11 -05:00
```
Reword double negative; link to readme
2017-12-07 21:53:25 -05:00
For the full story, head over to the [developer's documentation].
Add build instructions for the impatient
2016-12-15 09:06:11 -05:00
improve readme for contributor experience
2016-11-15 09:02:29 -05:00
## Support
add corekube
2016-03-31 20:18:22 -04:00
Update README.md with punctuation improvements Added a semicolon on line 10 after "hosts" to improve sentence structure and prevent confusion.
2018-01-23 11:16:37 -05:00
If you need support, start with the [troubleshooting guide],
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
and work your way through the process that we've outlined.
That said, if you have questions, reach out to us
[one way or another][communication].
[announcement]: https://cncf.io/news/announcement/2015/07/new-cloud-native-computing-foundation-drive-alignment-among-container
[Borg]: https://research.google.com/pubs/pub43438.html
[CNCF]: https://www.cncf.io/about
Update README.md Update communication link Use git.k8s.io url for communication Use git.k8s.io for other links
2018-02-10 03:12:28 -05:00
[communication]: https://git.k8s.io/community/communication
[community repository]: https://git.k8s.io/community
Update link in README after docs migration Removing an extra hop caused by docs migration. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2017-03-30 15:43:39 -04:00
[containerized applications]: https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/
Update README.md Update communication link Use git.k8s.io url for communication Use git.k8s.io for other links
2018-02-10 03:12:28 -05:00
[developer's documentation]: https://git.k8s.io/community/contributors/devel#readme
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
[Docker environment]: https://docs.docker.com/engine
[Go environment]: https://golang.org/doc/install
Update godoc reference widget to pkg.go.dev godoc.org has been replaced with pgk.go.dev. A redirect exists for now, but will eventually be turned off. For more information see the go blog post on this migration: https://blog.golang.org/pkg.go.dev-2020
2021-01-26 09:34:07 -05:00
[GoPkg]: https://pkg.go.dev/k8s.io/kubernetes
[GoPkg Widget]: https://pkg.go.dev/badge/k8s.io/kubernetes.svg
Change README links to https
2018-07-18 09:24:42 -04:00
[interactive tutorial]: https://kubernetes.io/docs/tutorials/kubernetes-basics
[kubernetes.io]: https://kubernetes.io
Close kubernetes/community#420 * Move remaining community stuff out of kubernetes/kubernetes/README so that there's only one thing to maintain. * Put self-contained things into their own MD files. * Have other docs point to those files rather than attempt to repeat their content. * Make all docs smaller. See also companion PR in kubernetes/community.
2017-03-06 12:21:47 -05:00
[Scalable Microservices with Kubernetes]: https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615
Removed broken link to Analytics
2020-08-13 16:03:37 -04:00
[troubleshooting guide]: https://kubernetes.io/docs/tasks/debug-application-cluster/troubleshooting/
Reference in a new issue Copy permalink