diff --git a/build/mark-new-version.sh b/build/mark-new-version.sh index ff8abb15bca..32d57f55648 100755 --- a/build/mark-new-version.sh +++ b/build/mark-new-version.sh @@ -92,12 +92,20 @@ fi echo "+++ Versioning documentation and examples" # Update the docs to match this version. -DOCS_TO_EDIT=(docs/README.md examples/README.md) -for DOC in "${DOCS_TO_EDIT[@]}"; do +md_dirs=(docs examples) +md_files=() +for dir in "${md_dirs[@]}"; do + mdfiles+=($( find "${dir}" -name "*.md" -type f )) +done +for doc in "${mdfiles[@]}"; do $SED -ri \ -e '//,//d' \ -e "s|(releases.k8s.io)/[^/]+|\1/${NEW_VERSION}|" \ - "${DOC}" + "${doc}" + is_versioned_tag='' + if ! grep -q "${is_versioned_tag}" "${doc}"; then + echo "${is_versioned_tag}" >> "${doc}" + fi done # Update API descriptions to match this version. diff --git a/cmd/mungedocs/mungedocs.go b/cmd/mungedocs/mungedocs.go index b82d1d22f23..0c1fe218912 100644 --- a/cmd/mungedocs/mungedocs.go +++ b/cmd/mungedocs/mungedocs.go @@ -40,6 +40,7 @@ var ( allMunges = []munge{ {"table-of-contents", updateTOC}, {"check-links", checkLinks}, + {"unversioned-warning", updateUnversionedWarning}, } ) diff --git a/cmd/mungedocs/toc.go b/cmd/mungedocs/toc.go index 9011e117db9..de0bdca6ecb 100644 --- a/cmd/mungedocs/toc.go +++ b/cmd/mungedocs/toc.go @@ -23,10 +23,12 @@ import ( "strings" ) +const tocMungeTag = "GENERATED_TOC" + // inserts/updates a table of contents in markdown file. // // First, builds a ToC. -// Then, finds and , and replaces anything between those with +// Then, finds the magic macro block tags and replaces anything between those with // the ToC, thereby updating any previously inserted ToC. // // TODO(erictune): put this in own package with tests @@ -36,7 +38,7 @@ func updateTOC(filePath string, markdown []byte) ([]byte, error) { return nil, err } lines := splitLines(markdown) - updatedMarkdown, err := updateMacroBlock(lines, "", "", string(toc)) + updatedMarkdown, err := updateMacroBlock(lines, beginMungeTag(tocMungeTag), endMungeTag(tocMungeTag), string(toc)) if err != nil { return nil, err } diff --git a/cmd/mungedocs/toc_test.go b/cmd/mungedocs/toc_test.go index 5175d8089f1..4875d93c049 100644 --- a/cmd/mungedocs/toc_test.go +++ b/cmd/mungedocs/toc_test.go @@ -29,8 +29,10 @@ func Test_buildTOC(t *testing.T) { }{ {"", ""}, {"Lorem ipsum\ndolor sit amet\n", ""}, - {"# Title\nLorem ipsum \n## Section Heading\ndolor sit amet\n", - "- [Title](#title)\n - [Section Heading](#section-heading)\n"}, + { + "# Title\nLorem ipsum \n## Section Heading\ndolor sit amet\n", + "- [Title](#title)\n - [Section Heading](#section-heading)\n", + }, } for _, c := range cases { actual, err := buildTOC([]byte(c.in)) @@ -47,10 +49,14 @@ func Test_updateTOC(t *testing.T) { out string }{ {"", ""}, - {"Lorem ipsum\ndolor sit amet\n", - "Lorem ipsum\ndolor sit amet\n"}, - {"# Title\nLorem ipsum \n**table of contents**\n\nold cruft\n\n## Section Heading\ndolor sit amet\n", - "# Title\nLorem ipsum \n**table of contents**\n\n- [Title](#title)\n - [Section Heading](#section-heading)\n\n\n## Section Heading\ndolor sit amet\n"}, + { + "Lorem ipsum\ndolor sit amet\n", + "Lorem ipsum\ndolor sit amet\n", + }, + { + "# Title\nLorem ipsum \n**table of contents**\n\nold cruft\n\n## Section Heading\ndolor sit amet\n", + "# Title\nLorem ipsum \n**table of contents**\n\n- [Title](#title)\n - [Section Heading](#section-heading)\n\n\n## Section Heading\ndolor sit amet\n", + }, } for _, c := range cases { actual, err := updateTOC("filename.md", []byte(c.in)) diff --git a/cmd/mungedocs/unversioned_warning.go b/cmd/mungedocs/unversioned_warning.go new file mode 100644 index 00000000000..7768fe38a95 --- /dev/null +++ b/cmd/mungedocs/unversioned_warning.go @@ -0,0 +1,48 @@ +/* +Copyright 2015 The Kubernetes Authors All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package main + +const unversionedWarningTag = "UNVERSIONED_WARNING" + +var beginUnversionedWarning = beginMungeTag(unversionedWarningTag) +var endUnversionedWarning = endMungeTag(unversionedWarningTag) + +const unversionedWarning = ` + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + +` + +// inserts/updates a warning for unversioned docs +func updateUnversionedWarning(file string, markdown []byte) ([]byte, error) { + lines := splitLines(markdown) + if hasLine(lines, "") { + // No warnings on release branches + return markdown, nil + } + if !hasMacroBlock(lines, beginUnversionedWarning, endUnversionedWarning) { + lines = append([]string{beginUnversionedWarning, endUnversionedWarning}, lines...) + } + return updateMacroBlock(lines, beginUnversionedWarning, endUnversionedWarning, unversionedWarning) +} diff --git a/cmd/mungedocs/unversioned_warning_test.go b/cmd/mungedocs/unversioned_warning_test.go new file mode 100644 index 00000000000..f9431905386 --- /dev/null +++ b/cmd/mungedocs/unversioned_warning_test.go @@ -0,0 +1,64 @@ +/* +Copyright 2015 The Kubernetes Authors All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package main + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestUnversionedWarning(t *testing.T) { + warningBlock := beginUnversionedWarning + "\n" + unversionedWarning + "\n" + endUnversionedWarning + "\n" + var cases = []struct { + in string + out string + }{ + {"", warningBlock}, + { + "Foo\nBar\n", + warningBlock + "Foo\nBar\n", + }, + { + "Foo\n\nBar", + "Foo\n\nBar", + }, + { + beginUnversionedWarning + "\n" + endUnversionedWarning + "\n", + warningBlock, + }, + { + beginUnversionedWarning + "\n" + "something\n" + endUnversionedWarning + "\n", + warningBlock, + }, + { + "Foo\n" + beginUnversionedWarning + "\n" + endUnversionedWarning + "\nBar\n", + "Foo\n" + warningBlock + "Bar\n", + }, + { + "Foo\n" + warningBlock + "Bar\n", + "Foo\n" + warningBlock + "Bar\n", + }, + } + for i, c := range cases { + actual, err := updateUnversionedWarning("filename.md", []byte(c.in)) + assert.NoError(t, err) + if string(actual) != c.out { + t.Errorf("case[%d]: expected %q got %q", i, c.out, string(actual)) + } + } +} diff --git a/cmd/mungedocs/util.go b/cmd/mungedocs/util.go index 8581f5152b9..d4e9773f677 100644 --- a/cmd/mungedocs/util.go +++ b/cmd/mungedocs/util.go @@ -98,3 +98,15 @@ func hasMacroBlock(lines []string, begin string, end string) bool { } return false } + +// Returns the canonical begin-tag for a given description. This does not +// include the trailing newline. +func beginMungeTag(desc string) string { + return fmt.Sprintf("", desc) +} + +// Returns the canonical end-tag for a given description. This does not +// include the trailing newline. +func endMungeTag(desc string) string { + return fmt.Sprintf("", desc) +} diff --git a/docs/README.md b/docs/README.md index c3f3d316422..bd3306ebbc1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,8 @@ -# Kubernetes Documentation: releases.k8s.io/HEAD + -

*** PLEASE NOTE: This documentation applies to the HEAD of the source +

*** PLEASE NOTE: This document applies to the HEAD of the source tree only. If you are using a released version of Kubernetes, you almost certainly want the docs that go with that version.

