Skip to content

Latest commit

 

History

History
99 lines (80 loc) · 4.27 KB

working-with-resources.md

File metadata and controls

99 lines (80 loc) · 4.27 KB
Raw

WARNING WARNING WARNING WARNING WARNING

PLEASE NOTE: This document applies to the HEAD of the source tree

If you are using a released version of Kubernetes, you should refer to the docs that go with that version.

The latest 1.0.x release of this document can be found [here](http://releases.k8s.io/release-1.0/docs/user-guide/working-with-resources.md).

Documentation for other releases can be found at releases.k8s.io.

Working with Resources

This document is aimed at users who have worked through some of the examples, 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, and developers who want to extend the Kubernetes API should refer to the api conventions and the api document.

Resources are Automatically Modified

When you create a resource such as pod, and then retrieve the created resource, a number of the fields of the resource are added. You can see this at work in the following example:

$ cat > /tmp/original.yaml <<EOF
apiVersion: v1
kind: Pod
metadata:
  name: foo
spec:
  containers:
    - name: foo
      image: busybox
  restartPolicy: Never
EOF
$ kubectl create -f /tmp/original.yaml
pods/original
$ kubectl get pods/original -o yaml > /tmp/current.yaml
pods/original
$ wc -l /tmp/original.yaml /tmp/current.yaml
      51 /tmp/current.yaml
       9 /tmp/original.yaml
      60 total

The resource we posted had only 9 lines, but the one we got back had 51 lines. If you diff -u /tmp/original.yaml /tmp/current.yaml, you can see the fields added to the pod. The system adds fields in several ways:

  • 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).
    • 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 and 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).
    • 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. The API will generally not modify fields that you have set; it just sets ones which were unspecified.

Finding Documentation on Resource Fields

You can browse auto-generated API documentation at the project website or directly from your cluster, like this:

  • Run kubectl proxy --api-prefix=/
  • Go to http://localhost:8001/swagger-ui in your browser.
  • It should say "swagger" at the top-left.

Once there:

  • Click on "v1" and wait for it to expand.
  • Search for "pods", "services", "replicationcontrollers" or some other resource.
  • Click on that POST row for the matching resource.
  • Click on the words "Model".
  • You should see a list of all possible resource fields, starting with v1.pods {...}

Analytics