Merge pull request #6531 from ConnorDoyle/rm-oir

Ported OIR tasks to use Extended Resources.
2017-12-12 09:04:10 +08:00
parent 8591c8f5f4 c2a554ff82
commit 2136efb975
6 changed files with 67 additions and 65 deletions
@@ -1,15 +1,15 @@
 ---
-title: Advertise Opaque Integer Resources for a Node
+title: Advertise Extended Resources for a Node
 ---


 {% capture overview %}

-This page shows how to specify opaque integer resources for a Node.
-Opaque integer resources allow cluster administrators to advertise node-level
+This page shows how to specify extended resources for a Node.
+Extended resources allow cluster administrators to advertise node-level
 resources that would otherwise be unknown to Kubernetes.

-{% include feature-state-deprecated.md %}
+{% include feature-state-stable.md %}

 {% endcapture %}

@@ -31,9 +31,9 @@ kubectl get nodes

 Choose one of your Nodes to use for this exercise.

-## Advertise a new opaque integer resource on one of your Nodes
+## Advertise a new extended resource on one of your Nodes

-To advertise a new opaque integer resource on a Node, send an HTTP PATCH request to
+To advertise a new extended resource on a Node, send an HTTP PATCH request to
 the Kubernetes API server. For example, suppose one of your Nodes has four dongles
 attached. Here's an example of a PATCH request that advertises four dongle resources
 for your Node.
@@ -47,7 +47,7 @@ Host: k8s-master:8080
 [
  {
    "op": "add",
-    "path": "/status/capacity/pod.alpha.kubernetes.io~1opaque-int-resource-dongle",
+    "path": "/status/capacity/example.com~1dongle",
    "value": "4"
  }
 ]
@@ -69,7 +69,7 @@ Replace `<your-node-name>` with the name of your Node:
 ```shell
 curl --header "Content-Type: application/json-patch+json" \
 --request PATCH \
--data '[{"op": "add", "path": "/status/capacity/pod.alpha.kubernetes.io~1opaque-int-resource-dongle", "value": "4"}]' \
+--data '[{"op": "add", "path": "/status/capacity/example.com~1dongle", "value": "4"}]' \
 http://localhost:8001/api/v1/nodes/<your-node-name>/status
 ```

@@ -85,7 +85,7 @@ The output shows that the Node has a capacity of 4 dongles:
  "alpha.kubernetes.io/nvidia-gpu": "0",
  "cpu": "2",
  "memory": "2049008Ki",
-  "pod.alpha.kubernetes.io/opaque-int-resource-dongle": "4",
+  "example.com/dongle": "4",
 ```

 Describe your Node:
@@ -98,53 +98,52 @@ Once again, the output shows the dongle resource:

 ```yaml
 Capacity:
- alpha.kubernetes.io/nvidia-gpu:      0
- cpu:             2
- memory:            2049008Ki
- pod.alpha.kubernetes.io/opaque-int-resource-dongle:  4
+ alpha.kubernetes.io/nvidia-gpu:  0
+ cpu:  2
+ memory:  2049008Ki
+ example.com/dongle:  4
 ```

 Now, application developers can create Pods that request a certain
 number of dongles. See
-[Assign Opaque Integer Resources to a Container](/docs/tasks/configure-pod-container/opaque-integer-resource/).
+[Assign Extended Resources to a Container](/docs/tasks/configure-pod-container/extended-resource/).

 ## Discussion

-Opaque integer resources are similar to memory and CPU resources. For example,
+Extended resources are similar to memory and CPU resources. For example,
 just as  a Node has a certain amount of memory and CPU to be shared by all components
 running on the Node, it can have a certain number of dongles to be shared
 by all components running on the Node. And just as application developers
 can create Pods that request a certain amount of memory and CPU, they can
 create Pods that request a certain number of dongles.

-Opaque integer resources are called opaque because Kubernetes does not
+Extended resources are opaque to Kubernetes; Kubernetes does not
 know anything about what they are. Kubernetes knows only that a Node
-has a certain number of them. They are called integer resources because
-they must be advertised in integer amounts. For example, a Node can advertise
-four dongles, but not 4.5 dongles.
+has a certain number of them. Extended resources must be advertised in integer
+amounts. For example, a Node can advertise four dongles, but not 4.5 dongles.

 ### Storage example

 Suppose a Node has 800 GiB of a special kind of disk storage. You could
-create a name for the special storage, say opaque-int-resource-special-storage.
+create a name for the special storage, say example.com/special-storage.
 Then you could advertise it in chunks of a certain size, say 100 GiB. In that case,
 your Node would advertise that it has eight resources of type
-opaque-int-resource-special-storage.
+example.com/special-storage.

 ```yaml
 Capacity:
 ...
- pod.alpha.kubernetes.io/opaque-int-resource-special-storage:  8
+ example.com/special-storage: 8
 ```

 If you want to allow arbitrary requests for special storage, you
 could advertise special storage in chunks of size 1 byte. In that case, you would advertise
-800Gi resources of type opaque-int-resource-special-storage.
+800Gi resources of type example.com/special-storage.

 ```yaml
 Capacity:
 ...
- pod.alpha.kubernetes.io/opaque-int-resource-special-storage:  800Gi
+ example.com/special-storage:  800Gi
 ```

 Then a Container could request any number of bytes of special storage, up to 800Gi.
@@ -162,7 +161,7 @@ Host: k8s-master:8080
 [
  {
    "op": "remove",
-    "path": "/status/capacity/pod.alpha.kubernetes.io~1opaque-int-resource-dongle",
+    "path": "/status/capacity/example.com~1dongle",
  }
 ]
 ```
@@ -179,7 +178,7 @@ Replace `<your-node-name>` with the name of your Node:
 ```shell
 curl --header "Content-Type: application/json-patch+json" \
 --request PATCH \
--data '[{"op": "remove", "path": "/status/capacity/pod.alpha.kubernetes.io~1opaque-int-resource-dongle"}]' \
+--data '[{"op": "remove", "path": "/status/capacity/example.com~1dongle"}]' \
 http://localhost:8001/api/v1/nodes/<your-node-name>/status
 ```

@@ -196,7 +195,7 @@ kubectl describe node <your-node-name> | grep dongle

 ### For application developers

-* [Assign Opaque Integer Resources to a Container](/docs/tasks/configure-pod-container/opaque-integer-resource/)
+* [Assign Extended Resources to a Container](/docs/tasks/configure-pod-container/extended-resource/)

 ### For cluster administrators