@@ -11,7 +11,8 @@ certainly want the docs that go with that version. -## Where to start + +# Kubernetes Documentation: releases.k8s.io/HEAD * The [User's guide](user-guide.md) is for anyone who wants to run programs and services on an existing Kubernetes cluster. diff --git a/docs/accessing-the-cluster.md b/docs/accessing-the-cluster.md index c056d5e9e24..28a2e9908fc 100644 --- a/docs/accessing-the-cluster.md +++ b/docs/accessing-the-cluster.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # User Guide to Accessing the Cluster * [Accessing the cluster API](#api) * [Accessing services running on the cluster](#otherservices) diff --git a/docs/accessing_the_api.md b/docs/accessing_the_api.md index a4124731daf..758d828f9bf 100644 --- a/docs/accessing_the_api.md +++ b/docs/accessing_the_api.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Configuring APIserver ports This document describes what ports the kubernetes apiserver diff --git a/docs/admission_controllers.md b/docs/admission_controllers.md index a074d00a82b..5ac39b179a1 100644 --- a/docs/admission_controllers.md +++ b/docs/admission_controllers.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Admission Controllers ## What are they? diff --git a/docs/annotations.md b/docs/annotations.md index 58b8d55eb1a..3d29dd28329 100644 --- a/docs/annotations.md +++ b/docs/annotations.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Annotations We have [labels](labels.md) for identifying metadata. diff --git a/docs/api-conventions.md b/docs/api-conventions.md index fd8b5ea4420..45f55a5d92f 100644 --- a/docs/api-conventions.md +++ b/docs/api-conventions.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + API Conventions =============== diff --git a/docs/api.md b/docs/api.md index e44dec9d429..3acc558614c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # The Kubernetes API Primary system and API concepts are documented in the [User guide](user-guide.md). diff --git a/docs/application-troubleshooting.md b/docs/application-troubleshooting.md index 0ac52a4785c..323e58aac81 100644 --- a/docs/application-troubleshooting.md +++ b/docs/application-troubleshooting.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Application Troubleshooting. This guide is to help users debug applications that are deployed into Kubernetes and not behaving correctly. diff --git a/docs/authentication.md b/docs/authentication.md index ebd3d956b64..cfce591c9f1 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Authentication Plugins Kubernetes uses client certificates, tokens, or http basic auth to authenticate users for API calls. diff --git a/docs/authorization.md b/docs/authorization.md index 9f4968335d5..3bfff677016 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Authorization Plugins diff --git a/docs/availability.md b/docs/availability.md index f1ed8570e5b..ec63e678622 100644 --- a/docs/availability.md +++ b/docs/availability.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Availability This document collects advice on reasoning about and provisioning for high-availability when using Kubernetes clusters. diff --git a/docs/cli-roadmap.md b/docs/cli-roadmap.md index f55c3c409cc..d7d4e7c28bf 100644 --- a/docs/cli-roadmap.md +++ b/docs/cli-roadmap.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes CLI/Configuration Roadmap See also issues with the following labels: diff --git a/docs/client-libraries.md b/docs/client-libraries.md index b4ed7c49bbf..934b522e0e4 100644 --- a/docs/client-libraries.md +++ b/docs/client-libraries.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubernetes API client libraries ### Supported diff --git a/docs/cluster-admin-guide.md b/docs/cluster-admin-guide.md index deccff13d9d..1a68ee8a019 100644 --- a/docs/cluster-admin-guide.md +++ b/docs/cluster-admin-guide.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes Cluster Admin Guide The cluster admin guide is for anyone creating or administering a Kubernetes cluster. diff --git a/docs/cluster-troubleshooting.md b/docs/cluster-troubleshooting.md index c5d8bad4a25..8801e90f258 100644 --- a/docs/cluster-troubleshooting.md +++ b/docs/cluster-troubleshooting.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Cluster Troubleshooting Most of the time, if you encounter problems, it is your application that is having problems. For application problems please see the [application troubleshooting guide](application-troubleshooting.md). diff --git a/docs/cluster_management.md b/docs/cluster_management.md index ef597f1da00..8b95c5b83c6 100644 --- a/docs/cluster_management.md +++ b/docs/cluster_management.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Cluster Management This doc is in progress. diff --git a/docs/compute_resources.md b/docs/compute_resources.md index f0c8c402c02..1ec7f6995b2 100644 --- a/docs/compute_resources.md +++ b/docs/compute_resources.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Compute Resources ** Table of Contents** diff --git a/docs/container-environment.md b/docs/container-environment.md index 88cd5fe6bbc..f7b11076fd4 100644 --- a/docs/container-environment.md +++ b/docs/container-environment.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes Container Environment diff --git a/docs/containers.md b/docs/containers.md index 2c507cb312f..895d857b217 100644 --- a/docs/containers.md +++ b/docs/containers.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Containers with Kubernetes ## Containers and commands diff --git a/docs/design/README.md b/docs/design/README.md index b70c5615aa7..66265b993e5 100644 --- a/docs/design/README.md +++ b/docs/design/README.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes Design Overview Kubernetes is a system for managing containerized applications across multiple hosts, providing basic mechanisms for deployment, maintenance, and scaling of applications. diff --git a/docs/design/access.md b/docs/design/access.md index 85b9c8ec17f..98bf2bdf223 100644 --- a/docs/design/access.md +++ b/docs/design/access.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # K8s Identity and Access Management Sketch This document suggests a direction for identity and access management in the Kubernetes system. diff --git a/docs/design/admission_control.md b/docs/design/admission_control.md index 749e949eada..4094156b561 100644 --- a/docs/design/admission_control.md +++ b/docs/design/admission_control.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes Proposal - Admission Control **Related PR:** diff --git a/docs/design/admission_control_limit_range.md b/docs/design/admission_control_limit_range.md index daddb425d98..c1914478548 100644 --- a/docs/design/admission_control_limit_range.md +++ b/docs/design/admission_control_limit_range.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Admission control plugin: LimitRanger ## Background diff --git a/docs/design/admission_control_resource_quota.md b/docs/design/admission_control_resource_quota.md index b2dfbe85bdc..cd9282df1ca 100644 --- a/docs/design/admission_control_resource_quota.md +++ b/docs/design/admission_control_resource_quota.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Admission control plugin: ResourceQuota ## Background diff --git a/docs/design/architecture.md b/docs/design/architecture.md index ebfb4964dde..6c82896ede4 100644 --- a/docs/design/architecture.md +++ b/docs/design/architecture.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes architecture A running Kubernetes cluster contains node agents (kubelet) and master components (APIs, scheduler, etc), on top of a distributed storage solution. This diagram shows our desired eventual state, though we're still working on a few things, like making kubelet itself (all our components, really) run within containers, and making the scheduler 100% pluggable. diff --git a/docs/design/clustering.md b/docs/design/clustering.md index 4cef06f856e..f88157aa1ff 100644 --- a/docs/design/clustering.md +++ b/docs/design/clustering.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Clustering in Kubernetes diff --git a/docs/design/clustering/README.md b/docs/design/clustering/README.md index 09d2c4e10de..dfd55e96a35 100644 --- a/docs/design/clustering/README.md +++ b/docs/design/clustering/README.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + This directory contains diagrams for the clustering design doc. This depends on the `seqdiag` [utility](http://blockdiag.com/en/seqdiag/index.html). Assuming you have a non-borked python install, this should be installable with diff --git a/docs/design/command_execution_port_forwarding.md b/docs/design/command_execution_port_forwarding.md index 3e548d40e9e..056814e7f3a 100644 --- a/docs/design/command_execution_port_forwarding.md +++ b/docs/design/command_execution_port_forwarding.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Container Command Execution & Port Forwarding in Kubernetes ## Abstract diff --git a/docs/design/event_compression.md b/docs/design/event_compression.md index 74aba66f1cd..4178393c903 100644 --- a/docs/design/event_compression.md +++ b/docs/design/event_compression.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes Event Compression This document captures the design of event compression. diff --git a/docs/design/expansion.md b/docs/design/expansion.md index 8b31526a34f..01a774cb2d6 100644 --- a/docs/design/expansion.md +++ b/docs/design/expansion.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Variable expansion in pod command, args, and env ## Abstract diff --git a/docs/design/identifiers.md b/docs/design/identifiers.md index 23b976d3658..e192b1ed0b8 100644 --- a/docs/design/identifiers.md +++ b/docs/design/identifiers.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Identifiers and Names in Kubernetes A summarization of the goals and recommendations for identifiers in Kubernetes. Described in [GitHub issue #199](https://github.com/GoogleCloudPlatform/kubernetes/issues/199). diff --git a/docs/design/namespaces.md b/docs/design/namespaces.md index 0fef2bed662..547d040b0a1 100644 --- a/docs/design/namespaces.md +++ b/docs/design/namespaces.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Namespaces ## Abstract diff --git a/docs/design/networking.md b/docs/design/networking.md index 210d10e5092..5a4a5835e47 100644 --- a/docs/design/networking.md +++ b/docs/design/networking.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Networking There are 4 distinct networking problems to solve: diff --git a/docs/design/persistent-storage.md b/docs/design/persistent-storage.md index 8e7c6765354..9cc92b425eb 100644 --- a/docs/design/persistent-storage.md +++ b/docs/design/persistent-storage.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Persistent Storage This document proposes a model for managing persistent, cluster-scoped storage for applications requiring long lived data. diff --git a/docs/design/principles.md b/docs/design/principles.md index cf8833a415e..e1bd97da09c 100644 --- a/docs/design/principles.md +++ b/docs/design/principles.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Design Principles Principles to follow when extending Kubernetes. diff --git a/docs/design/resources.md b/docs/design/resources.md index bb3c05e9f59..9539bed2689 100644 --- a/docs/design/resources.md +++ b/docs/design/resources.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + **Note: this is a design doc, which describes features that have not been completely implemented. User documentation of the current state is [here](../compute_resources.md). The tracking issue for implementation of this model is diff --git a/docs/design/secrets.md b/docs/design/secrets.md index 979c07f0a42..a6d2591f93c 100644 --- a/docs/design/secrets.md +++ b/docs/design/secrets.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Abstract diff --git a/docs/design/security.md b/docs/design/security.md index c2fd092e58e..1d1373d2138 100644 --- a/docs/design/security.md +++ b/docs/design/security.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Security in Kubernetes Kubernetes should define a reasonable set of security best practices that allows processes to be isolated from each other, from the cluster infrastructure, and which preserves important boundaries between those who manage the cluster, and those who use the cluster. diff --git a/docs/design/security_context.md b/docs/design/security_context.md index 616412976c5..cbf525a8d39 100644 --- a/docs/design/security_context.md +++ b/docs/design/security_context.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Security Contexts ## Abstract A security context is a set of constraints that are applied to a container in order to achieve the following goals (from [security design](security.md)): diff --git a/docs/design/service_accounts.md b/docs/design/service_accounts.md index c6ceb6b212f..896bd68e798 100644 --- a/docs/design/service_accounts.md +++ b/docs/design/service_accounts.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + #Service Accounts ## Motivation diff --git a/docs/design/simple-rolling-update.md b/docs/design/simple-rolling-update.md index fb21c096aac..45005353999 100644 --- a/docs/design/simple-rolling-update.md +++ b/docs/design/simple-rolling-update.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Simple rolling update This is a lightweight design document for simple rolling update in ```kubectl``` diff --git a/docs/devel/README.md b/docs/devel/README.md index 5957902f03d..26eb7cede93 100644 --- a/docs/devel/README.md +++ b/docs/devel/README.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Developing Kubernetes Docs in this directory relate to developing Kubernetes. diff --git a/docs/devel/api_changes.md b/docs/devel/api_changes.md index de073677dc5..3ad1847d525 100644 --- a/docs/devel/api_changes.md +++ b/docs/devel/api_changes.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # So you want to change the API? The Kubernetes API has two major components - the internal structures and diff --git a/docs/devel/cherry-picks.md b/docs/devel/cherry-picks.md index 2708db93b8a..03f2ebb58ff 100644 --- a/docs/devel/cherry-picks.md +++ b/docs/devel/cherry-picks.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Overview This document explains cherry picks are managed on release branches within the diff --git a/docs/devel/coding-conventions.md b/docs/devel/coding-conventions.md index bdcbb7089f4..e61398ee513 100644 --- a/docs/devel/coding-conventions.md +++ b/docs/devel/coding-conventions.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Coding style advice for contributors - Bash - https://google-styleguide.googlecode.com/svn/trunk/shell.xml diff --git a/docs/devel/collab.md b/docs/devel/collab.md index b424f502b9a..dc12537df83 100644 --- a/docs/devel/collab.md +++ b/docs/devel/collab.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # On Collaborative Development Kubernetes is open source, but many of the people working on it do so as their day job. In order to avoid forcing people to be "at work" effectively 24/7, we want to establish some semi-formal protocols around development. Hopefully these rules make things go more smoothly. If you find that this is not the case, please complain loudly. diff --git a/docs/devel/developer-guides/vagrant.md b/docs/devel/developer-guides/vagrant.md index a561b446ee4..1edf07a669f 100644 --- a/docs/devel/developer-guides/vagrant.md +++ b/docs/devel/developer-guides/vagrant.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Getting started with Vagrant Running kubernetes with Vagrant (and VirtualBox) is an easy way to run/test/develop on your local machine (Linux, Mac OS X). diff --git a/docs/devel/development.md b/docs/devel/development.md index 2e540bcbf7b..37a4478a7a7 100644 --- a/docs/devel/development.md +++ b/docs/devel/development.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Development Guide # Releases and Official Builds diff --git a/docs/devel/faster_reviews.md b/docs/devel/faster_reviews.md index ed890a7fbd9..99e60fb1eda 100644 --- a/docs/devel/faster_reviews.md +++ b/docs/devel/faster_reviews.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # How to get faster PR reviews Most of what is written here is not at all specific to Kubernetes, but it bears diff --git a/docs/devel/flaky-tests.md b/docs/devel/flaky-tests.md index da5549c836a..ee93bf198f8 100644 --- a/docs/devel/flaky-tests.md +++ b/docs/devel/flaky-tests.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Hunting flaky tests in Kubernetes Sometimes unit tests are flaky. This means that due to (usually) race conditions, they will occasionally fail, even though most of the time they pass. diff --git a/docs/devel/getting-builds.md b/docs/devel/getting-builds.md index dbad8f3aa8a..5a1a4dde554 100644 --- a/docs/devel/getting-builds.md +++ b/docs/devel/getting-builds.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Getting Kubernetes Builds You can use [hack/get-build.sh](../../hack/get-build.sh) to or use as a reference on how to get the most recent builds with curl. With `get-build.sh` you can grab the most recent stable build, the most recent release candidate, or the most recent build to pass our ci and gce e2e tests (essentially a nightly build). diff --git a/docs/devel/instrumentation.md b/docs/devel/instrumentation.md index b52480d2ed0..762d1980a62 100644 --- a/docs/devel/instrumentation.md +++ b/docs/devel/instrumentation.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Instrumenting Kubernetes with a new metric =================== diff --git a/docs/devel/issues.md b/docs/devel/issues.md index 99e1089af8c..62444185ac6 100644 --- a/docs/devel/issues.md +++ b/docs/devel/issues.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + GitHub Issues for the Kubernetes Project ======================================== diff --git a/docs/devel/logging.md b/docs/devel/logging.md index 331eda97e16..1ca18718027 100644 --- a/docs/devel/logging.md +++ b/docs/devel/logging.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Logging Conventions =================== diff --git a/docs/devel/making-release-notes.md b/docs/devel/making-release-notes.md index 5d08ac503fa..0dfbeebe1be 100644 --- a/docs/devel/making-release-notes.md +++ b/docs/devel/making-release-notes.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Making release notes This documents the process for making release notes for a release. diff --git a/docs/devel/profiling.md b/docs/devel/profiling.md index 1dd420959e8..51635424200 100644 --- a/docs/devel/profiling.md +++ b/docs/devel/profiling.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Profiling Kubernetes This document explain how to plug in profiler and how to profile Kubernetes services. diff --git a/docs/devel/pull-requests.md b/docs/devel/pull-requests.md index 1b5c30e6457..e82d2d005df 100644 --- a/docs/devel/pull-requests.md +++ b/docs/devel/pull-requests.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Pull Request Process ==================== diff --git a/docs/devel/releasing.md b/docs/devel/releasing.md index 9cec89e0e1d..a83f667782d 100644 --- a/docs/devel/releasing.md +++ b/docs/devel/releasing.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Releasing Kubernetes This document explains how to cut a release, and the theory behind it. If you diff --git a/docs/devel/scheduler.md b/docs/devel/scheduler.md index de05b014519..3e1ae0e195c 100644 --- a/docs/devel/scheduler.md +++ b/docs/devel/scheduler.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # The Kubernetes Scheduler diff --git a/docs/devel/scheduler_algorithm.md b/docs/devel/scheduler_algorithm.md index 2d239f2bd77..96789422c59 100644 --- a/docs/devel/scheduler_algorithm.md +++ b/docs/devel/scheduler_algorithm.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Scheduler Algorithm in Kubernetes For each unscheduled Pod, the Kubernetes scheduler tries to find a node across the cluster according to a set of rules. A general introduction to the Kubernetes scheduler can be found at [docs/devel/scheduler.md](../../docs/devel/scheduler.md). In this document, the algorithm of how to select a node for the Pod is explained. There are two steps before a destination node of a Pod is chosen. The first step is filtering all the nodes and the second is ranking the remaining nodes to find a best fit for the Pod. diff --git a/docs/devel/writing-a-getting-started-guide.md b/docs/devel/writing-a-getting-started-guide.md index 4085236180b..7b94d9a3feb 100644 --- a/docs/devel/writing-a-getting-started-guide.md +++ b/docs/devel/writing-a-getting-started-guide.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Writing a Getting Started Guide This page gives some advice for anyone planning to write or update a Getting Started Guide for Kubernetes. It also gives some guidelines which reviewers should follow when reviewing a pull request for a diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 817a93aeb9a..dbd1021d5eb 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes Developer Guide The developer guide is for anyone wanting to either write code which directly accesses the diff --git a/docs/dns.md b/docs/dns.md index 5e1325a43c4..c1a0db1172f 100644 --- a/docs/dns.md +++ b/docs/dns.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # DNS Integration with Kubernetes As of kubernetes 0.8, DNS is offered as a [cluster add-on](../cluster/addons/README.md). diff --git a/docs/downward_api.md b/docs/downward_api.md index b30d07c8ae6..3fef2e32b11 100644 --- a/docs/downward_api.md +++ b/docs/downward_api.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Downward API It is sometimes useful for a container to have information about itself, but we diff --git a/docs/getting-started-guides/README.md b/docs/getting-started-guides/README.md index 7ebd2b26364..619eaeb9dc7 100644 --- a/docs/getting-started-guides/README.md +++ b/docs/getting-started-guides/README.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + If you are not sure what OSes and infrastructure is supported, the table below lists all the combinations which have been tested recently. diff --git a/docs/getting-started-guides/aws-coreos.md b/docs/getting-started-guides/aws-coreos.md index d205ca13fd9..02804ee60e1 100644 --- a/docs/getting-started-guides/aws-coreos.md +++ b/docs/getting-started-guides/aws-coreos.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Getting started on Amazon EC2 with CoreOS The example below creates an elastic Kubernetes cluster with a custom number of worker nodes and a master. diff --git a/docs/getting-started-guides/aws.md b/docs/getting-started-guides/aws.md index 6d0e4042051..b69b2312e05 100644 --- a/docs/getting-started-guides/aws.md +++ b/docs/getting-started-guides/aws.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started on AWS EC2 -------------------------- diff --git a/docs/getting-started-guides/aws/kubectl.md b/docs/getting-started-guides/aws/kubectl.md index 7d53b932986..0d71f7c427c 100644 --- a/docs/getting-started-guides/aws/kubectl.md +++ b/docs/getting-started-guides/aws/kubectl.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Install and configure kubectl ## Download the kubectl CLI tool diff --git a/docs/getting-started-guides/azure.md b/docs/getting-started-guides/azure.md index 99044fa6ff9..af04ef7d9be 100644 --- a/docs/getting-started-guides/azure.md +++ b/docs/getting-started-guides/azure.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started on Microsoft Azure ---------------------------------- diff --git a/docs/getting-started-guides/binary_release.md b/docs/getting-started-guides/binary_release.md index 6b201072fcb..06a43083091 100644 --- a/docs/getting-started-guides/binary_release.md +++ b/docs/getting-started-guides/binary_release.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Getting a Binary Release You can either build a release from sources or download a pre-built release. If you do not plan on developing Kubernetes itself, we suggest a pre-built release. diff --git a/docs/getting-started-guides/centos/centos_manual_config.md b/docs/getting-started-guides/centos/centos_manual_config.md index 1d8cc8a1b0c..fcc72f3f3ed 100644 --- a/docs/getting-started-guides/centos/centos_manual_config.md +++ b/docs/getting-started-guides/centos/centos_manual_config.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started on [CentOS](http://centos.org) ---------------------------------------------- diff --git a/docs/getting-started-guides/cloudstack.md b/docs/getting-started-guides/cloudstack.md index 4b2060a2687..16b8ac01795 100644 --- a/docs/getting-started-guides/cloudstack.md +++ b/docs/getting-started-guides/cloudstack.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started on [CloudStack](http://cloudstack.apache.org) ------------------------------------------------------------ diff --git a/docs/getting-started-guides/coreos.md b/docs/getting-started-guides/coreos.md index a2468bbee07..aac5136c366 100644 --- a/docs/getting-started-guides/coreos.md +++ b/docs/getting-started-guides/coreos.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Getting started on [CoreOS](http://coreos.com) There are multiple guides on running Kubernetes with [CoreOS](http://coreos.com): diff --git a/docs/getting-started-guides/coreos/azure/README.md b/docs/getting-started-guides/coreos/azure/README.md index d6e8d851687..ac41199ccd8 100644 --- a/docs/getting-started-guides/coreos/azure/README.md +++ b/docs/getting-started-guides/coreos/azure/README.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Kubernetes on Azure with CoreOS and [Weave](http://weave.works) --------------------------------------------------------------- diff --git a/docs/getting-started-guides/coreos/bare_metal_offline.md b/docs/getting-started-guides/coreos/bare_metal_offline.md index 933ea263874..e5cd9eb2a17 100644 --- a/docs/getting-started-guides/coreos/bare_metal_offline.md +++ b/docs/getting-started-guides/coreos/bare_metal_offline.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Bare Metal CoreOS with Kubernetes (OFFLINE) ------------------------------------------ Deploy a CoreOS running Kubernetes environment. This particular guild is made to help those in an OFFLINE system, wither for testing a POC before the real deal, or you are restricted to be totally offline for your applications. diff --git a/docs/getting-started-guides/coreos/coreos_multinode_cluster.md b/docs/getting-started-guides/coreos/coreos_multinode_cluster.md index fb3d03da55c..3602d6c92e5 100644 --- a/docs/getting-started-guides/coreos/coreos_multinode_cluster.md +++ b/docs/getting-started-guides/coreos/coreos_multinode_cluster.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # CoreOS Multinode Cluster Use the [master.yaml](cloud-configs/master.yaml) and [node.yaml](cloud-configs/node.yaml) cloud-configs to provision a multi-node Kubernetes cluster. diff --git a/docs/getting-started-guides/docker-multinode.md b/docs/getting-started-guides/docker-multinode.md index 5f15ad7e219..5105e9e0915 100644 --- a/docs/getting-started-guides/docker-multinode.md +++ b/docs/getting-started-guides/docker-multinode.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Running Multi-Node Kubernetes Using Docker ------------------------------------------ diff --git a/docs/getting-started-guides/docker-multinode/master.md b/docs/getting-started-guides/docker-multinode/master.md index 39c16ee74bd..bdf3bebd08c 100644 --- a/docs/getting-started-guides/docker-multinode/master.md +++ b/docs/getting-started-guides/docker-multinode/master.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Installing a Kubernetes Master Node via Docker We'll begin by setting up the master node. For the purposes of illustration, we'll assume that the IP of this machine is ```${MASTER_IP}``` diff --git a/docs/getting-started-guides/docker-multinode/testing.md b/docs/getting-started-guides/docker-multinode/testing.md index 6172e5079d1..99005e1b28f 100644 --- a/docs/getting-started-guides/docker-multinode/testing.md +++ b/docs/getting-started-guides/docker-multinode/testing.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Testing your Kubernetes cluster. To validate that your node(s) have been added, run: diff --git a/docs/getting-started-guides/docker-multinode/worker.md b/docs/getting-started-guides/docker-multinode/worker.md index fd1398bda02..a3d51036860 100644 --- a/docs/getting-started-guides/docker-multinode/worker.md +++ b/docs/getting-started-guides/docker-multinode/worker.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Adding a Kubernetes worker node via Docker. These instructions are very similar to the master set-up above, but they are duplicated for clarity. diff --git a/docs/getting-started-guides/docker.md b/docs/getting-started-guides/docker.md index 6a5f5fa1dbb..fc58483a67a 100644 --- a/docs/getting-started-guides/docker.md +++ b/docs/getting-started-guides/docker.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Running kubernetes locally via Docker ------------------------------------- diff --git a/docs/getting-started-guides/fedora/fedora_ansible_config.md b/docs/getting-started-guides/fedora/fedora_ansible_config.md index 0926c895b0b..4bbe08271a7 100644 --- a/docs/getting-started-guides/fedora/fedora_ansible_config.md +++ b/docs/getting-started-guides/fedora/fedora_ansible_config.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Configuring kubernetes on [Fedora](http://fedoraproject.org) via [Ansible](http://www.ansible.com/home) ------------------------------------------------------------------------------------------------------- diff --git a/docs/getting-started-guides/fedora/fedora_manual_config.md b/docs/getting-started-guides/fedora/fedora_manual_config.md index 8cd431557f7..5c63138ea23 100644 --- a/docs/getting-started-guides/fedora/fedora_manual_config.md +++ b/docs/getting-started-guides/fedora/fedora_manual_config.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started on [Fedora](http://fedoraproject.org) ----------------------------------------------------- diff --git a/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md b/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md index 336c311abed..bf9239198df 100644 --- a/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md +++ b/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Kubernetes multiple nodes cluster with flannel on Fedora -------------------------------------------------------- diff --git a/docs/getting-started-guides/gce.md b/docs/getting-started-guides/gce.md index d3eda30f8f5..f5d3e1b5188 100644 --- a/docs/getting-started-guides/gce.md +++ b/docs/getting-started-guides/gce.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started on Google Compute Engine ---------------------------------------- diff --git a/docs/getting-started-guides/juju.md b/docs/getting-started-guides/juju.md index d3bf19f227a..187f21a9ef6 100644 --- a/docs/getting-started-guides/juju.md +++ b/docs/getting-started-guides/juju.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started with Juju ------------------------- diff --git a/docs/getting-started-guides/libvirt-coreos.md b/docs/getting-started-guides/libvirt-coreos.md index 567a46beb7e..d26b4c39ec3 100644 --- a/docs/getting-started-guides/libvirt-coreos.md +++ b/docs/getting-started-guides/libvirt-coreos.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started with libvirt CoreOS ----------------------------------- diff --git a/docs/getting-started-guides/locally.md b/docs/getting-started-guides/locally.md index 3eb3f08054e..b2f60a747e1 100644 --- a/docs/getting-started-guides/locally.md +++ b/docs/getting-started-guides/locally.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started locally ----------------------- diff --git a/docs/getting-started-guides/logging-elasticsearch.md b/docs/getting-started-guides/logging-elasticsearch.md index 5de222c7c89..759e8a4920f 100644 --- a/docs/getting-started-guides/logging-elasticsearch.md +++ b/docs/getting-started-guides/logging-elasticsearch.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Cluster Level Logging with Elasticsearch and Kibana On the Google Compute Engine (GCE) platform the default cluster level logging support targets diff --git a/docs/getting-started-guides/logging.md b/docs/getting-started-guides/logging.md index ce57b22e11c..61b6e4b11a2 100644 --- a/docs/getting-started-guides/logging.md +++ b/docs/getting-started-guides/logging.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Cluster Level Logging to Google Cloud Logging A Kubernetes cluster will typically be humming along running many system and application pods. How does the system administrator collect, manage and query the logs of the system pods? How does a user query the logs of their application which is composed of many pods which may be restarted or automatically generated by the Kubernetes system? These questions are addressed by the Kubernetes **cluster level logging** services. diff --git a/docs/getting-started-guides/mesos.md b/docs/getting-started-guides/mesos.md index 7a6590fff9b..5a66a260c8d 100644 --- a/docs/getting-started-guides/mesos.md +++ b/docs/getting-started-guides/mesos.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started with Kubernetes on Mesos ---------------------------------------- diff --git a/docs/getting-started-guides/ovirt.md b/docs/getting-started-guides/ovirt.md index 1450e81f854..a568740f0f3 100644 --- a/docs/getting-started-guides/ovirt.md +++ b/docs/getting-started-guides/ovirt.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started on oVirt ------------------------ diff --git a/docs/getting-started-guides/rackspace.md b/docs/getting-started-guides/rackspace.md index ce5a8b04e49..ad899c278f4 100644 --- a/docs/getting-started-guides/rackspace.md +++ b/docs/getting-started-guides/rackspace.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started on Rackspace ---------------------------- diff --git a/docs/getting-started-guides/rkt/README.md b/docs/getting-started-guides/rkt/README.md index 4f769210f81..0b4c1de7931 100644 --- a/docs/getting-started-guides/rkt/README.md +++ b/docs/getting-started-guides/rkt/README.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Run Kubernetes with rkt This document describes how to run Kubernetes using [rkt](https://github.com/coreos/rkt) as a container runtime. diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index 52f50ad231c..412a20dff69 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started from Scratch ---------------------------- diff --git a/docs/getting-started-guides/ubuntu.md b/docs/getting-started-guides/ubuntu.md index e3ca5240a5b..827ef99be8b 100644 --- a/docs/getting-started-guides/ubuntu.md +++ b/docs/getting-started-guides/ubuntu.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Kubernetes Deployment On Bare-metal Ubuntu Nodes ------------------------------------------------ diff --git a/docs/getting-started-guides/vagrant.md b/docs/getting-started-guides/vagrant.md index ab759248fe5..556ff73ea7d 100644 --- a/docs/getting-started-guides/vagrant.md +++ b/docs/getting-started-guides/vagrant.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Getting started with Vagrant Running kubernetes with Vagrant (and VirtualBox) is an easy way to run/test/develop on your local machine (Linux, Mac OS X). diff --git a/docs/getting-started-guides/vsphere.md b/docs/getting-started-guides/vsphere.md index 1dfb736e06f..88251bab79b 100644 --- a/docs/getting-started-guides/vsphere.md +++ b/docs/getting-started-guides/vsphere.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + Getting started with vSphere ------------------------------- diff --git a/docs/glossary.md b/docs/glossary.md index d73beca2f74..1d3639dcb5f 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Glossary and Concept Index diff --git a/docs/high-availability.md b/docs/high-availability.md index 8e5df0c73cf..d5886a4b57f 100644 --- a/docs/high-availability.md +++ b/docs/high-availability.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # High Availability Kubernetes Clusters ## Introduction diff --git a/docs/identifiers.md b/docs/identifiers.md index d2a79c28863..6765e63eb07 100644 --- a/docs/identifiers.md +++ b/docs/identifiers.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Identifiers All objects in the Kubernetes REST API are unambiguously identified by a Name and a UID. diff --git a/docs/images.md b/docs/images.md index 8360fd8ac48..58d6e6bb1c6 100644 --- a/docs/images.md +++ b/docs/images.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Images Each container in a pod has its own image. Currently, the only type of image supported is a [Docker Image](https://docs.docker.com/userguide/dockerimages/). diff --git a/docs/kube-apiserver.md b/docs/kube-apiserver.md index fa977c82c2e..60294ffec39 100644 --- a/docs/kube-apiserver.md +++ b/docs/kube-apiserver.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kube-apiserver diff --git a/docs/kube-controller-manager.md b/docs/kube-controller-manager.md index 4860ba17fa3..b5b10f1fedb 100644 --- a/docs/kube-controller-manager.md +++ b/docs/kube-controller-manager.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kube-controller-manager diff --git a/docs/kube-proxy.md b/docs/kube-proxy.md index a76db21dd3b..bc3ba3ee35b 100644 --- a/docs/kube-proxy.md +++ b/docs/kube-proxy.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kube-proxy diff --git a/docs/kube-scheduler.md b/docs/kube-scheduler.md index ca2baa61697..ccddb3585b8 100644 --- a/docs/kube-scheduler.md +++ b/docs/kube-scheduler.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kube-scheduler diff --git a/docs/kubeconfig-file.md b/docs/kubeconfig-file.md index 0c6ea8aedef..f22f6080766 100644 --- a/docs/kubeconfig-file.md +++ b/docs/kubeconfig-file.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # kubeconfig files In order to easily switch between multiple clusters, a kubeconfig file was defined. This file contains a series of authentication mechanisms and cluster connection information associated with nicknames. It also introduces the concept of a tuple of authentication information (user) and cluster connection information called a context that is also associated with a nickname. diff --git a/docs/kubectl.md b/docs/kubectl.md index fdcc692c9f9..b8427ee843d 100644 --- a/docs/kubectl.md +++ b/docs/kubectl.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl kubectl controls the Kubernetes cluster manager diff --git a/docs/kubectl_api-versions.md b/docs/kubectl_api-versions.md index 84cc4657bd2..1caf2f3a263 100644 --- a/docs/kubectl_api-versions.md +++ b/docs/kubectl_api-versions.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl api-versions Print available API versions. diff --git a/docs/kubectl_cluster-info.md b/docs/kubectl_cluster-info.md index 833c465b595..2d99bc96969 100644 --- a/docs/kubectl_cluster-info.md +++ b/docs/kubectl_cluster-info.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl cluster-info Display cluster info diff --git a/docs/kubectl_config.md b/docs/kubectl_config.md index 28bc1db5707..4d8c59b9a3c 100644 --- a/docs/kubectl_config.md +++ b/docs/kubectl_config.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl config config modifies kubeconfig files diff --git a/docs/kubectl_config_set-cluster.md b/docs/kubectl_config_set-cluster.md index 84310b3b7a8..fe4621cb93c 100644 --- a/docs/kubectl_config_set-cluster.md +++ b/docs/kubectl_config_set-cluster.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl config set-cluster Sets a cluster entry in kubeconfig diff --git a/docs/kubectl_config_set-context.md b/docs/kubectl_config_set-context.md index a3bdc0596c8..e261cec9248 100644 --- a/docs/kubectl_config_set-context.md +++ b/docs/kubectl_config_set-context.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl config set-context Sets a context entry in kubeconfig diff --git a/docs/kubectl_config_set-credentials.md b/docs/kubectl_config_set-credentials.md index 9a26249c56c..de69851b716 100644 --- a/docs/kubectl_config_set-credentials.md +++ b/docs/kubectl_config_set-credentials.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl config set-credentials Sets a user entry in kubeconfig diff --git a/docs/kubectl_config_set.md b/docs/kubectl_config_set.md index a4bfb564bb6..10c275a8920 100644 --- a/docs/kubectl_config_set.md +++ b/docs/kubectl_config_set.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl config set Sets an individual value in a kubeconfig file diff --git a/docs/kubectl_config_unset.md b/docs/kubectl_config_unset.md index 1a1c567cc46..07fbd050292 100644 --- a/docs/kubectl_config_unset.md +++ b/docs/kubectl_config_unset.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl config unset Unsets an individual value in a kubeconfig file diff --git a/docs/kubectl_config_use-context.md b/docs/kubectl_config_use-context.md index bb978a9ce9e..7178917c589 100644 --- a/docs/kubectl_config_use-context.md +++ b/docs/kubectl_config_use-context.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl config use-context Sets the current-context in a kubeconfig file diff --git a/docs/kubectl_config_view.md b/docs/kubectl_config_view.md index 713ae2e54a4..33768cd9296 100644 --- a/docs/kubectl_config_view.md +++ b/docs/kubectl_config_view.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl config view displays Merged kubeconfig settings or a specified kubeconfig file. diff --git a/docs/kubectl_create.md b/docs/kubectl_create.md index df449ef0706..f9b59850867 100644 --- a/docs/kubectl_create.md +++ b/docs/kubectl_create.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl create Create a resource by filename or stdin diff --git a/docs/kubectl_delete.md b/docs/kubectl_delete.md index 36154ec6280..a9843524d00 100644 --- a/docs/kubectl_delete.md +++ b/docs/kubectl_delete.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl delete Delete a resource by filename, stdin, resource and name, or by resources and label selector. diff --git a/docs/kubectl_describe.md b/docs/kubectl_describe.md index a054c01cb8c..039b1f98f7f 100644 --- a/docs/kubectl_describe.md +++ b/docs/kubectl_describe.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl describe Show details of a specific resource or group of resources diff --git a/docs/kubectl_exec.md b/docs/kubectl_exec.md index fc388c50d75..506cf7602fd 100644 --- a/docs/kubectl_exec.md +++ b/docs/kubectl_exec.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl exec Execute a command in a container. diff --git a/docs/kubectl_expose.md b/docs/kubectl_expose.md index ccdea8d157d..03850b0c9f9 100644 --- a/docs/kubectl_expose.md +++ b/docs/kubectl_expose.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl expose Take a replicated application and expose it as Kubernetes Service diff --git a/docs/kubectl_get.md b/docs/kubectl_get.md index 6d77854b0a1..0b0a5b3e40c 100644 --- a/docs/kubectl_get.md +++ b/docs/kubectl_get.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl get Display one or many resources diff --git a/docs/kubectl_label.md b/docs/kubectl_label.md index 4e30a126d2e..7c41649545a 100644 --- a/docs/kubectl_label.md +++ b/docs/kubectl_label.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl label Update the labels on a resource diff --git a/docs/kubectl_logs.md b/docs/kubectl_logs.md index 32516d53e50..d6e19e6c4d0 100644 --- a/docs/kubectl_logs.md +++ b/docs/kubectl_logs.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl logs Print the logs for a container in a pod. diff --git a/docs/kubectl_namespace.md b/docs/kubectl_namespace.md index a87e6f5e905..ad6935b301e 100644 --- a/docs/kubectl_namespace.md +++ b/docs/kubectl_namespace.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl namespace SUPERCEDED: Set and view the current Kubernetes namespace diff --git a/docs/kubectl_patch.md b/docs/kubectl_patch.md index e285fafcaae..f22611af1de 100644 --- a/docs/kubectl_patch.md +++ b/docs/kubectl_patch.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl patch Update field(s) of a resource by stdin. diff --git a/docs/kubectl_port-forward.md b/docs/kubectl_port-forward.md index fc127cd59d0..20488071398 100644 --- a/docs/kubectl_port-forward.md +++ b/docs/kubectl_port-forward.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl port-forward Forward one or more local ports to a pod. diff --git a/docs/kubectl_proxy.md b/docs/kubectl_proxy.md index 06a1397114b..a317e2b8ce2 100644 --- a/docs/kubectl_proxy.md +++ b/docs/kubectl_proxy.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl proxy Run a proxy to the Kubernetes API server diff --git a/docs/kubectl_replace.md b/docs/kubectl_replace.md index 4410ecf1ca2..7882a43ddf4 100644 --- a/docs/kubectl_replace.md +++ b/docs/kubectl_replace.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl replace Replace a resource by filename or stdin. diff --git a/docs/kubectl_rolling-update.md b/docs/kubectl_rolling-update.md index f3d4c9d647f..dca52bb5229 100644 --- a/docs/kubectl_rolling-update.md +++ b/docs/kubectl_rolling-update.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl rolling-update Perform a rolling update of the given ReplicationController. diff --git a/docs/kubectl_run.md b/docs/kubectl_run.md index 324c390513b..114f07ecf2e 100644 --- a/docs/kubectl_run.md +++ b/docs/kubectl_run.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl run Run a particular image on the cluster. diff --git a/docs/kubectl_scale.md b/docs/kubectl_scale.md index 1445a1144e5..49976905065 100644 --- a/docs/kubectl_scale.md +++ b/docs/kubectl_scale.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl scale Set a new size for a Replication Controller. diff --git a/docs/kubectl_stop.md b/docs/kubectl_stop.md index a2aa80f850e..b5def3837b3 100644 --- a/docs/kubectl_stop.md +++ b/docs/kubectl_stop.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl stop Gracefully shut down a resource by name or filename. diff --git a/docs/kubectl_version.md b/docs/kubectl_version.md index 9c2effe792c..149f393a9f3 100644 --- a/docs/kubectl_version.md +++ b/docs/kubectl_version.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubectl version Print the client and server version information. diff --git a/docs/kubelet.md b/docs/kubelet.md index d91212f4de4..ec0b4c2ea8b 100644 --- a/docs/kubelet.md +++ b/docs/kubelet.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## kubelet diff --git a/docs/labels.md b/docs/labels.md index 3c10962ed80..a5a3d861f56 100644 --- a/docs/labels.md +++ b/docs/labels.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Labels _Labels_ are key/value pairs that are attached to objects, such as pods. diff --git a/docs/logging.md b/docs/logging.md index 14d48a6b9cc..9e5d8538cef 100644 --- a/docs/logging.md +++ b/docs/logging.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Logging ## Logging by Kubernetes Components diff --git a/docs/monitoring.md b/docs/monitoring.md index 9fa3aac691b..9b13a67640c 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Resource Usage Monitoring in Kubernetes Understanding how an application behaves when deployed is crucial to scaling the application and providing a reliable service. In a Kubernetes cluster, application performance can be examined at many different levels: containers, [pods](pods.md), [services](services.md), and whole clusters. As part of Kubernetes we want to provide users with detailed resource usage information about their running applications at all these levels. This will give users deep insights into how their applications are performing and where possible application bottlenecks may be found. In comes [Heapster](https://github.com/GoogleCloudPlatform/heapster), a project meant to provide a base monitoring platform on Kubernetes. diff --git a/docs/namespaces.md b/docs/namespaces.md index a4bf18ccad2..f040610abe8 100644 --- a/docs/namespaces.md +++ b/docs/namespaces.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Namespaces Namespaces help different projects, teams, or customers to share a kubernetes cluster. First, they provide a scope for [Names](identifiers.md). Second, as our access control code develops, it is expected that it will be convenient to attach authorization and other policy to namespaces. diff --git a/docs/networking.md b/docs/networking.md index d9f439c0843..9879bc9cfd8 100644 --- a/docs/networking.md +++ b/docs/networking.md @@ -1,6 +1,20 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Networking in Kubernetes **Table of Contents** - + - [Networking in Kubernetes](#networking-in-kubernetes) - [Summary](#summary) - [Docker model](#docker-model) @@ -14,7 +28,7 @@ - [Calico](#calico) - [Other reading](#other-reading) - + Kubernetes approaches networking somewhat differently than Docker does by default. There are 4 distinct networking problems to solve: diff --git a/docs/node.md b/docs/node.md index f2a687f64a6..c708f446ef1 100644 --- a/docs/node.md +++ b/docs/node.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Node ## What is a node? diff --git a/docs/overview.md b/docs/overview.md index 2b9014283c2..6fb6c529a0b 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Documentation Kubernetes is an open-source system for managing containerized applications across multiple hosts in a cluster. It provides mechanisms for application deployment, scheduling, updating, maintenance, and scaling. A key feature of Kubernetes is that it actively manages the containers to ensure that the state of the cluster continually matches the user's intentions. diff --git a/docs/ovs-networking.md b/docs/ovs-networking.md index a5ec921fbd0..1204a46054e 100644 --- a/docs/ovs-networking.md +++ b/docs/ovs-networking.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes OpenVSwitch GRE/VxLAN networking This document describes how OpenVSwitch is used to setup networking between pods across nodes. diff --git a/docs/persistent-volumes.md b/docs/persistent-volumes.md index 0b57d6d7512..e843570840e 100644 --- a/docs/persistent-volumes.md +++ b/docs/persistent-volumes.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Persistent Volumes and Claims This document describes the current state of `PersistentVolumes` in Kubernetes. Familiarity with [volumes](volumes.md) is suggested. diff --git a/docs/pod-states.md b/docs/pod-states.md index d6bb9d5e7fb..cdcbb2001e7 100644 --- a/docs/pod-states.md +++ b/docs/pod-states.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # The life of a pod Updated: 4/14/2015 diff --git a/docs/pods.md b/docs/pods.md index 74da4cd5a0b..314f2bed6cc 100644 --- a/docs/pods.md +++ b/docs/pods.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Pods In Kubernetes, rather than individual application containers, _pods_ are the smallest deployable units that can be created, scheduled, and managed. diff --git a/docs/proposals/autoscaling.md b/docs/proposals/autoscaling.md index b767e132b8c..bd8244abb6e 100644 --- a/docs/proposals/autoscaling.md +++ b/docs/proposals/autoscaling.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + ## Abstract Auto-scaling is a data-driven feature that allows users to increase or decrease capacity as needed by controlling the number of pods deployed within the system automatically. diff --git a/docs/proposals/federation.md b/docs/proposals/federation.md index efdd726ac86..a8e9813ba32 100644 --- a/docs/proposals/federation.md +++ b/docs/proposals/federation.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + #Kubernetes Cluster Federation ##(a.k.a. "Ubernetes") diff --git a/docs/proposals/high-availability.md b/docs/proposals/high-availability.md index ece4739588e..e7f77288e57 100644 --- a/docs/proposals/high-availability.md +++ b/docs/proposals/high-availability.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # High Availability of Scheduling and Controller Components in Kubernetes This document serves as a proposal for high availability of the scheduler and controller components in kubernetes. This proposal is intended to provide a simple High Availability api for kubernetes components with the potential to extend to services running on kubernetes. Those services would be subject to their own constraints. diff --git a/docs/replication-controller.md b/docs/replication-controller.md index 0de71face4e..ba3beaea1de 100644 --- a/docs/replication-controller.md +++ b/docs/replication-controller.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Replication Controller ## What is a _replication controller_? diff --git a/docs/resource_quota_admin.md b/docs/resource_quota_admin.md index 2f40b10584f..bde7671b2d9 100644 --- a/docs/resource_quota_admin.md +++ b/docs/resource_quota_admin.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Administering Resource Quotas Kubernetes can limit both the number of objects created in a namespace, and the diff --git a/docs/roadmap.md b/docs/roadmap.md index 05104c8bac9..6d1fb9dab07 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes v1 Updated May 28, 2015 diff --git a/docs/salt.md b/docs/salt.md index 6381d61b833..5e16bb27f70 100644 --- a/docs/salt.md +++ b/docs/salt.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Using Salt to configure Kubernetes The Kubernetes cluster can be configured using Salt. diff --git a/docs/secrets.md b/docs/secrets.md index fa052d6f290..0f2652034b3 100644 --- a/docs/secrets.md +++ b/docs/secrets.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Secrets Objects of type `secret` are intended to hold sensitive information, such as diff --git a/docs/security_context.md b/docs/security_context.md index f4aaecd9002..c5d0d45fe05 100644 --- a/docs/security_context.md +++ b/docs/security_context.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Security Contexts A security context defines the operating system security settings (uid, gid, capabilities, SELinux role, etc..) applied to a container. See [security context design](design/security_context.md) for more details. diff --git a/docs/service_accounts.md b/docs/service_accounts.md index 4e860fccb90..06618cf2a0c 100644 --- a/docs/service_accounts.md +++ b/docs/service_accounts.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Service Accounts A service account provides an identity for processes that run in a Pod. diff --git a/docs/service_accounts_admin.md b/docs/service_accounts_admin.md index f371e2e90af..41992d5a4c0 100644 --- a/docs/service_accounts_admin.md +++ b/docs/service_accounts_admin.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Cluster Admin Guide to Service Accounts *This is a Cluster Administrator guide to service accounts. It assumes knowledge of diff --git a/docs/services-firewalls.md b/docs/services-firewalls.md index c97beb29d77..7bc9c74d7d1 100644 --- a/docs/services-firewalls.md +++ b/docs/services-firewalls.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Services and Firewalls Many cloud providers (e.g. Google Compute Engine) define firewalls that help keep prevent inadvertent diff --git a/docs/services.md b/docs/services.md index 1a63d9eb1a2..6bb47a87c98 100644 --- a/docs/services.md +++ b/docs/services.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Services in Kubernetes ## Overview diff --git a/docs/sharing-clusters.md b/docs/sharing-clusters.md index 35f31b67d72..6e0bb5279e1 100644 --- a/docs/sharing-clusters.md +++ b/docs/sharing-clusters.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Sharing Cluster Access Client access to a running kubernetes cluster can be shared by copying diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 4c96fc2cbd4..142af647a0c 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Troubleshooting Sometimes things go wrong. This guide is aimed at making them right. It has two sections: * [Troubleshooting your application](application-troubleshooting.md) - Useful for users who are deploying code into Kubernetes and wondering why it is not working. diff --git a/docs/ui.md b/docs/ui.md index e111d0d50f6..94e327aea18 100644 --- a/docs/ui.md +++ b/docs/ui.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Interface Kubernetes has a web-based user interface that displays the current cluster state graphically. diff --git a/docs/user-guide.md b/docs/user-guide.md index 7f35e34f27e..021cf19d23a 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide The user guide is intended for anyone who wants to run programs and services diff --git a/docs/user-guide/configuring-containers.md b/docs/user-guide/configuring-containers.md index e5323d0eb55..301abc22638 100644 --- a/docs/user-guide/configuring-containers.md +++ b/docs/user-guide/configuring-containers.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide: Managing Applications: Configuring and launching containers ## Configuration in Kubernetes diff --git a/docs/user-guide/connecting-applications.md b/docs/user-guide/connecting-applications.md index 598a30fe2b8..6d44fc977a2 100644 --- a/docs/user-guide/connecting-applications.md +++ b/docs/user-guide/connecting-applications.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide: Managing Applications: Connecting applications Now that you have a continuously running, replicated application you can expose it on a network. Before discussing the Kubernetes approach to networking, it is worthwhile to contrast it with the "normal" way networking works with Docker. diff --git a/docs/user-guide/connecting-to-applications-port-forward.md b/docs/user-guide/connecting-to-applications-port-forward.md index cd7aac2fc7b..8880c8bbdfc 100644 --- a/docs/user-guide/connecting-to-applications-port-forward.md +++ b/docs/user-guide/connecting-to-applications-port-forward.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + #Connecting to applications: kubectl port-forward kubectl port-forward forwards connections to a local port to a port on a pod. Its man page is available [here](../../docs/kubectl_port-forward.md). Compared to [kubectl proxy](../../docs/accessing-the-cluster.md#using-kubectl-proxy), `kubectl port-forward` is more generic as it can forward TCP traffic while `kubectl proxy` can only forward HTTP traffic. This guide demonstrates how to use `kubectl port-forward` to connect to a Redis database, which may be useful for database debugging. diff --git a/docs/user-guide/connecting-to-applications-proxy.md b/docs/user-guide/connecting-to-applications-proxy.md index ee23ab97f8f..b6e814ddbb9 100644 --- a/docs/user-guide/connecting-to-applications-proxy.md +++ b/docs/user-guide/connecting-to-applications-proxy.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + #Connecting to applications: kubectl proxy and apiserver proxy You have seen the [basics](../../docs/accessing-the-cluster.md) about `kubectl proxy` and `apiserver proxy`. This guide shows how to use them together to access a service([kube-ui](../../docs/ui.md)) running on the Kubernetes cluster from your workstation. diff --git a/docs/user-guide/deploying-applications.md b/docs/user-guide/deploying-applications.md index 9d8b99c3d57..faf9c8b46da 100644 --- a/docs/user-guide/deploying-applications.md +++ b/docs/user-guide/deploying-applications.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide: Managing Applications: Deploying continuously running applications You previously read about how to quickly deploy a simple replicated application using [`kubectl run`](quick-start.md) and how to configure and launch single-run containers using pods (configuring-containers.md). Here, you’ll use the configuration-based approach to deploy a continuously running, replicated application. diff --git a/docs/user-guide/getting-into-containers.md b/docs/user-guide/getting-into-containers.md index c7adcad46d1..8a746be3926 100644 --- a/docs/user-guide/getting-into-containers.md +++ b/docs/user-guide/getting-into-containers.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + #Getting into containers: kubectl exec Developers can use `kubectl exec` to run commands in a container. This guide demonstrates two use cases. diff --git a/docs/user-guide/introspection-and-debugging.md b/docs/user-guide/introspection-and-debugging.md index 103d4cefc51..e34a28f6deb 100644 --- a/docs/user-guide/introspection-and-debugging.md +++ b/docs/user-guide/introspection-and-debugging.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide: Managing Applications: Application Introspection and Debugging Once your application is running, you’ll inevitably need to debug problems with it. diff --git a/docs/user-guide/managing-deployments.md b/docs/user-guide/managing-deployments.md index 3ba7380cee7..e44f89c61b9 100644 --- a/docs/user-guide/managing-deployments.md +++ b/docs/user-guide/managing-deployments.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide: Managing Applications: Managing deployments You’ve deployed your application and exposed it via a service. Now what? Kubernetes provides a number of tools to help you manage your application deployment, including scaling and updating. Among the features we’ll discuss in more depth are [configuration files](configuring-containers.md#configuration-in-kubernetes) and [labels](deploying-applications.md#labels). diff --git a/docs/user-guide/prereqs.md b/docs/user-guide/prereqs.md index 17342528a2d..17f9dd4f81c 100644 --- a/docs/user-guide/prereqs.md +++ b/docs/user-guide/prereqs.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide: Managing Applications: Prerequisites To deploy and manage applications on Kubernetes, you’ll use the Kubernetes command-line tool, [kubectl](../../docs/kubectl.md). It can be found in the release tar bundle, or can be built from source from github. Ensure that it is executable and in your path. diff --git a/docs/user-guide/production-pods.md b/docs/user-guide/production-pods.md index 3afe34645af..b85b4a1fc78 100644 --- a/docs/user-guide/production-pods.md +++ b/docs/user-guide/production-pods.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide: Managing Applications: Working with pods and containers in production You’ve seen [how to configure and deploy pods and containers](configuring-containers.md), using some of the most common configuration parameters. This section dives into additional features that are especially useful for running applications in production. diff --git a/docs/user-guide/quick-start.md b/docs/user-guide/quick-start.md index a2f28739dd2..4080d2c027b 100644 --- a/docs/user-guide/quick-start.md +++ b/docs/user-guide/quick-start.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes User Guide: Managing Applications: Quick start This guide will help you get oriented to Kubernetes and running your first containers on the cluster. diff --git a/docs/versioning.md b/docs/versioning.md index 733e904d199..e7234f72e3a 100644 --- a/docs/versioning.md +++ b/docs/versioning.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Kubernetes API and Release Versioning Legend: diff --git a/docs/volumes.md b/docs/volumes.md index f160f8bcb07..a0006c1e40f 100644 --- a/docs/volumes.md +++ b/docs/volumes.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Volumes On-disk files in a container are ephemeral, which presents some problems for diff --git a/docs/working_with_resources.md b/docs/working_with_resources.md index b78bb176a15..227adaa53ba 100644 --- a/docs/working_with_resources.md +++ b/docs/working_with_resources.md @@ -1,3 +1,17 @@ + + + + +

*** PLEASE NOTE: This document applies to the HEAD of the source +tree only. If you are using a released version of Kubernetes, you almost +certainly want the docs that go with that version.

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + + # Working with Resources *This document is aimed at users who have worked through some of the examples, diff --git a/hack/lib/util.sh b/hack/lib/util.sh index f652ef7aee0..5e542d99c1a 100644 --- a/hack/lib/util.sh +++ b/hack/lib/util.sh @@ -143,11 +143,19 @@ kube::util::gen-doc() { link=$(kube::util::analytics-link "${path}") echo -e "\n${link}" >> "${tmpdir}/${file}" fi - # remove all old generated files from the destination - if [[ -e "${tmpdir}/${file}" && -n "${skipprefix}" ]]; then + # Remove all old generated files from the destination + if [[ -e "${tmpdir}/${file}" ]]; then local original generated - original=$(grep -v "^${skipprefix}" "${dest}/${file}") || : - generated=$(grep -v "^${skipprefix}" "${tmpdir}/${file}") || : + # Filter all munges from original content. + original=$(cat "${dest}/${file}" | sed '/^