github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 03:41:45 +00:00
Code Issues Projects Releases Wiki Activity

api: types: document NodeSpec ID fields

Browse Source 
Document MachineID as the preferred field from the discussion here:
https://groups.google.com/d/msg/kubernetes-sig-node/_3mXXB1ohZs/EuYtCzHvBgAJ
This commit is contained in:
Brandon Philips 2016-09-16 18:53:32 -07:00
parent 3718fd1f89
commit 080b3d0a8c
7 changed files with 27 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api/swagger-spec/v1.json
View File

@ -16952,11 +16952,11 @@
"properties": {
"machineID": {
"type": "string",
"description": "Machine ID reported by the node."
"description": "MachineID reported by the node. For unique machine identification in the cluster this field is prefered. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html"
},
"systemUUID": {
"type": "string",
"description": "System UUID reported by the node."
"description": "SystemUUID reported by the node. For unique machine identification MachineID is prefered. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html"
},
"bootID": {
"type": "string",

6
docs/api-reference/v1/definitions.html
View File

@ -8044,14 +8044,14 @@ The resulting set of endpoints can be viewed as:<br>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">machineID</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Machine ID reported by the node.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">MachineID reported by the node. For unique machine identification in the cluster this field is prefered. Learn more from man(5) machine-id: <a href="http://man7.org/linux/man-pages/man5/machine-id.5.html">http://man7.org/linux/man-pages/man5/machine-id.5.html</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">systemUUID</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">System UUID reported by the node.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">SystemUUID reported by the node. For unique machine identification MachineID is prefered. This field is specific to Red Hat hosts <a href="https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html">https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-top"></td>
@ -8434,7 +8434,7 @@ The resulting set of endpoints can be viewed as:<br>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2016-08-30 23:23:55 UTC
Last updated 2016-09-17 23:35:57 UTC
</div>
</div>
</body>

8
pkg/api/types.go
View File

@ -2086,9 +2086,13 @@ type NodeDaemonEndpoints struct {
// NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
type NodeSystemInfo struct {
// Machine ID reported by the node.
// MachineID reported by the node. For unique machine identification
// in the cluster this field is prefered. Learn more from man(5)
// machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
MachineID string `json:"machineID"`
// System UUID reported by the node.
// SystemUUID reported by the node. For unique machine identification
// MachineID is prefered. This field is specific to Red Hat hosts
// https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html
SystemUUID string `json:"systemUUID"`
// Boot ID reported by the node.
BootID string `json:"bootID"`

8
pkg/api/v1/generated.proto
View File

@ -1383,10 +1383,14 @@ message NodeStatus {
// NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
message NodeSystemInfo {
// Machine ID reported by the node.
// MachineID reported by the node. For unique machine identification
// in the cluster this field is prefered. Learn more from man(5)
// machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
optional string machineID = 1;
// System UUID reported by the node.
// SystemUUID reported by the node. For unique machine identification
// MachineID is prefered. This field is specific to Red Hat hosts
// https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html
optional string systemUUID = 2;
// Boot ID reported by the node.

8
pkg/api/v1/types.go
View File

@ -2465,9 +2465,13 @@ type NodeDaemonEndpoints struct {
// NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
type NodeSystemInfo struct {
// Machine ID reported by the node.
// MachineID reported by the node. For unique machine identification
// in the cluster this field is prefered. Learn more from man(5)
// machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
MachineID string `json:"machineID" protobuf:"bytes,1,opt,name=machineID"`
// System UUID reported by the node.
// SystemUUID reported by the node. For unique machine identification
// MachineID is prefered. This field is specific to Red Hat hosts
// https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html
SystemUUID string `json:"systemUUID" protobuf:"bytes,2,opt,name=systemUUID"`
// Boot ID reported by the node.
BootID string `json:"bootID" protobuf:"bytes,3,opt,name=bootID"`

4
pkg/api/v1/types_swagger_doc_generated.go
View File

@ -927,8 +927,8 @@ func (NodeStatus) SwaggerDoc() map[string]string {
var map_NodeSystemInfo = map[string]string{
"": "NodeSystemInfo is a set of ids/uuids to uniquely identify the node.",
"machineID": "Machine ID reported by the node.",
"systemUUID": "System UUID reported by the node.",
"machineID": "MachineID reported by the node. For unique machine identification in the cluster this field is prefered. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html",
"systemUUID": "SystemUUID reported by the node. For unique machine identification MachineID is prefered. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html",
"bootID": "Boot ID reported by the node.",
"kernelVersion": "Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).",
"osImage": "OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).",

4
pkg/genericapiserver/openapi/zz_generated.openapi.go
View File

@ -9552,14 +9552,14 @@ func (_ openAPI) OpenAPIDefinitions() *common.OpenAPIDefinitions {
Properties: map[string]spec.Schema{
"machineID": {
SchemaProps: spec.SchemaProps{
Description: "Machine ID reported by the node.",
Description: "MachineID reported by the node. For unique machine identification in the cluster this field is prefered. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html",
Type: []string{"string"},
Format: "",
},
},
"systemUUID": {
SchemaProps: spec.SchemaProps{
Description: "System UUID reported by the node.",
Description: "SystemUUID reported by the node. For unique machine identification MachineID is prefered. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html",
Type: []string{"string"},
Format: "",
},