Skip to content

K
k3s
Commit 8d5eb03c authored by David Oppenheimer's avatar David Oppenheimer
Browse files
Options

Move some docs from docs/ top-level into docs/{admin/,devel/,user-guide/}.

parent cdc74dde
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 46 additions and 46 deletions
docs/README.md
View file @ 8d5eb03c
...@@ -28,7 +28,7 @@ certainly want the docs that go with that version.</h1> ...@@ -28,7 +28,7 @@ certainly want the docs that go with that version.</h1>
* The [Cluster Admin's guide](admin/README.md) is for anyone setting up * The [Cluster Admin's guide](admin/README.md) is for anyone setting up
a Kubernetes cluster or administering it. a Kubernetes cluster or administering it.
* The [Developer guide](developer-guide.md) is for anyone wanting to write * The [Developer guide](devel/developer-guide.md) is for anyone wanting to write
programs that access the kubernetes API, write plugins or extensions, or programs that access the kubernetes API, write plugins or extensions, or
modify the core code of kubernetes. modify the core code of kubernetes.
......
docs/admin/admission-controllers.md
View file @ 8d5eb03c
...@@ -89,7 +89,7 @@ commands in those containers, we strongly encourage enabling this plug-in. ...@@ -89,7 +89,7 @@ commands in those containers, we strongly encourage enabling this plug-in.
### ServiceAccount ### ServiceAccount
This plug-in implements automation for [serviceAccounts](../service-accounts.md). This plug-in implements automation for [serviceAccounts](../user-guide/service-accounts.md).
We strongly recommend using this plug-in if you intend to make use of Kubernetes ```ServiceAccount``` objects. We strongly recommend using this plug-in if you intend to make use of Kubernetes ```ServiceAccount``` objects.
### SecurityContextDeny ### SecurityContextDeny
......
docs/cluster-large.md → docs/admin/cluster-large.md
View file @ 8d5eb03c
...@@ -66,19 +66,19 @@ These limits, however, are based on data collected from addons running on 4-node ...@@ -66,19 +66,19 @@ These limits, however, are based on data collected from addons running on 4-node
To avoid running into cluster addon resource issues, when creating a cluster with many nodes, consider the following: To avoid running into cluster addon resource issues, when creating a cluster with many nodes, consider the following:
* Scale memory and CPU limits for each of the following addons, if used, along with the size of cluster (there is one replica of each handling the entire cluster so memory and CPU usage tends to grow proportionally with size/load on cluster): * Scale memory and CPU limits for each of the following addons, if used, along with the size of cluster (there is one replica of each handling the entire cluster so memory and CPU usage tends to grow proportionally with size/load on cluster):
* Heapster ([GCM/GCL backed](../cluster/addons/cluster-monitoring/google/heapster-controller.yaml), [InfluxDB backed](../cluster/addons/cluster-monitoring/influxdb/heapster-controller.yaml), [InfluxDB/GCL backed](../cluster/addons/cluster-monitoring/googleinfluxdb/heapster-controller-combined.yaml), [standalone](../cluster/addons/cluster-monitoring/standalone/heapster-controller.yaml)) * Heapster ([GCM/GCL backed](../../cluster/addons/cluster-monitoring/google/heapster-controller.yaml), [InfluxDB backed](../../cluster/addons/cluster-monitoring/influxdb/heapster-controller.yaml), [InfluxDB/GCL backed](../../cluster/addons/cluster-monitoring/googleinfluxdb/heapster-controller-combined.yaml), [standalone](../../cluster/addons/cluster-monitoring/standalone/heapster-controller.yaml))
* [InfluxDB and Grafana](../cluster/addons/cluster-monitoring/influxdb/influxdb-grafana-controller.yaml) * [InfluxDB and Grafana](../../cluster/addons/cluster-monitoring/influxdb/influxdb-grafana-controller.yaml)
* [skydns, kube2sky, and dns etcd](../cluster/addons/dns/skydns-rc.yaml.in) * [skydns, kube2sky, and dns etcd](../../cluster/addons/dns/skydns-rc.yaml.in)
* [Kibana](../cluster/addons/fluentd-elasticsearch/kibana-controller.yaml) * [Kibana](../../cluster/addons/fluentd-elasticsearch/kibana-controller.yaml)
* Scale number of replicas for the following addons, if used, along with the size of cluster (there are multiple replicas of each so increasing replicas should help handle increased load, but, since load per replica also increases slightly, also consider increasing CPU/memory limits): * Scale number of replicas for the following addons, if used, along with the size of cluster (there are multiple replicas of each so increasing replicas should help handle increased load, but, since load per replica also increases slightly, also consider increasing CPU/memory limits):
* [elasticsearch](../cluster/addons/fluentd-elasticsearch/es-controller.yaml) * [elasticsearch](../../cluster/addons/fluentd-elasticsearch/es-controller.yaml)
* Increase memory and CPU limits sligthly for each of the following addons, if used, along with the size of cluster (there is one replica per node but CPU/memory usage increases slightly along with cluster load/size as well): * Increase memory and CPU limits sligthly for each of the following addons, if used, along with the size of cluster (there is one replica per node but CPU/memory usage increases slightly along with cluster load/size as well):
* [FluentD with ElasticSearch Plugin](../cluster/saltbase/salt/fluentd-es/fluentd-es.yaml) * [FluentD with ElasticSearch Plugin](../../cluster/saltbase/salt/fluentd-es/fluentd-es.yaml)
* [FluentD with GCP Plugin](../cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml) * [FluentD with GCP Plugin](../../cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml)
For directions on how to detect if addon containers are hitting resource limits, see the [Troubleshooting section of Compute Resources](user-guide/compute-resources.md#troubleshooting). For directions on how to detect if addon containers are hitting resource limits, see the [Troubleshooting section of Compute Resources](../user-guide/compute-resources.md#troubleshooting).
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/cluster-large.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/cluster-large.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS --> <!-- END MUNGE: GENERATED_ANALYTICS -->
docs/cluster-troubleshooting.md → docs/admin/cluster-troubleshooting.md
View file @ 8d5eb03c
...@@ -22,7 +22,7 @@ certainly want the docs that go with that version.</h1> ...@@ -22,7 +22,7 @@ certainly want the docs that go with that version.</h1>
<!-- END MUNGE: UNVERSIONED_WARNING --> <!-- END MUNGE: UNVERSIONED_WARNING -->
# Cluster Troubleshooting # Cluster Troubleshooting
Most of the time, if you encounter problems, it is your application that is having problems. For application 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](user-guide/application-troubleshooting.md). problems please see the [application troubleshooting guide](../user-guide/application-troubleshooting.md).
## Listing your cluster ## Listing your cluster
The first thing to debug in your cluster is if your nodes are all registered correctly. The first thing to debug in your cluster is if your nodes are all registered correctly.
...@@ -49,5 +49,5 @@ of the relevant log files. (note that on systemd based systems, you may need to ...@@ -49,5 +49,5 @@ of the relevant log files. (note that on systemd based systems, you may need to
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/cluster-troubleshooting.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/cluster-troubleshooting.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS --> <!-- END MUNGE: GENERATED_ANALYTICS -->
docs/high-availability.md → docs/admin/high-availability.md
View file @ 8d5eb03c
...@@ -240,5 +240,5 @@ It implements the major concepts (with a few minor reductions for simplicity), o ...@@ -240,5 +240,5 @@ It implements the major concepts (with a few minor reductions for simplicity), o
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/high-availability.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/high-availability.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS --> <!-- END MUNGE: GENERATED_ANALYTICS -->
docs/admin/service-accounts-admin.md
View file @ 8d5eb03c
...@@ -23,7 +23,7 @@ certainly want the docs that go with that version.</h1> ...@@ -23,7 +23,7 @@ certainly want the docs that go with that version.</h1>
# Cluster Admin Guide to Service Accounts # Cluster Admin Guide to Service Accounts
*This is a Cluster Administrator guide to service accounts. It assumes knowledge of *This is a Cluster Administrator guide to service accounts. It assumes knowledge of
the [User Guide to Service Accounts](../service-accounts.md).* the [User Guide to Service Accounts](../user-guide/service-accounts.md).*
*Support for authorization and user accounts is planned but incomplete. Sometimes *Support for authorization and user accounts is planned but incomplete. Sometimes
incomplete features are referred to in order to better describe service accounts.* incomplete features are referred to in order to better describe service accounts.*
......
docs/api.md
View file @ 8d5eb03c
...@@ -24,7 +24,7 @@ certainly want the docs that go with that version.</h1> ...@@ -24,7 +24,7 @@ certainly want the docs that go with that version.</h1>
Primary system and API concepts are documented in the [User guide](user-guide/README.md). Primary system and API concepts are documented in the [User guide](user-guide/README.md).
Overall API conventions are described in the [API conventions doc](api-conventions.md). Overall API conventions are described in the [API conventions doc](devel/api-conventions.md).
Complete API details are documented via [Swagger](http://swagger.io/). The Kubernetes apiserver (aka "master") exports an API that can be used to retrieve the [Swagger spec](https://github.com/swagger-api/swagger-spec/tree/master/schemas/v1.2) for the Kubernetes API, by default at `/swaggerapi`, and a UI you can use to browse the API documentation at `/swagger-ui`. We also periodically update a [statically generated UI](http://kubernetes.io/third_party/swagger-ui/). Complete API details are documented via [Swagger](http://swagger.io/). The Kubernetes apiserver (aka "master") exports an API that can be used to retrieve the [Swagger spec](https://github.com/swagger-api/swagger-spec/tree/master/schemas/v1.2) for the Kubernetes API, by default at `/swaggerapi`, and a UI you can use to browse the API documentation at `/swagger-ui`. We also periodically update a [statically generated UI](http://kubernetes.io/third_party/swagger-ui/).
......
docs/design/principles.md
View file @ 8d5eb03c
...@@ -26,7 +26,7 @@ Principles to follow when extending Kubernetes. ...@@ -26,7 +26,7 @@ Principles to follow when extending Kubernetes.
## API ## API
See also the [API conventions](../api-conventions.md). See also the [API conventions](../devel/api-conventions.md).
* All APIs should be declarative. * All APIs should be declarative.
* API objects should be complementary and composable, not opaque wrappers. * API objects should be complementary and composable, not opaque wrappers.
......
docs/cli-roadmap.md → docs/devel/cli-roadmap.md
View file @ 8d5eb03c
...@@ -101,5 +101,5 @@ Server-side support: ...@@ -101,5 +101,5 @@ Server-side support:
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/cli-roadmap.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/devel/cli-roadmap.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS --> <!-- END MUNGE: GENERATED_ANALYTICS -->
docs/client-libraries.md → docs/devel/client-libraries.md
View file @ 8d5eb03c
...@@ -39,5 +39,5 @@ certainly want the docs that go with that version.</h1> ...@@ -39,5 +39,5 @@ certainly want the docs that go with that version.</h1>
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/client-libraries.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/devel/client-libraries.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS --> <!-- END MUNGE: GENERATED_ANALYTICS -->
docs/developer-guide.md → docs/devel/developer-guide.md
View file @ 8d5eb03c
...@@ -24,15 +24,15 @@ certainly want the docs that go with that version.</h1> ...@@ -24,15 +24,15 @@ certainly want the docs that go with that version.</h1>
The developer guide is for anyone wanting to either write code which directly accesses the The developer guide is for anyone wanting to either write code which directly accesses the
kubernetes API, or to contribute directly to the kubernetes project. kubernetes API, or to contribute directly to the kubernetes project.
It assumes some familiarity with concepts in the [User Guide](user-guide/README.md) and the [Cluster Admin It assumes some familiarity with concepts in the [User Guide](../user-guide/README.md) and the [Cluster Admin
Guide](admin/README.md). Guide](../admin/README.md).
## Developing against the Kubernetes API ## Developing against the Kubernetes API
* API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/). * API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).
* **Annotations** ([user-guide/annotations.md](user-guide/annotations.md)): are for attaching arbitrary non-identifying metadata to objects. * **Annotations** ([docs/user-guide/annotations.md](../user-guide/annotations.md)): are for attaching arbitrary non-identifying metadata to objects.
Programs that automate Kubernetes objects may use annotations to store small amounts of their state. Programs that automate Kubernetes objects may use annotations to store small amounts of their state.
* **API Conventions** ([api-conventions.md](api-conventions.md)): * **API Conventions** ([api-conventions.md](api-conventions.md)):
...@@ -43,20 +43,20 @@ Guide](admin/README.md). ...@@ -43,20 +43,20 @@ Guide](admin/README.md).
## Writing Plugins ## Writing Plugins
* **Authentication Plugins** ([admin/authentication.md](admin/authentication.md)): * **Authentication Plugins** ([docs/admin/authentication.md](../admin/authentication.md)):
The current and planned states of authentication tokens. The current and planned states of authentication tokens.
* **Authorization Plugins** ([admin/authorization.md](admin/authorization.md)): * **Authorization Plugins** ([docs/admin/authorization.md](../admin/authorization.md)):
Authorization applies to all HTTP requests on the main apiserver port. Authorization applies to all HTTP requests on the main apiserver port.
This doc explains the available authorization implementations. This doc explains the available authorization implementations.
* **Admission Control Plugins** ([admission_control](design/admission_control.md)) * **Admission Control Plugins** ([admission_control](../design/admission_control.md))
## Contributing to the Kubernetes Project ## Contributing to the Kubernetes Project
See this [README](devel/README.md). See this [README](README.md).
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/developer-guide.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/devel/developer-guide.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS --> <!-- END MUNGE: GENERATED_ANALYTICS -->
docs/troubleshooting.md
View file @ 8d5eb03c
...@@ -23,7 +23,7 @@ certainly want the docs that go with that version.</h1> ...@@ -23,7 +23,7 @@ certainly want the docs that go with that version.</h1>
# Troubleshooting # Troubleshooting
Sometimes things go wrong. This guide is aimed at making them right. It has two sections: Sometimes things go wrong. This guide is aimed at making them right. It has two sections:
* [Troubleshooting your application](user-guide/application-troubleshooting.md) - Useful for users who are deploying code into Kubernetes and wondering why it is not working. * [Troubleshooting your application](user-guide/application-troubleshooting.md) - Useful for users who are deploying code into Kubernetes and wondering why it is not working.
* [Troubleshooting your cluster](cluster-troubleshooting.md) - Useful for cluster administrators and people whose Kubernetes cluster is unhappy. * [Troubleshooting your cluster](admin/cluster-troubleshooting.md) - Useful for cluster administrators and people whose Kubernetes cluster is unhappy.
# Getting help # Getting help
If your problem isn't answered by any of guides above, there are variety of ways for you to get help from the Kubernetes team. If your problem isn't answered by any of guides above, there are variety of ways for you to get help from the Kubernetes team.
......
docs/user-guide/README.md
View file @ 8d5eb03c
...@@ -32,7 +32,7 @@ certainly want the docs that go with that version.</h1> ...@@ -32,7 +32,7 @@ certainly want the docs that go with that version.</h1>
<!-- END MUNGE: GENERATED_TOC --> <!-- END MUNGE: GENERATED_TOC -->
The user guide is intended for anyone who wants to run programs and services on an existing Kubernetes cluster. Setup and administration of a Kubernetes cluster is described in the [Cluster Admin Guide](../../docs/admin/README.md). The [Developer Guide](../../docs/developer-guide.md) is for anyone wanting to either write code which directly accesses the kubernetes API, or to contribute directly to the kubernetes project. The user guide is intended for anyone who wants to run programs and services on an existing Kubernetes cluster. Setup and administration of a Kubernetes cluster is described in the [Cluster Admin Guide](../../docs/admin/README.md). The [Developer Guide](../../docs/devel/developer-guide.md) is for anyone wanting to either write code which directly accesses the kubernetes API, or to contribute directly to the kubernetes project.
Please ensure you have completed the [prerequisites for running examples from the user guide](prereqs.md). Please ensure you have completed the [prerequisites for running examples from the user guide](prereqs.md).
......
docs/user-guide/accessing-the-cluster.md
View file @ 8d5eb03c
...@@ -124,7 +124,7 @@ with future high-availability support. ...@@ -124,7 +124,7 @@ with future high-availability support.
### Programmatic access to the API ### Programmatic access to the API
There are [client libraries](../client-libraries.md) for accessing the API There are [client libraries](../devel/client-libraries.md) for accessing the API
from several languages. The Kubernetes project-supported from several languages. The Kubernetes project-supported
[Go](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/pkg/client) [Go](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/pkg/client)
client library can use the same [kubeconfig file](kubeconfig-file.md) client library can use the same [kubeconfig file](kubeconfig-file.md)
...@@ -142,7 +142,7 @@ the `kubernetes` DNS name, which resolves to a Service IP which in turn ...@@ -142,7 +142,7 @@ the `kubernetes` DNS name, which resolves to a Service IP which in turn
will be routed to an apiserver. will be routed to an apiserver.
The recommended way to authenticate to the apiserver is with a The recommended way to authenticate to the apiserver is with a
[service account](../service-accounts.md) credential. By default, a pod [service account](service-accounts.md) credential. By default, a pod
is associated with a service account, and a credential (token) for that is associated with a service account, and a credential (token) for that
service account is placed into the filesystem tree of each container in that pod, service account is placed into the filesystem tree of each container in that pod,
at `/var/run/secrets/kubernetes.io/serviceaccount/token`. at `/var/run/secrets/kubernetes.io/serviceaccount/token`.
......
docs/user-guide/application-troubleshooting.md
View file @ 8d5eb03c
...@@ -24,7 +24,7 @@ certainly want the docs that go with that version.</h1> ...@@ -24,7 +24,7 @@ certainly want the docs that go with that version.</h1>
This guide is to help users debug applications that are deployed into Kubernetes and not behaving correctly. This guide is to help users debug applications that are deployed into Kubernetes and not behaving correctly.
This is *not* a guide for people who want to debug their cluster. For that you should check out This is *not* a guide for people who want to debug their cluster. For that you should check out
[this guide](../cluster-troubleshooting.md) [this guide](../admin/cluster-troubleshooting.md)
**Table of Contents** **Table of Contents**
<!-- BEGIN MUNGE: GENERATED_TOC --> <!-- BEGIN MUNGE: GENERATED_TOC -->
......
docs/user-guide/images.md
View file @ 8d5eb03c
...@@ -223,7 +223,7 @@ spec: ...@@ -223,7 +223,7 @@ spec:
``` ```
This needs to be done for each pod that is using a private registry. This needs to be done for each pod that is using a private registry.
However, setting of this field can be automated by setting the imagePullSecrets However, setting of this field can be automated by setting the imagePullSecrets
in a [serviceAccount](../service-accounts.md) resource. in a [serviceAccount](service-accounts.md) resource.
Currently, all pods will potentially have read access to any images which were Currently, all pods will potentially have read access to any images which were
pulled using imagePullSecrets. That is, imagePullSecrets does *NOT* protect your pulled using imagePullSecrets. That is, imagePullSecrets does *NOT* protect your
......
docs/user-guide/pod-states.md
View file @ 8d5eb03c
...@@ -28,7 +28,7 @@ This document covers the lifecycle of a pod. It is not an exhaustive document, ...@@ -28,7 +28,7 @@ This document covers the lifecycle of a pod. It is not an exhaustive document,
## Pod Phase ## Pod Phase
As consistent with the overall [API convention](../api-conventions.md#typical-status-properties), phase is a simple, high-level summary of the phase of the lifecycle of a pod. It is not intended to be a comprehensive rollup of observations of container-level or even pod-level conditions or other state, nor is it intended to be a comprehensive state machine. As consistent with the overall [API convention](../devel/api-conventions.md#typical-status-properties), phase is a simple, high-level summary of the phase of the lifecycle of a pod. It is not intended to be a comprehensive rollup of observations of container-level or even pod-level conditions or other state, nor is it intended to be a comprehensive state machine.
The number and meanings of `PodPhase` values are tightly guarded. Other than what is documented here, nothing should be assumed about pods with a given `PodPhase`. The number and meanings of `PodPhase` values are tightly guarded. Other than what is documented here, nothing should be assumed about pods with a given `PodPhase`.
......
docs/user-guide/secrets.md
View file @ 8d5eb03c
...@@ -74,7 +74,7 @@ The automatic creation and use of API credentials can be disabled or overridden ...@@ -74,7 +74,7 @@ The automatic creation and use of API credentials can be disabled or overridden
if desired. However, if all you need to do is securely access the apiserver, if desired. However, if all you need to do is securely access the apiserver,
this is the recommended workflow. this is the recommended workflow.
See the [Service Account](../service-accounts.md) documentation for more See the [Service Account](service-accounts.md) documentation for more
information on how Service Accounts work. information on how Service Accounts work.
### Creating a Secret Manually ### Creating a Secret Manually
...@@ -100,7 +100,7 @@ are `value-1` and `value-2`, respectively, with carriage return and newline char ...@@ -100,7 +100,7 @@ are `value-1` and `value-2`, respectively, with carriage return and newline char
Create the secret using [`kubectl create`](kubectl/kubectl_create.md). Create the secret using [`kubectl create`](kubectl/kubectl_create.md).
Once the secret is created, you can: Once the secret is created, you can:
- create pods that automatically use it via a [Service Account](../service-accounts.md). - create pods that automatically use it via a [Service Account](service-accounts.md).
- modify your pod specification to use the secret - modify your pod specification to use the secret
### Manually specifying a Secret to be Mounted on a Pod ### Manually specifying a Secret to be Mounted on a Pod
...@@ -149,7 +149,7 @@ Use of imagePullSecrets is desribed in the [images documentation](images.md#spec ...@@ -149,7 +149,7 @@ Use of imagePullSecrets is desribed in the [images documentation](images.md#spec
*This feature is planned but not implemented. See [issue *This feature is planned but not implemented. See [issue
9902](https://github.com/GoogleCloudPlatform/kubernetes/issues/9902).* 9902](https://github.com/GoogleCloudPlatform/kubernetes/issues/9902).*
You can reference manually created secrets from a [service account](../service-accounts.md). You can reference manually created secrets from a [service account](service-accounts.md).
Then, pods which use that service account will have Then, pods which use that service account will have
`volumeMounts` and/or `imagePullSecrets` added to them. `volumeMounts` and/or `imagePullSecrets` added to them.
The secrets will be mounted at **TBD**. The secrets will be mounted at **TBD**.
...@@ -217,7 +217,7 @@ the original pod must be deleted, and a new pod (perhaps with an identical ...@@ -217,7 +217,7 @@ the original pod must be deleted, and a new pod (perhaps with an identical
workflow as deploying a new container image. The `kubectl rolling-update` workflow as deploying a new container image. The `kubectl rolling-update`
command can be used ([man page](kubectl/kubectl_rolling-update.md)). command can be used ([man page](kubectl/kubectl_rolling-update.md)).
The [`resourceVersion`](../api-conventions.md#concurrency-control-and-consistency) The [`resourceVersion`](../devel/api-conventions.md#concurrency-control-and-consistency)
of the secret is not specified when it is referenced. of the secret is not specified when it is referenced.
Therefore, if a secret is updated at about the same time as pods are starting, Therefore, if a secret is updated at about the same time as pods are starting,
then it is not defined which version of the secret will be used for the pod. It then it is not defined which version of the secret will be used for the pod. It
......
docs/service-accounts.md → docs/user-guide/service-accounts.md
View file @ 8d5eb03c
...@@ -25,7 +25,7 @@ certainly want the docs that go with that version.</h1> ...@@ -25,7 +25,7 @@ certainly want the docs that go with that version.</h1>
A service account provides an identity for processes that run in a Pod. A service account provides an identity for processes that run in a Pod.
*This is a user introduction to Service Accounts. See also the *This is a user introduction to Service Accounts. See also the
[Cluster Admin Guide to Service Accounts](admin/service-accounts-admin.md).* [Cluster Admin Guide to Service Accounts](../admin/service-accounts-admin.md).*
*Note: This document describes how service accounts behave in a cluster set up *Note: This document describes how service accounts behave in a cluster set up
as recommended by the Kubernetes project. Your cluster administrator may have as recommended by the Kubernetes project. Your cluster administrator may have
...@@ -45,10 +45,10 @@ When you create a pod, you do not need to specify a service account. It is ...@@ -45,10 +45,10 @@ When you create a pod, you do not need to specify a service account. It is
automatically assigned the `default` service account of the same namespace. If automatically assigned the `default` service account of the same namespace. If
you get the raw json or yaml for a pod you have created (e.g. `kubectl get you get the raw json or yaml for a pod you have created (e.g. `kubectl get
pods/podname -o yaml`), you can see the `spec.serviceAccount` field has been pods/podname -o yaml`), you can see the `spec.serviceAccount` field has been
[automatically set](user-guide/working-with-resources.md#resources-are-automatically-modified). [automatically set](working-with-resources.md#resources-are-automatically-modified).
You can access the API using a proxy or with a client library, as described in You can access the API using a proxy or with a client library, as described in
[Accessing the Cluster](user-guide/accessing-the-cluster.md#accessing-the-api-from-a-pod). [Accessing the Cluster](accessing-the-cluster.md#accessing-the-api-from-a-pod).
## Using Multiple Service Accounts ## Using Multiple Service Accounts
...@@ -113,5 +113,5 @@ TODO explain: ...@@ -113,5 +113,5 @@ TODO explain:
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/service-accounts.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/service-accounts.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS --> <!-- END MUNGE: GENERATED_ANALYTICS -->
docs/user-guide/working-with-resources.md
View file @ 8d5eb03c
...@@ -26,7 +26,7 @@ certainly want the docs that go with that version.</h1> ...@@ -26,7 +26,7 @@ certainly want the docs that go with that version.</h1>
and who want to learn more about using kubectl to manage resources such and who want to learn more about using kubectl to manage resources such
as pods and services. Users who want to access the REST API directly, as pods and services. Users who want to access the REST API directly,
and developers who want to extend the kubernetes API should and developers who want to extend the kubernetes API should
refer to the [api conventions](../api-conventions.md) and refer to the [api conventions](../devel/api-conventions.md) and
the [api document](../api.md).* the [api document](../api.md).*
## Resources are Automatically Modified ## Resources are Automatically Modified
...@@ -58,9 +58,9 @@ The resource we posted had only 9 lines, but the one we got back had 51 lines. ...@@ -58,9 +58,9 @@ The resource we posted had only 9 lines, but the one we got back had 51 lines.
If you `diff original.yaml current.yaml`, you can see the fields added to the pod. If you `diff original.yaml current.yaml`, you can see the fields added to the pod.
The system adds fields in several ways: The system adds fields in several ways:
- Some fields are added synchronously with creation of the resource and some are set asynchronously. - Some fields are added synchronously with creation of the resource and some are set asynchronously.
- For example: `metadata.uid` is set synchronously. (Read more about [metadata](../api-conventions.md#metadata)). - For example: `metadata.uid` is set synchronously. (Read more about [metadata](../devel/api-conventions.md#metadata)).
- For example, `status.hostIP` is set only after the pod has been scheduled. This often happens fast, but you may notice pods which do not have this set yet. This is called Late Initialization. (Read mode about [status](../api-conventions.md#spec-and-status) and [late initialization](../api-conventions.md#late-initialization) ). - For example, `status.hostIP` is set only after the pod has been scheduled. This often happens fast, but you may notice pods which do not have this set yet. This is called Late Initialization. (Read mode about [status](../devel/api-conventions.md#spec-and-status) and [late initialization](../devel/api-conventions.md#late-initialization) ).
- Some fields are set to default values. Some defaults vary by cluster and some are fixed for the API at a certain version. (Read more about [defaulting](../api-conventions.md#defaulting)). - Some fields are set to default values. Some defaults vary by cluster and some are fixed for the API at a certain version. (Read more about [defaulting](../devel/api-conventions.md#defaulting)).
- For example, `spec.containers.imagePullPolicy` always defaults to `IfNotPresent` in api v1. - For example, `spec.containers.imagePullPolicy` always defaults to `IfNotPresent` in api v1.
- For example, `spec.containers.resources.limits.cpu` may be defaulted to `100m` on some clusters, to some other value on others, and not defaulted at all on others. - For example, `spec.containers.resources.limits.cpu` may be defaulted to `100m` on some clusters, to some other value on others, and not defaulted at all on others.
The API will generally not modify fields that you have set; it just sets ones which were unspecified. The API will generally not modify fields that you have set; it just sets ones which were unspecified.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment