Files

Tim Hockin ad8f8731b6 Use a common set of tag prefixes for munges

All munges now start with `<!-- BEGIN MUNGE:` and end with `<!-- END MUNGE:`.
This lets me (in a followup) filter them better to normalize contents during
verification of generated docs.

2015-07-13 11:23:07 -07:00

design

Merge pull request #11145 from marekbiskup/kubectl-rolling-update-doc-fix

2015-07-13 09:47:19 -07:00

devel

Merge pull request #11122 from zmerlynn/multi-pick

2015-07-13 10:17:14 -07:00

getting-started-guides

Merge pull request #11149 from epc/epc-2015194

2015-07-13 09:45:51 -07:00

high-availability

make some manifests in docs/high-availability v1

2015-07-13 09:58:22 -07:00

man/man1

Fix a small typo.

2015-07-13 09:38:40 -07:00

proposals

Copy edits for typos

2015-07-12 22:03:06 -04:00

user-guide

Delete the dreaded CR character.

2015-07-13 10:28:04 -07:00

.files_generated

add "kubectl patch". It will replace "kubectl udpate --patch" in the future

2015-06-29 16:36:45 -07:00

accessing_the_api.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

accessing-the-cluster.md

manual fixes

2015-07-10 10:54:47 -07:00

admission_controllers.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

annotations.md

add blank line before list

2015-06-01 22:35:59 +02:00

api-conventions.md

Copy edits to remove doubled words

2015-07-13 10:11:55 -04:00

api.md

Add user-oriented compute resource doc.

2015-07-06 14:57:30 -07:00

application-troubleshooting.md

Copy edits for typos

2015-07-12 22:03:06 -04:00

architecture.dia

Update architecture diagrams.

2015-03-13 17:16:39 -07:00

architecture.png

Fix architecture diagram

2015-03-15 00:56:31 -07:00

architecture.svg

Update architecture diagrams.

2015-03-13 17:16:39 -07:00

authentication.md

Add ga-beacon analytics to gendocs scripts

2015-05-15 18:56:38 -07:00

authorization.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

availability.md

Copy edits to remove doubled words

2015-07-13 10:11:55 -04:00

cadvisor.png

Add monitoring docs

2015-07-10 09:57:06 -07:00

cli-roadmap.md

rename run-container to run in kubectl

2015-05-27 19:07:17 +02:00

client-libraries.md

Add a pointer to a new java library.

2015-07-07 20:14:36 -07:00

cluster_management.md

Add command "kubectl replace". "kubectl update" is still supported as an alias.

2015-06-29 12:14:24 -07:00

cluster-admin-guide.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

cluster-troubleshooting.md

Add some trouble shooting instructions.

2015-06-09 20:46:09 -07:00

compute_resources.md

Copy edits for typos

2015-07-12 22:03:06 -04:00

container-environment.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

containers.md

Add ga-beacon analytics to gendocs scripts

2015-05-15 18:56:38 -07:00

developer-guide.md

Add ga-beacon analytics to gendocs scripts

2015-05-15 18:56:38 -07:00

dns.md

Update dns.md

2015-07-13 01:26:25 -04:00

downward_api.md

Copy edits for typos

2015-07-12 22:03:06 -04:00

gcm.png

Add monitoring docs

2015-07-10 09:57:06 -07:00

glossary.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

high-availability.md

make some manifests in docs/high-availability v1

2015-07-13 09:58:22 -07:00

identifiers.md

Copy edits for spelling errors and typos

2015-06-12 18:47:28 -04:00

images.md

Merge pull request #10431 from erictune/image_md

2015-07-01 19:33:03 -07:00

influx.png

Add monitoring docs

2015-07-10 09:57:06 -07:00

k8s-ui-explore-filter.png

Update UI doc for the usage of Kubernetes UI

2015-07-07 18:19:34 -07:00

k8s-ui-explore-groupby.png

Update UI doc for the usage of Kubernetes UI

2015-07-07 18:19:34 -07:00

k8s-ui-explore-poddetail.png

Update UI doc for the usage of Kubernetes UI

2015-07-07 18:19:34 -07:00

k8s-ui-explore.png

Update UI doc for the usage of Kubernetes UI

2015-07-07 18:19:34 -07:00

k8s-ui-nodes.png

Update UI doc for the usage of Kubernetes UI

2015-07-07 18:19:34 -07:00

k8s-ui-overview.png

Update UI doc for the usage of Kubernetes UI

2015-07-07 18:19:34 -07:00

kibana.png

Launch Elasticsearch and Kibana automatically

2015-01-09 13:41:46 -08:00

kube-apiserver.md

breakout doc changes from #10594 to get them into v1

2015-07-06 11:25:47 -07:00

kube-controller-manager.md

Copy edits for typos

2015-07-12 22:03:06 -04:00

kube-proxy.md

breakout doc changes from #10594 to get them into v1

2015-07-06 11:25:47 -07:00

kube-scheduler.md

breakout doc changes from #10594 to get them into v1

2015-07-06 11:25:47 -07:00

kubeconfig-file.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

kubectl_api-versions.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_cluster-info.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_config_set-cluster.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_config_set-context.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_config_set-credentials.md

Fixes kubectl config set-credentials examples

2015-06-22 17:34:04 -03:00

kubectl_config_set.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_config_unset.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_config_use-context.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_config_view.md

Implement 'kubectl get ... -o wide'

2015-06-30 14:06:47 -07:00

kubectl_config.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_create.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_delete.md

Using NAME to replace ID in help string

2015-07-01 15:35:08 +08:00

kubectl_describe.md

Update kubectl describe help to document prefix matching behavior

2015-07-07 16:57:37 -07:00

kubectl_exec.md

Fixing spacing in documentation comments

2015-06-24 13:50:30 -07:00

kubectl_expose.md

Implement 'kubectl get ... -o wide'

2015-06-30 14:06:47 -07:00

kubectl_get.md

Implement 'kubectl get ... -o wide'

2015-06-30 14:06:47 -07:00

kubectl_label.md

Implement 'kubectl get ... -o wide'

2015-06-30 14:06:47 -07:00

kubectl_logs.md

Enable -c for kubectl logs container arg

2015-06-30 13:25:54 -07:00

kubectl_namespace.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_patch.md

Fix a small typo.

2015-07-13 09:38:40 -07:00

kubectl_port-forward.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl_proxy.md

Make UI work through kubectl proxy (again)

2015-06-24 13:54:14 -07:00

kubectl_replace.md

Add command "kubectl replace". "kubectl update" is still supported as an alias.

2015-06-29 12:14:24 -07:00

kubectl_rolling-update.md

Implement 'kubectl get ... -o wide'

2015-06-30 14:06:47 -07:00

kubectl_run.md

Implement 'kubectl get ... -o wide'

2015-06-30 14:06:47 -07:00

kubectl_scale.md

Using NAME to replace ID in help string

2015-07-01 15:35:08 +08:00

kubectl_stop.md

Using NAME to replace ID in help string

2015-07-01 15:35:08 +08:00

kubectl_version.md

Warn for every _ flag user or cmd defined

2015-05-27 11:23:52 +02:00

kubectl.md

Update kubectl describe help to document prefix matching behavior

2015-07-07 16:57:37 -07:00

kubelet.md

Fix kubelet.md with --max-pods

2015-07-10 16:58:07 -07:00

labels.md

Add some additional clarity to label prefix requirements.

2015-07-07 20:45:22 -07:00

logging.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

monitoring-architecture.png

Add monitoring docs

2015-07-10 09:57:06 -07:00

monitoring.md

Add monitoring docs

2015-07-10 09:57:06 -07:00

namespaces.md

Add ga-beacon analytics to gendocs scripts

2015-05-15 18:56:38 -07:00

networking.md

Use a common set of tag prefixes for munges

2015-07-13 11:23:07 -07:00

node.md

Update CLI flags in node overview doc

2015-07-08 10:59:03 -04:00

overview.md

clarification of name uniqueness

2015-06-16 17:19:37 +02:00

ovs-networking.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

ovs-networking.png

ovs networking document

2014-09-08 17:06:25 -07:00

persistent-volumes.md

Copy edits to remove doubled words

2015-07-13 10:11:55 -04:00

pod-states.md

small corrections to pod-states doc

2015-06-16 19:22:30 +02:00

pods.md

double dash replaced by html mdash

2015-06-17 12:36:27 +02:00

README.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

replication-controller.md

Copy edits to remove doubled words

2015-07-13 10:11:55 -04:00

resource_quota_admin.md

Qualified all references to "controller" so that references to "replication controller" are clear. fixes #9404

2015-06-17 08:48:59 -07:00

roadmap.md

Rename 'portal IP' to 'cluster IP' most everywhere

2015-05-28 16:10:44 -07:00

salt.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

secrets.md

manual fixes

2015-07-10 10:54:47 -07:00

security_context.md

Update document of security context

2015-07-07 13:30:56 -07:00

service_accounts_admin.md

Service account documentation.

2015-06-22 10:42:54 -07:00

service_accounts.md

Copy edits for typos

2015-07-12 22:03:06 -04:00

services_detail.png

Better docs for Services and public IPs.

2015-03-04 22:13:57 -08:00

services_detail.svg

Better docs for Services and public IPs.

2015-03-04 22:13:57 -08:00

services_overview.png

Better docs for Services and public IPs.

2015-03-04 22:13:57 -08:00

services_overview.svg

Better docs for Services and public IPs.

2015-03-04 22:13:57 -08:00

services-firewalls.md

Add messages to indicate that opening an external firewall may be necessary.

2015-06-04 22:31:52 -07:00

services.md

Copy edits to remove doubled words

2015-07-13 10:11:55 -04:00

sharing-clusters.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

troubleshooting.md

Copy edits for typos

2015-07-12 22:03:06 -04:00

ui.md

Add namespace to kubectl create command

2015-07-11 20:02:27 -04:00

user-guide.md

Auto-fixed docs

2015-07-10 10:54:47 -07:00

versioning.md

Add ga-beacon analytics to gendocs scripts

2015-05-15 18:56:38 -07:00

volumes.md

Copy edits to remove doubled words

2015-07-13 10:11:55 -04:00

working_with_resources.md

Added document on using resources.

2015-06-18 10:21:44 -07:00

README.md

Kubernetes Documentation: releases.k8s.io/HEAD

*** PLEASE NOTE: This documentation 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.

Where to start

The User's guide is for anyone who wants to run programs and services on an existing Kubernetes cluster.
The Cluster Admin's guide is for anyone setting up a Kubernetes cluster or administering it.
The Developer guide is for anyone wanting to write programs that access the kubernetes API, write plugins or extensions, or modify the core code of kubernetes.
The Kubectl Command Line Interface is a detailed reference on the kubectl CLI.
The API object documentation is a detailed description of all fields found in core API objects.
An overview of the Design of Kubernetes
There are example files and walkthroughs in the examples folder.