From 9c3c23686fd145823b8d612b6510ea99001f2b47 Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Tue, 7 Jul 2015 11:29:00 -0700 Subject: [PATCH] Embed doc URLs in swagger document --- api/swagger-spec/v1.json | 406 +++++++++++++++++++-------------------- pkg/api/v1/types.go | 280 +++++++++++++-------------- 2 files changed, 343 insertions(+), 343 deletions(-) diff --git a/api/swagger-spec/v1.json b/api/swagger-spec/v1.json index 2dc99f1325b..6229d159a62 100644 --- a/api/swagger-spec/v1.json +++ b/api/swagger-spec/v1.json @@ -11033,11 +11033,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -11054,15 +11054,15 @@ "properties": { "name": { "type": "string", - "description": "string that identifies an object. Must be unique within a namespace; cannot be updated" + "description": "string that identifies an object. Must be unique within a namespace; cannot be updated; see http://releases.k8s.io/HEAD/docs/identifiers.md#names" }, "generateName": { "type": "string", - "description": "an optional prefix to use to generate a unique name; has the same validation rules as name; optional, and is applied only name if is not specified" + "description": "an optional prefix to use to generate a unique name; has the same validation rules as name; optional, and is applied only name if is not specified; see http://releases.k8s.io/HEAD/docs/api-conventions.md#idempotency" }, "namespace": { "type": "string", - "description": "namespace of the object; must be a DNS_LABEL; cannot be updated" + "description": "namespace of the object; must be a DNS_LABEL; cannot be updated; see http://releases.k8s.io/HEAD/docs/namespaces.md" }, "selfLink": { "type": "string", @@ -11070,7 +11070,7 @@ }, "uid": { "type": "string", - "description": "unique UUID across space and time; populated by the system; read-only" + "description": "unique UUID across space and time; populated by the system; read-only; see http://releases.k8s.io/HEAD/docs/identifiers.md#uids" }, "resourceVersion": { "type": "string", @@ -11083,19 +11083,19 @@ }, "creationTimestamp": { "type": "string", - "description": "RFC 3339 date and time at which the object was created; populated by the system, read-only; null for lists" + "description": "RFC 3339 date and time at which the object was created; populated by the system, read-only; null for lists; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata" }, "deletionTimestamp": { "type": "string", - "description": "RFC 3339 date and time at which the object will be deleted; populated by the system when a graceful deletion is requested, read-only; if not set, graceful deletion of the object has not been requested" + "description": "RFC 3339 date and time at which the object will be deleted; populated by the system when a graceful deletion is requested, read-only; if not set, graceful deletion of the object has not been requested; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata" }, "labels": { "type": "any", - "description": "map of string keys and values that can be used to organize and categorize objects; may match selectors of replication controllers and services" + "description": "map of string keys and values that can be used to organize and categorize objects; may match selectors of replication controllers and services; see http://releases.k8s.io/HEAD/docs/labels.md" }, "annotations": { "type": "any", - "description": "map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about objects" + "description": "map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about objects; see http://releases.k8s.io/HEAD/docs/annotations.md" } } }, @@ -11104,19 +11104,19 @@ "properties": { "kind": { "type": "string", - "description": "kind of the referent" + "description": "kind of the referent; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "namespace": { "type": "string", - "description": "namespace of the referent" + "description": "namespace of the referent; see http://releases.k8s.io/HEAD/docs/namespaces.md" }, "name": { "type": "string", - "description": "name of the referent" + "description": "name of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#names" }, "uid": { "type": "string", - "description": "uid of the referent" + "description": "uid of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#uids" }, "apiVersion": { "type": "string", @@ -11140,11 +11140,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -11177,11 +11177,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -11229,11 +11229,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -11256,11 +11256,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -11353,11 +11353,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -11365,7 +11365,7 @@ }, "status": { "type": "string", - "description": "status of the operation; either Success, or Failure" + "description": "status of the operation; either Success, or Failure; see http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status" }, "message": { "type": "string", @@ -11395,7 +11395,7 @@ }, "kind": { "type": "string", - "description": "the kind attribute of the resource associated with the status StatusReason; on some operations may differ from the requested resource Kind" + "description": "the kind attribute of the resource associated with the status StatusReason; on some operations may differ from the requested resource Kind; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "causes": { "type": "array", @@ -11436,11 +11436,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "gracePeriodSeconds": { "type": "integer", @@ -11457,11 +11457,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -11485,11 +11485,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -11547,11 +11547,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -11562,7 +11562,7 @@ "items": { "$ref": "v1.LimitRange" }, - "description": "items is a list of LimitRange objects" + "description": "items is a list of LimitRange objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md" } } }, @@ -11571,11 +11571,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -11631,11 +11631,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -11646,7 +11646,7 @@ "items": { "$ref": "v1.Namespace" }, - "description": "items is the list of Namespace objects in the list" + "description": "items is the list of Namespace objects in the list; see http://releases.k8s.io/HEAD/docs/namespaces.md" } } }, @@ -11655,11 +11655,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -11683,7 +11683,7 @@ "items": { "$ref": "v1.FinalizerName" }, - "description": "an opaque list of values that must be empty to permanently remove object from storage" + "description": "an opaque list of values that must be empty to permanently remove object from storage; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers" } } }, @@ -11696,7 +11696,7 @@ "properties": { "phase": { "type": "string", - "description": "phase is the current lifecycle phase of the namespace" + "description": "phase is the current lifecycle phase of the namespace; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases" } } }, @@ -11708,11 +11708,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -11732,11 +11732,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -11769,7 +11769,7 @@ }, "unschedulable": { "type": "boolean", - "description": "disable pod scheduling on the node" + "description": "disable pod scheduling on the node; see http://releases.k8s.io/HEAD/docs/node.md#manual-node-administration" } } }, @@ -11778,29 +11778,29 @@ "properties": { "capacity": { "type": "any", - "description": "compute resource capacity of the node; http://releases.k8s.io/HEAD/docs/resources.md" + "description": "compute resource capacity of the node; see http://releases.k8s.io/HEAD/docs/compute_resources.md" }, "phase": { "type": "string", - "description": "most recently observed lifecycle phase of the node" + "description": "most recently observed lifecycle phase of the node; see http://releases.k8s.io/HEAD/docs/node.md#node-phase" }, "conditions": { "type": "array", "items": { "$ref": "v1.NodeCondition" }, - "description": "list of node conditions observed" + "description": "list of node conditions observed; see http://releases.k8s.io/HEAD/docs/node.md#node-condition" }, "addresses": { "type": "array", "items": { "$ref": "v1.NodeAddress" }, - "description": "list of addresses reachable to the node" + "description": "list of addresses reachable to the node; see http://releases.k8s.io/HEAD/docs/node.md#node-addresses" }, "nodeInfo": { "$ref": "v1.NodeSystemInfo", - "description": "set of ids/uuids to uniquely identify the node" + "description": "set of ids/uuids to uniquely identify the node; see http://releases.k8s.io/HEAD/docs/node.md#node-info" } } }, @@ -11906,11 +11906,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -11921,7 +11921,7 @@ "items": { "$ref": "v1.PersistentVolumeClaim" }, - "description": "a list of persistent volume claims" + "description": "a list of persistent volume claims; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims" } } }, @@ -11930,11 +11930,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -11942,11 +11942,11 @@ }, "spec": { "$ref": "v1.PersistentVolumeClaimSpec", - "description": "the desired characteristics of a volume" + "description": "the desired characteristics of a volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims" }, "status": { "$ref": "v1.PersistentVolumeClaimStatus", - "description": "the current status of a persistent volume claim; read-only" + "description": "the current status of a persistent volume claim; read-only; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims" } } }, @@ -11958,11 +11958,11 @@ "items": { "$ref": "v1.PersistentVolumeAccessMode" }, - "description": "the desired access modes the volume should have" + "description": "the desired access modes the volume should have; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes-1" }, "resources": { "$ref": "v1.ResourceRequirements", - "description": "the desired resources the volume should have" + "description": "the desired resources the volume should have; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#resources" }, "volumeName": { "type": "string", @@ -11979,11 +11979,11 @@ "properties": { "limits": { "type": "any", - "description": "Maximum amount of compute resources allowed" + "description": "Maximum amount of compute resources allowed; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications" }, "requests": { "type": "any", - "description": "Minimum amount of resources requested; requests are honored only for persistent volumes as of now" + "description": "Minimum amount of resources requested; requests are honored only for persistent volumes as of now; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications" } } }, @@ -11999,7 +11999,7 @@ "items": { "$ref": "v1.PersistentVolumeAccessMode" }, - "description": "the actual access modes the volume has" + "description": "the actual access modes the volume has; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes-1" }, "capacity": { "type": "any", @@ -12012,11 +12012,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -12027,7 +12027,7 @@ "items": { "$ref": "v1.PersistentVolume" }, - "description": "list of persistent volumes" + "description": "list of persistent volumes; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md" } } }, @@ -12036,11 +12036,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -12048,11 +12048,11 @@ }, "spec": { "$ref": "v1.PersistentVolumeSpec", - "description": "specification of a persistent volume as provisioned by an administrator" + "description": "specification of a persistent volume as provisioned by an administrator; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistent-volumes" }, "status": { "$ref": "v1.PersistentVolumeStatus", - "description": "current status of a persistent volume; populated by the system, read-only" + "description": "current status of a persistent volume; populated by the system, read-only; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistent-volumes" } } }, @@ -12061,31 +12061,31 @@ "properties": { "capacity": { "type": "any", - "description": "a description of the persistent volume's resources and capacity" + "description": "a description of the persistent volume's resources and capacityr; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#capacity" }, "gcePersistentDisk": { "$ref": "v1.GCEPersistentDiskVolumeSource", - "description": "GCE disk resource provisioned by an admin" + "description": "GCE disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk" }, "awsElasticBlockStore": { "$ref": "v1.AWSElasticBlockStoreVolumeSource", - "description": "AWS disk resource provisioned by an admin" + "description": "AWS disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore" }, "hostPath": { "$ref": "v1.HostPathVolumeSource", - "description": "a HostPath provisioned by a developer or tester; for develment use only" + "description": "a HostPath provisioned by a developer or tester; for develment use only; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath" }, "glusterfs": { "$ref": "v1.GlusterfsVolumeSource", - "description": "Glusterfs volume resource provisioned by an admin" + "description": "Glusterfs volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md" }, "nfs": { "$ref": "v1.NFSVolumeSource", - "description": "NFS volume resource provisioned by an admin" + "description": "NFS volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs" }, "rbd": { "$ref": "v1.RBDVolumeSource", - "description": "rados block volume that will be mounted on the host machine" + "description": "rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md" }, "iscsi": { "$ref": "v1.ISCSIVolumeSource", @@ -12096,15 +12096,15 @@ "items": { "$ref": "v1.PersistentVolumeAccessMode" }, - "description": "all ways the volume can be mounted" + "description": "all ways the volume can be mounted; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes" }, "claimRef": { "$ref": "v1.ObjectReference", - "description": "when bound, a reference to the bound claim" + "description": "when bound, a reference to the bound claim; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#binding" }, "persistentVolumeReclaimPolicy": { "type": "string", - "description": "what happens to a volume when released from its claim; Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plugin underlying this persistent volume." + "description": "what happens to a volume when released from its claim; Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plugin underlying this persistent volume. See http://releases.k8s.io/HEAD/docs/persistent-volumes.md#recycling-policy" } } }, @@ -12117,20 +12117,20 @@ "properties": { "pdName": { "type": "string", - "description": "unique name of the PD resource in GCE" + "description": "unique name of the PD resource in GCE; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk" }, "fsType": { "type": "string", - "description": "file system type to mount, such as ext4, xfs, ntfs" + "description": "file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk" }, "partition": { "type": "integer", "format": "int32", - "description": "partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted" + "description": "partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk" }, "readOnly": { "type": "boolean", - "description": "read-only if true, read-write otherwise (false or unspecified)" + "description": "read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk" } } }, @@ -12143,20 +12143,20 @@ "properties": { "volumeID": { "type": "string", - "description": "unique id of the PD resource in AWS" + "description": "unique id of the PD resource in AWS; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore" }, "fsType": { "type": "string", - "description": "file system type to mount, such as ext4, xfs, ntfs" + "description": "file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore" }, "partition": { "type": "integer", "format": "int32", - "description": "partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted" + "description": "partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore" }, "readOnly": { "type": "boolean", - "description": "read-only if true, read-write otherwise (false or unspecified)" + "description": "read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore" } } }, @@ -12168,7 +12168,7 @@ "properties": { "path": { "type": "string", - "description": "path of the directory on the host" + "description": "path of the directory on the host; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath" } } }, @@ -12181,15 +12181,15 @@ "properties": { "endpoints": { "type": "string", - "description": "gluster hosts endpoints name" + "description": "gluster hosts endpoints name; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod" }, "path": { "type": "string", - "description": "path to gluster volume" + "description": "path to gluster volume; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod" }, "readOnly": { "type": "boolean", - "description": "glusterfs volume to be mounted with read-only permissions" + "description": "glusterfs volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod" } } }, @@ -12202,15 +12202,15 @@ "properties": { "server": { "type": "string", - "description": "the hostname or IP address of the NFS server" + "description": "the hostname or IP address of the NFS server; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs" }, "path": { "type": "string", - "description": "the path that is exported by the NFS server" + "description": "the path that is exported by the NFS server; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs" }, "readOnly": { "type": "boolean", - "description": "forces the NFS export to be mounted with read-only permissions" + "description": "forces the NFS export to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs" } } }, @@ -12230,35 +12230,35 @@ "items": { "type": "string" }, - "description": "a collection of Ceph monitors" + "description": "a collection of Ceph monitors; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it" }, "image": { "type": "string", - "description": "rados image name" + "description": "rados image name; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it" }, "fsType": { "type": "string", - "description": "file system type to mount, such as ext4, xfs, ntfs" + "description": "file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it" }, "pool": { "type": "string", - "description": "rados pool name; default is rbd; optional" + "description": "rados pool name; default is rbd; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it" }, "user": { "type": "string", - "description": "rados user name; default is admin; optional" + "description": "rados user name; default is admin; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it" }, "keyring": { "type": "string", - "description": "keyring is the path to key ring for rados user; default is /etc/ceph/keyring; optional" + "description": "keyring is the path to key ring for rados user; default is /etc/ceph/keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it" }, "secretRef": { "$ref": "v1.LocalObjectReference", - "description": "name of a secret to authenticate the RBD user; if provided overrides keyring; optional" + "description": "name of a secret to authenticate the RBD user; if provided overrides keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it" }, "readOnly": { "type": "boolean", - "description": "rbd volume to be mounted with read-only permissions" + "description": "rbd volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it" } } }, @@ -12267,7 +12267,7 @@ "properties": { "name": { "type": "string", - "description": "name of the referent" + "description": "name of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#names" } } }, @@ -12308,7 +12308,7 @@ "properties": { "phase": { "type": "string", - "description": "the current phase of a persistent volume" + "description": "the current phase of a persistent volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#phase" }, "message": { "type": "string", @@ -12328,11 +12328,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -12343,7 +12343,7 @@ "items": { "$ref": "v1.Pod" }, - "description": "list of pods" + "description": "list of pods; see http://releases.k8s.io/HEAD/docs/pods.md" } } }, @@ -12352,11 +12352,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -12383,18 +12383,18 @@ "items": { "$ref": "v1.Volume" }, - "description": "list of volumes that can be mounted by containers belonging to the pod" + "description": "list of volumes that can be mounted by containers belonging to the pod; see http://releases.k8s.io/HEAD/docs/volumes.md" }, "containers": { "type": "array", "items": { "$ref": "v1.Container" }, - "description": "list of containers belonging to the pod; cannot be updated; containers cannot currently be added or removed; there must be at least one container in a Pod" + "description": "list of containers belonging to the pod; cannot be updated; containers cannot currently be added or removed; there must be at least one container in a Pod; see http://releases.k8s.io/HEAD/docs/containers.md" }, "restartPolicy": { "type": "string", - "description": "restart policy for all containers within the pod; one of Always, OnFailure, Never; defaults to Always" + "description": "restart policy for all containers within the pod; one of Always, OnFailure, Never; defaults to Always; see http://releases.k8s.io/HEAD/docs/pod-states.md#restartpolicy" }, "terminationGracePeriodSeconds": { "type": "integer", @@ -12411,11 +12411,11 @@ }, "nodeSelector": { "type": "any", - "description": "selector which must match a node's labels for the pod to be scheduled on that node" + "description": "selector which must match a node's labels for the pod to be scheduled on that node; see http://releases.k8s.io/HEAD/examples/node-selection/README.md" }, "serviceAccountName": { "type": "string", - "description": "name of the ServiceAccount to use to run this pod" + "description": "name of the ServiceAccount to use to run this pod; see http://releases.k8s.io/HEAD/docs/service_accounts.md" }, "nodeName": { "type": "string", @@ -12430,7 +12430,7 @@ "items": { "$ref": "v1.LocalObjectReference" }, - "description": "list of references to secrets in the same namespace available for pulling the container images" + "description": "list of references to secrets in the same namespace available for pulling the container images; see http://releases.k8s.io/HEAD/docs/images.md#specifying-imagepullsecrets-on-a-pod" } } }, @@ -12442,23 +12442,23 @@ "properties": { "name": { "type": "string", - "description": "volume name; must be a DNS_LABEL and unique within the pod" + "description": "volume name; must be a DNS_LABEL and unique within the pod; see http://releases.k8s.io/HEAD/docs/identifiers.md#names" }, "hostPath": { "$ref": "v1.HostPathVolumeSource", - "description": "pre-existing host file or directory; generally for privileged system daemons or other agents tied to the host" + "description": "pre-existing host file or directory; generally for privileged system daemons or other agents tied to the host; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath" }, "emptyDir": { "$ref": "v1.EmptyDirVolumeSource", - "description": "temporary directory that shares a pod's lifetime" + "description": "temporary directory that shares a pod's lifetime; see http://releases.k8s.io/HEAD/docs/volumes.md#emptydir" }, "gcePersistentDisk": { "$ref": "v1.GCEPersistentDiskVolumeSource", - "description": "GCE disk resource attached to the host machine on demand" + "description": "GCE disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk" }, "awsElasticBlockStore": { "$ref": "v1.AWSElasticBlockStoreVolumeSource", - "description": "AWS disk resource attached to the host machine on demand" + "description": "AWS disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore" }, "gitRepo": { "$ref": "v1.GitRepoVolumeSource", @@ -12466,27 +12466,27 @@ }, "secret": { "$ref": "v1.SecretVolumeSource", - "description": "secret to populate volume" + "description": "secret to populate volume; see http://releases.k8s.io/HEAD/docs/volumes.md#secrets" }, "nfs": { "$ref": "v1.NFSVolumeSource", - "description": "NFS volume that will be mounted in the host machine" + "description": "NFS volume that will be mounted in the host machine; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs" }, "iscsi": { "$ref": "v1.ISCSIVolumeSource", - "description": "iSCSI disk attached to host machine on demand" + "description": "iSCSI disk attached to host machine on demand; see http://releases.k8s.io/HEAD/examples/iscsi/README.md" }, "glusterfs": { "$ref": "v1.GlusterfsVolumeSource", - "description": "Glusterfs volume that will be mounted on the host machine " + "description": "Glusterfs volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md" }, "persistentVolumeClaim": { "$ref": "v1.PersistentVolumeClaimVolumeSource", - "description": "a reference to a PersistentVolumeClaim in the same namespace" + "description": "a reference to a PersistentVolumeClaim in the same namespace; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims" }, "rbd": { "$ref": "v1.RBDVolumeSource", - "description": "rados block volume that will be mounted on the host machine" + "description": "rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md" } } }, @@ -12495,7 +12495,7 @@ "properties": { "medium": { "type": "string", - "description": "type of storage used to back the volume; must be an empty string (default) or Memory" + "description": "type of storage used to back the volume; must be an empty string (default) or Memory; see http://releases.k8s.io/HEAD/docs/volumes.md#emptydir" } } }, @@ -12524,7 +12524,7 @@ "properties": { "secretName": { "type": "string", - "description": "secretName is the name of a secret in the pod's namespace" + "description": "secretName is the name of a secret in the pod's namespace; see http://releases.k8s.io/HEAD/docs/volumes.md#secrets" } } }, @@ -12536,7 +12536,7 @@ "properties": { "claimName": { "type": "string", - "description": "the name of the claim in the same namespace to be mounted as a volume" + "description": "the name of the claim in the same namespace to be mounted as a volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims" }, "readOnly": { "type": "boolean", @@ -12556,21 +12556,21 @@ }, "image": { "type": "string", - "description": "Docker image name" + "description": "Docker image name; see http://releases.k8s.io/HEAD/docs/images.md" }, "command": { "type": "array", "items": { "type": "string" }, - "description": "entrypoint array; not executed within a shell; the docker image's entrypoint is used if this is not provided; cannot be updated; variable references $(VAR_NAME) are expanded using the container's environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not" + "description": "entrypoint array; not executed within a shell; the docker image's entrypoint is used if this is not provided; cannot be updated; variable references $(VAR_NAME) are expanded using the container's environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not; see http://releases.k8s.io/HEAD/docs/containers.md#containers-and-commands" }, "args": { "type": "array", "items": { "type": "string" }, - "description": "command array; the docker image's cmd is used if this is not provided; arguments to the entrypoint; cannot be updated; variable references $(VAR_NAME) are expanded using the container's environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not" + "description": "command array; the docker image's cmd is used if this is not provided; arguments to the entrypoint; cannot be updated; variable references $(VAR_NAME) are expanded using the container's environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not; see http://releases.k8s.io/HEAD/docs/containers.md#containers-and-commands" }, "workingDir": { "type": "string", @@ -12592,7 +12592,7 @@ }, "resources": { "$ref": "v1.ResourceRequirements", - "description": "Compute Resources required by this container; cannot be updated" + "description": "Compute Resources required by this container; cannot be updated; see http://releases.k8s.io/HEAD/docs/compute_resources.md" }, "volumeMounts": { "type": "array", @@ -12603,11 +12603,11 @@ }, "livenessProbe": { "$ref": "v1.Probe", - "description": "periodic probe of container liveness; container will be restarted if the probe fails; cannot be updated" + "description": "periodic probe of container liveness; container will be restarted if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes" }, "readinessProbe": { "$ref": "v1.Probe", - "description": "periodic probe of container service readiness; container will be removed from service endpoints if the probe fails; cannot be updated" + "description": "periodic probe of container service readiness; container will be removed from service endpoints if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes" }, "lifecycle": { "$ref": "v1.Lifecycle", @@ -12619,11 +12619,11 @@ }, "imagePullPolicy": { "type": "string", - "description": "image pull policy; one of Always, Never, IfNotPresent; defaults to Always if :latest tag is specified, or IfNotPresent otherwise; cannot be updated" + "description": "image pull policy; one of Always, Never, IfNotPresent; defaults to Always if :latest tag is specified, or IfNotPresent otherwise; cannot be updated; see http://releases.k8s.io/HEAD/docs/images.md#updating-images" }, "securityContext": { "$ref": "v1.SecurityContext", - "description": "security options the pod should run with" + "description": "security options the pod should run with; see http://releases.k8s.io/HEAD/docs/security_context.md" } } }, @@ -12744,12 +12744,12 @@ "initialDelaySeconds": { "type": "integer", "format": "int64", - "description": "number of seconds after the container has started before liveness probes are initiated" + "description": "number of seconds after the container has started before liveness probes are initiated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes" }, "timeoutSeconds": { "type": "integer", "format": "int64", - "description": "number of seconds after which liveness probes timeout; defaults to 1 second" + "description": "number of seconds after which liveness probes timeout; defaults to 1 second; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes" } } }, @@ -12806,11 +12806,11 @@ "properties": { "postStart": { "$ref": "v1.Handler", - "description": "called immediately after a container is started; if the handler fails, the container is terminated and restarted according to its restart policy; other management of the container blocks until the hook completes" + "description": "called immediately after a container is started; if the handler fails, the container is terminated and restarted according to its restart policy; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/container-environment.md#hook-details" }, "preStop": { "$ref": "v1.Handler", - "description": "called before a container is terminated; the container is terminated after the handler completes; other management of the container blocks until the hook completes" + "description": "called before a container is terminated; the container is terminated after the handler completes; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/container-environment.md#hook-details" } } }, @@ -12836,20 +12836,20 @@ "properties": { "capabilities": { "$ref": "v1.Capabilities", - "description": "the linux capabilites that should be added or removed" + "description": "the linux capabilites that should be added or removed; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context" }, "privileged": { "type": "boolean", - "description": "run the container in privileged mode" + "description": "run the container in privileged mode; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context" }, "seLinuxOptions": { "$ref": "v1.SELinuxOptions", - "description": "options that control the SELinux labels applied" + "description": "options that control the SELinux labels applied; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context" }, "runAsUser": { "type": "integer", "format": "int64", - "description": "the user id that runs the first process in the container" + "description": "the user id that runs the first process in the container; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context" } } }, @@ -12881,19 +12881,19 @@ "properties": { "user": { "type": "string", - "description": "the user label to apply to the container" + "description": "the user label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md" }, "role": { "type": "string", - "description": "the role label to apply to the container" + "description": "the role label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md" }, "type": { "type": "string", - "description": "the type label to apply to the container" + "description": "the type label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md" }, "level": { "type": "string", - "description": "the level label to apply to the container" + "description": "the level label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md" } } }, @@ -12902,14 +12902,14 @@ "properties": { "phase": { "type": "string", - "description": "current condition of the pod." + "description": "current condition of the pod; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-phase" }, "conditions": { "type": "array", "items": { "$ref": "v1.PodCondition" }, - "description": "current service state of pod" + "description": "current service state of pod; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions" }, "message": { "type": "string", @@ -12936,7 +12936,7 @@ "items": { "$ref": "v1.ContainerStatus" }, - "description": "list of container statuses" + "description": "list of container statuses; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-statuses" } } }, @@ -12949,11 +12949,11 @@ "properties": { "type": { "type": "string", - "description": "kind of the condition, currently only Ready" + "description": "kind of the condition, currently only Ready; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions" }, "status": { "type": "string", - "description": "status of the condition, one of True, False, Unknown" + "description": "status of the condition, one of True, False, Unknown; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions" } } }, @@ -12990,7 +12990,7 @@ }, "image": { "type": "string", - "description": "image of the container" + "description": "image of the container; see http://releases.k8s.io/HEAD/docs/images.md" }, "imageID": { "type": "string", @@ -12998,7 +12998,7 @@ }, "containerID": { "type": "string", - "description": "container's ID in the format 'docker://\u003ccontainer_id\u003e'" + "description": "container's ID in the format 'docker://\u003ccontainer_id\u003e'; see http://releases.k8s.io/HEAD/docs/container-environment.md#container-information" } } }, @@ -13083,11 +13083,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -13107,11 +13107,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -13144,11 +13144,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -13159,7 +13159,7 @@ "items": { "$ref": "v1.ReplicationController" }, - "description": "list of replication controllers" + "description": "list of replication controllers; see http://releases.k8s.io/HEAD/docs/replication-controller.md" } } }, @@ -13168,11 +13168,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -13194,15 +13194,15 @@ "replicas": { "type": "integer", "format": "int32", - "description": "number of replicas desired; defaults to 1" + "description": "number of replicas desired; defaults to 1; see http://releases.k8s.io/HEAD/docs/replication-controller.md#what-is-a-replication-controller" }, "selector": { "type": "any", - "description": "label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template" + "description": "label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template; see http://releases.k8s.io/HEAD/docs/labels.md#label-selectors" }, "template": { "$ref": "v1.PodTemplateSpec", - "description": "object that describes the pod that will be created if insufficient replicas are detected; takes precendence over templateRef" + "description": "object that describes the pod that will be created if insufficient replicas are detected; takes precendence over templateRef; see http://releases.k8s.io/HEAD/docs/replication-controller.md#pod-template" } } }, @@ -13215,7 +13215,7 @@ "replicas": { "type": "integer", "format": "int32", - "description": "most recently oberved number of replicas" + "description": "most recently oberved number of replicas; see http://releases.k8s.io/HEAD/docs/replication-controller.md#what-is-a-replication-controller" }, "observedGeneration": { "type": "integer", @@ -13232,11 +13232,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -13247,7 +13247,7 @@ "items": { "$ref": "v1.ResourceQuota" }, - "description": "items is a list of ResourceQuota objects" + "description": "items is a list of ResourceQuota objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota" } } }, @@ -13256,11 +13256,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -13281,7 +13281,7 @@ "properties": { "hard": { "type": "any", - "description": "hard is the set of desired hard limits for each named resource" + "description": "hard is the set of desired hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota" } } }, @@ -13290,7 +13290,7 @@ "properties": { "hard": { "type": "any", - "description": "hard is the set of enforced hard limits for each named resource" + "description": "hard is the set of enforced hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota" }, "used": { "type": "any", @@ -13306,11 +13306,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -13321,7 +13321,7 @@ "items": { "$ref": "v1.Secret" }, - "description": "items is a list of secret objects" + "description": "items is a list of secret objects; see http://releases.k8s.io/HEAD/docs/secrets.md" } } }, @@ -13330,11 +13330,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -13358,11 +13358,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -13373,7 +13373,7 @@ "items": { "$ref": "v1.ServiceAccount" }, - "description": "list of ServiceAccounts" + "description": "list of ServiceAccounts; see http://releases.k8s.io/HEAD/docs/service_accounts.md#service-accounts" } } }, @@ -13382,11 +13382,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -13397,14 +13397,14 @@ "items": { "$ref": "v1.ObjectReference" }, - "description": "list of secrets that can be used by pods running as this service account" + "description": "list of secrets that can be used by pods running as this service account; see http://releases.k8s.io/HEAD/docs/secrets.md" }, "imagePullSecrets": { "type": "array", "items": { "$ref": "v1.LocalObjectReference" }, - "description": "list of references to secrets in the same namespace available for pulling container images" + "description": "list of references to secrets in the same namespace available for pulling container images; see http://releases.k8s.io/HEAD/docs/secrets.md#manually-specifying-an-imagepullsecret" } } }, @@ -13416,11 +13416,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ListMeta", @@ -13440,11 +13440,11 @@ "properties": { "kind": { "type": "string", - "description": "kind of object, in CamelCase; cannot be updated" + "description": "kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds" }, "apiVersion": { "type": "string", - "description": "version of the schema the object should have" + "description": "version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources" }, "metadata": { "$ref": "v1.ObjectMeta", @@ -13471,19 +13471,19 @@ "items": { "$ref": "v1.ServicePort" }, - "description": "ports exposed by the service" + "description": "ports exposed by the service; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies" }, "selector": { "type": "any", - "description": "label keys and values that must match in order to receive traffic for this service; if empty, all pods are selected, if not specified, endpoints must be manually specified" + "description": "label keys and values that must match in order to receive traffic for this service; if empty, all pods are selected, if not specified, endpoints must be manually specified; see http://releases.k8s.io/HEAD/docs/services.md#overview" }, "clusterIP": { "type": "string", - "description": "IP address of the service; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; cannot be updated; 'None' can be specified for a headless service when proxying is not required" + "description": "IP address of the service; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; cannot be updated; 'None' can be specified for a headless service when proxying is not required; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies" }, "type": { "type": "string", - "description": "type of this service; must be ClusterIP, NodePort, or LoadBalancer; defaults to ClusterIP" + "description": "type of this service; must be ClusterIP, NodePort, or LoadBalancer; defaults to ClusterIP; see http://releases.k8s.io/HEAD/docs/services.md#external-services" }, "deprecatedPublicIPs": { "type": "array", @@ -13494,7 +13494,7 @@ }, "sessionAffinity": { "type": "string", - "description": "enable client IP based session affinity; must be ClientIP or None; defaults to None" + "description": "enable client IP based session affinity; must be ClientIP or None; defaults to None; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies" } } }, @@ -13520,12 +13520,12 @@ }, "targetPort": { "type": "string", - "description": "number or name of the port to access on the pods targeted by the service; defaults to the service port; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME" + "description": "number or name of the port to access on the pods targeted by the service; defaults to the service port; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME; see http://releases.k8s.io/HEAD/docs/services.md#defining-a-service" }, "nodePort": { "type": "integer", "format": "int32", - "description": "the port on each node on which this service is exposed when type=NodePort or LoadBalancer; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail" + "description": "the port on each node on which this service is exposed when type=NodePort or LoadBalancer; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; see http://releases.k8s.io/HEAD/docs/services.md#type--nodeport" } } }, diff --git a/pkg/api/v1/types.go b/pkg/api/v1/types.go index acbd79dc2df..ffbe8faaa9f 100644 --- a/pkg/api/v1/types.go +++ b/pkg/api/v1/types.go @@ -58,12 +58,12 @@ import ( type TypeMeta struct { // Kind is a string value representing the REST resource this object represents. // Servers may infer this from the endpoint the client submits requests to. - Kind string `json:"kind,omitempty" description:"kind of object, in CamelCase; cannot be updated"` + Kind string `json:"kind,omitempty" description:"kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds"` // APIVersion defines the versioned schema of this representation of an object. // Servers should convert recognized schemas to the latest internal value, and // may reject unrecognized values. - APIVersion string `json:"apiVersion,omitempty" description:"version of the schema the object should have"` + APIVersion string `json:"apiVersion,omitempty" description:"version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources"` } // ListMeta describes metadata that synthetic resources must have, including lists and @@ -86,7 +86,7 @@ type ObjectMeta struct { // some resources may allow a client to request the generation of an appropriate name // automatically. Name is primarily intended for creation idempotence and configuration // definition. - Name string `json:"name,omitempty" description:"string that identifies an object. Must be unique within a namespace; cannot be updated"` + Name string `json:"name,omitempty" description:"string that identifies an object. Must be unique within a namespace; cannot be updated; see http://releases.k8s.io/HEAD/docs/identifiers.md#names"` // GenerateName indicates that the name should be made unique by the server prior to persisting // it. A non-empty value for the field indicates the name will be made unique (and the name @@ -99,13 +99,13 @@ type ObjectMeta struct { // generated name exists - instead, it will either return 201 Created or 500 with Reason // ServerTimeout indicating a unique name could not be found in the time allotted, and the client // should retry (optionally after the time indicated in the Retry-After header). - GenerateName string `json:"generateName,omitempty" description:"an optional prefix to use to generate a unique name; has the same validation rules as name; optional, and is applied only name if is not specified"` + GenerateName string `json:"generateName,omitempty" description:"an optional prefix to use to generate a unique name; has the same validation rules as name; optional, and is applied only name if is not specified; see http://releases.k8s.io/HEAD/docs/api-conventions.md#idempotency"` // Namespace defines the space within which name must be unique. An empty namespace is // equivalent to the "default" namespace, but "default" is the canonical representation. // Not all objects are required to be scoped to a namespace - the value of this field for // those objects will be empty. - Namespace string `json:"namespace,omitempty" description:"namespace of the object; must be a DNS_LABEL; cannot be updated"` + Namespace string `json:"namespace,omitempty" description:"namespace of the object; must be a DNS_LABEL; cannot be updated; see http://releases.k8s.io/HEAD/docs/namespaces.md"` // SelfLink is a URL representing this object. SelfLink string `json:"selfLink,omitempty" description:"URL for the object; populated by the system, read-only"` @@ -113,7 +113,7 @@ type ObjectMeta struct { // UID is the unique in time and space value for this object. It is typically generated by // the server on successful creation of a resource and is not allowed to change on PUT // operations. - UID types.UID `json:"uid,omitempty" description:"unique UUID across space and time; populated by the system; read-only"` + UID types.UID `json:"uid,omitempty" description:"unique UUID across space and time; populated by the system; read-only; see http://releases.k8s.io/HEAD/docs/identifiers.md#uids"` // An opaque value that represents the version of this resource. May be used for optimistic // concurrency, change detection, and the watch operation on a resource or set of resources. @@ -128,7 +128,7 @@ type ObjectMeta struct { // CreationTimestamp is a timestamp representing the server time when this object was // created. It is not guaranteed to be set in happens-before order across separate operations. // Clients may not set this value. It is represented in RFC3339 form and is in UTC. - CreationTimestamp util.Time `json:"creationTimestamp,omitempty" description:"RFC 3339 date and time at which the object was created; populated by the system, read-only; null for lists"` + CreationTimestamp util.Time `json:"creationTimestamp,omitempty" description:"RFC 3339 date and time at which the object was created; populated by the system, read-only; null for lists; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // DeletionTimestamp is the time after which this resource will be deleted. This // field is set by the server when a graceful deletion is requested by the user, and is not @@ -139,16 +139,16 @@ type ObjectMeta struct { // a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination // signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet // will send a hard termination signal to the container. - DeletionTimestamp *util.Time `json:"deletionTimestamp,omitempty" description:"RFC 3339 date and time at which the object will be deleted; populated by the system when a graceful deletion is requested, read-only; if not set, graceful deletion of the object has not been requested"` + DeletionTimestamp *util.Time `json:"deletionTimestamp,omitempty" description:"RFC 3339 date and time at which the object will be deleted; populated by the system when a graceful deletion is requested, read-only; if not set, graceful deletion of the object has not been requested; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // Labels are key value pairs that may be used to scope and select individual resources. // TODO: replace map[string]string with labels.LabelSet type - Labels map[string]string `json:"labels,omitempty" description:"map of string keys and values that can be used to organize and categorize objects; may match selectors of replication controllers and services"` + Labels map[string]string `json:"labels,omitempty" description:"map of string keys and values that can be used to organize and categorize objects; may match selectors of replication controllers and services; see http://releases.k8s.io/HEAD/docs/labels.md"` // Annotations are unstructured key value data stored with a resource that may be set by // external tooling. They are not queryable and should be preserved when modifying // objects. - Annotations map[string]string `json:"annotations,omitempty" description:"map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about objects"` + Annotations map[string]string `json:"annotations,omitempty" description:"map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about objects; see http://releases.k8s.io/HEAD/docs/annotations.md"` } const ( @@ -162,7 +162,7 @@ const ( type Volume struct { // Required: This must be a DNS_LABEL. Each volume in a pod must have // a unique name. - Name string `json:"name" description:"volume name; must be a DNS_LABEL and unique within the pod"` + Name string `json:"name" description:"volume name; must be a DNS_LABEL and unique within the pod; see http://releases.k8s.io/HEAD/docs/identifiers.md#names"` // Source represents the location and type of a volume to mount. // This is optional for now. If not specified, the Volume is implied to be an EmptyDir. // This implied behavior is deprecated and will be removed in a future version. @@ -178,35 +178,35 @@ type VolumeSource struct { // to see the host machine. Most containers will NOT need this. // TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not // mount host directories as read/write. - HostPath *HostPathVolumeSource `json:"hostPath,omitempty" description:"pre-existing host file or directory; generally for privileged system daemons or other agents tied to the host"` + HostPath *HostPathVolumeSource `json:"hostPath,omitempty" description:"pre-existing host file or directory; generally for privileged system daemons or other agents tied to the host; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath"` // EmptyDir represents a temporary directory that shares a pod's lifetime. - EmptyDir *EmptyDirVolumeSource `json:"emptyDir,omitempty" description:"temporary directory that shares a pod's lifetime"` + EmptyDir *EmptyDirVolumeSource `json:"emptyDir,omitempty" description:"temporary directory that shares a pod's lifetime; see http://releases.k8s.io/HEAD/docs/volumes.md#emptydir"` // GCEPersistentDisk represents a GCE Disk resource that is attached to a // kubelet's host machine and then exposed to the pod. - GCEPersistentDisk *GCEPersistentDiskVolumeSource `json:"gcePersistentDisk,omitempty" description:"GCE disk resource attached to the host machine on demand"` + GCEPersistentDisk *GCEPersistentDiskVolumeSource `json:"gcePersistentDisk,omitempty" description:"GCE disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk"` // AWSElasticBlockStore represents an AWS Disk resource that is attached to a // kubelet's host machine and then exposed to the pod. - AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `json:"awsElasticBlockStore,omitempty" description:"AWS disk resource attached to the host machine on demand"` + AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `json:"awsElasticBlockStore,omitempty" description:"AWS disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore"` // GitRepo represents a git repository at a particular revision. GitRepo *GitRepoVolumeSource `json:"gitRepo,omitempty" description:"git repository at a particular revision"` // Secret represents a secret that should populate this volume. - Secret *SecretVolumeSource `json:"secret,omitempty" description:"secret to populate volume"` + Secret *SecretVolumeSource `json:"secret,omitempty" description:"secret to populate volume; see http://releases.k8s.io/HEAD/docs/volumes.md#secrets"` // NFS represents an NFS mount on the host that shares a pod's lifetime - NFS *NFSVolumeSource `json:"nfs,omitempty" description:"NFS volume that will be mounted in the host machine"` + NFS *NFSVolumeSource `json:"nfs,omitempty" description:"NFS volume that will be mounted in the host machine; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs"` // ISCSI represents an ISCSI Disk resource that is attached to a // kubelet's host machine and then exposed to the pod. - ISCSI *ISCSIVolumeSource `json:"iscsi,omitempty" description:"iSCSI disk attached to host machine on demand"` + ISCSI *ISCSIVolumeSource `json:"iscsi,omitempty" description:"iSCSI disk attached to host machine on demand; see http://releases.k8s.io/HEAD/examples/iscsi/README.md"` // Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime - Glusterfs *GlusterfsVolumeSource `json:"glusterfs,omitempty" description:"Glusterfs volume that will be mounted on the host machine "` + Glusterfs *GlusterfsVolumeSource `json:"glusterfs,omitempty" description:"Glusterfs volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md"` // PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace - PersistentVolumeClaim *PersistentVolumeClaimVolumeSource `json:"persistentVolumeClaim,omitempty" description:"a reference to a PersistentVolumeClaim in the same namespace"` + PersistentVolumeClaim *PersistentVolumeClaimVolumeSource `json:"persistentVolumeClaim,omitempty" description:"a reference to a PersistentVolumeClaim in the same namespace; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims"` // RBD represents a Rados Block Device mount on the host that shares a pod's lifetime - RBD *RBDVolumeSource `json:"rbd,omitempty" description:"rados block volume that will be mounted on the host machine"` + RBD *RBDVolumeSource `json:"rbd,omitempty" description:"rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md"` } type PersistentVolumeClaimVolumeSource struct { // ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume - ClaimName string `json:"claimName" description:"the name of the claim in the same namespace to be mounted as a volume"` + ClaimName string `json:"claimName" description:"the name of the claim in the same namespace to be mounted as a volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims"` // Optional: Defaults to false (read/write). ReadOnly here // will force the ReadOnly setting in VolumeMounts ReadOnly bool `json:"readOnly,omitempty" description:"mount volume as read-only when true; default false"` @@ -217,20 +217,20 @@ type PersistentVolumeClaimVolumeSource struct { type PersistentVolumeSource struct { // GCEPersistentDisk represents a GCE Disk resource that is attached to a // kubelet's host machine and then exposed to the pod. - GCEPersistentDisk *GCEPersistentDiskVolumeSource `json:"gcePersistentDisk,omitempty" description:"GCE disk resource provisioned by an admin"` + GCEPersistentDisk *GCEPersistentDiskVolumeSource `json:"gcePersistentDisk,omitempty" description:"GCE disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk"` // AWSElasticBlockStore represents an AWS Disk resource that is attached to a // kubelet's host machine and then exposed to the pod. - AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `json:"awsElasticBlockStore,omitempty" description:"AWS disk resource provisioned by an admin"` + AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `json:"awsElasticBlockStore,omitempty" description:"AWS disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore"` // HostPath represents a directory on the host. // This is useful for development and testing only. // on-host storage is not supported in any way. - HostPath *HostPathVolumeSource `json:"hostPath,omitempty" description:"a HostPath provisioned by a developer or tester; for develment use only"` + HostPath *HostPathVolumeSource `json:"hostPath,omitempty" description:"a HostPath provisioned by a developer or tester; for develment use only; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath"` // Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod - Glusterfs *GlusterfsVolumeSource `json:"glusterfs,omitempty" description:"Glusterfs volume resource provisioned by an admin"` + Glusterfs *GlusterfsVolumeSource `json:"glusterfs,omitempty" description:"Glusterfs volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md"` // NFS represents an NFS mount on the host - NFS *NFSVolumeSource `json:"nfs,omitempty" description:"NFS volume resource provisioned by an admin"` + NFS *NFSVolumeSource `json:"nfs,omitempty" description:"NFS volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs"` // RBD represents a Rados Block Device mount on the host that shares a pod's lifetime - RBD *RBDVolumeSource `json:"rbd,omitempty" description:"rados block volume that will be mounted on the host machine"` + RBD *RBDVolumeSource `json:"rbd,omitempty" description:"rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md"` // ISCSI represents an ISCSI Disk resource that is attached to a // kubelet's host machine and then exposed to the pod. ISCSI *ISCSIVolumeSource `json:"iscsi,omitempty" description:"an iSCSI disk resource provisioned by an admin"` @@ -241,25 +241,25 @@ type PersistentVolume struct { ObjectMeta `json:"metadata,omitempty" description:"standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // Spec defines a persistent volume owned by the cluster - Spec PersistentVolumeSpec `json:"spec,omitempty" description:"specification of a persistent volume as provisioned by an administrator"` + Spec PersistentVolumeSpec `json:"spec,omitempty" description:"specification of a persistent volume as provisioned by an administrator; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistent-volumes"` // Status represents the current information about persistent volume. - Status PersistentVolumeStatus `json:"status,omitempty" description:"current status of a persistent volume; populated by the system, read-only"` + Status PersistentVolumeStatus `json:"status,omitempty" description:"current status of a persistent volume; populated by the system, read-only; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistent-volumes"` } type PersistentVolumeSpec struct { // Resources represents the actual resources of the volume - Capacity ResourceList `json:"capacity,omitempty" description:"a description of the persistent volume's resources and capacity"` + Capacity ResourceList `json:"capacity,omitempty" description:"a description of the persistent volume's resources and capacityr; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#capacity"` // Source represents the location and type of a volume to mount. PersistentVolumeSource `json:",inline" description:"the actual volume backing the persistent volume"` // AccessModes contains all ways the volume can be mounted - AccessModes []PersistentVolumeAccessMode `json:"accessModes,omitempty" description:"all ways the volume can be mounted"` + AccessModes []PersistentVolumeAccessMode `json:"accessModes,omitempty" description:"all ways the volume can be mounted; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes"` // ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. // ClaimRef is expected to be non-nil when bound. // claim.VolumeName is the authoritative bind between PV and PVC. - ClaimRef *ObjectReference `json:"claimRef,omitempty" description:"when bound, a reference to the bound claim"` + ClaimRef *ObjectReference `json:"claimRef,omitempty" description:"when bound, a reference to the bound claim; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#binding"` // Optional: what happens to a persistent volume when released from its claim. - PersistentVolumeReclaimPolicy PersistentVolumeReclaimPolicy `json:"persistentVolumeReclaimPolicy,omitempty" description:"what happens to a volume when released from its claim; Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plugin underlying this persistent volume."` + PersistentVolumeReclaimPolicy PersistentVolumeReclaimPolicy `json:"persistentVolumeReclaimPolicy,omitempty" description:"what happens to a volume when released from its claim; Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plugin underlying this persistent volume. See http://releases.k8s.io/HEAD/docs/persistent-volumes.md#recycling-policy"` } // PersistentVolumeReclaimPolicy describes a policy for end-of-life maintenance of persistent volumes @@ -280,7 +280,7 @@ const ( type PersistentVolumeStatus struct { // Phase indicates if a volume is available, bound to a claim, or released by a claim - Phase PersistentVolumePhase `json:"phase,omitempty" description:"the current phase of a persistent volume"` + Phase PersistentVolumePhase `json:"phase,omitempty" description:"the current phase of a persistent volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#phase"` // A human-readable message indicating details about why the volume is in this state. Message string `json:"message,omitempty" description:"human-readable message indicating details about why the volume is in this state"` // Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI @@ -290,7 +290,7 @@ type PersistentVolumeStatus struct { type PersistentVolumeList struct { TypeMeta `json:",inline"` ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds"` - Items []PersistentVolume `json:"items,omitempty" description:"list of persistent volumes"` + Items []PersistentVolume `json:"items,omitempty" description:"list of persistent volumes; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md"` } // PersistentVolumeClaim is a user's request for and claim to a persistent volume @@ -299,25 +299,25 @@ type PersistentVolumeClaim struct { ObjectMeta `json:"metadata,omitempty" description:"standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // Spec defines the volume requested by a pod author - Spec PersistentVolumeClaimSpec `json:"spec,omitempty" description:"the desired characteristics of a volume"` + Spec PersistentVolumeClaimSpec `json:"spec,omitempty" description:"the desired characteristics of a volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims"` // Status represents the current information about a claim - Status PersistentVolumeClaimStatus `json:"status,omitempty" description:"the current status of a persistent volume claim; read-only"` + Status PersistentVolumeClaimStatus `json:"status,omitempty" description:"the current status of a persistent volume claim; read-only; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims"` } type PersistentVolumeClaimList struct { TypeMeta `json:",inline"` ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds"` - Items []PersistentVolumeClaim `json:"items,omitempty" description:"a list of persistent volume claims"` + Items []PersistentVolumeClaim `json:"items,omitempty" description:"a list of persistent volume claims; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims"` } // PersistentVolumeClaimSpec describes the common attributes of storage devices // and allows a Source for provider-specific attributes type PersistentVolumeClaimSpec struct { // Contains the types of access modes required - AccessModes []PersistentVolumeAccessMode `json:"accessModes,omitempty" description:"the desired access modes the volume should have"` + AccessModes []PersistentVolumeAccessMode `json:"accessModes,omitempty" description:"the desired access modes the volume should have; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes-1"` // Resources represents the minimum resources required - Resources ResourceRequirements `json:"resources,omitempty" description:"the desired resources the volume should have"` + Resources ResourceRequirements `json:"resources,omitempty" description:"the desired resources the volume should have; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#resources"` // VolumeName is the binding reference to the PersistentVolume backing this claim VolumeName string `json:"volumeName,omitempty" description:"the binding reference to the persistent volume backing this claim"` } @@ -326,7 +326,7 @@ type PersistentVolumeClaimStatus struct { // Phase represents the current phase of PersistentVolumeClaim Phase PersistentVolumeClaimPhase `json:"phase,omitempty" description:"the current phase of the claim"` // AccessModes contains all ways the volume backing the PVC can be mounted - AccessModes []PersistentVolumeAccessMode `json:"accessModes,omitempty" description:"the actual access modes the volume has"` + AccessModes []PersistentVolumeAccessMode `json:"accessModes,omitempty" description:"the actual access modes the volume has; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes-1"` // Represents the actual resources of the underlying volume Capacity ResourceList `json:"capacity,omitempty" description:"the actual resources the volume has"` } @@ -371,26 +371,26 @@ const ( // HostPathVolumeSource represents bare host directory volume. type HostPathVolumeSource struct { - Path string `json:"path" description:"path of the directory on the host"` + Path string `json:"path" description:"path of the directory on the host; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath"` } type EmptyDirVolumeSource struct { // Optional: what type of storage medium should back this directory. // The default is "" which means to use the node's default medium. - Medium StorageMedium `json:"medium,omitempty" description:"type of storage used to back the volume; must be an empty string (default) or Memory"` + Medium StorageMedium `json:"medium,omitempty" description:"type of storage used to back the volume; must be an empty string (default) or Memory; see http://releases.k8s.io/HEAD/docs/volumes.md#emptydir"` } // GlusterfsVolumeSource represents a Glusterfs Mount that lasts the lifetime of a pod type GlusterfsVolumeSource struct { // Required: EndpointsName is the endpoint name that details Glusterfs topology - EndpointsName string `json:"endpoints" description:"gluster hosts endpoints name"` + EndpointsName string `json:"endpoints" description:"gluster hosts endpoints name; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod"` // Required: Path is the Glusterfs volume path - Path string `json:"path" description:"path to gluster volume"` + Path string `json:"path" description:"path to gluster volume; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod"` // Optional: Defaults to false (read/write). ReadOnly here will force // the Glusterfs volume to be mounted with read-only permissions - ReadOnly bool `json:"readOnly,omitempty" description:"glusterfs volume to be mounted with read-only permissions"` + ReadOnly bool `json:"readOnly,omitempty" description:"glusterfs volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod"` } // StorageMedium defines ways that storage can be allocated to a volume. @@ -399,25 +399,25 @@ type StorageMedium string // RBDVolumeSource represents a Rados Block Device Mount that lasts the lifetime of a pod type RBDVolumeSource struct { // Required: CephMonitors is a collection of Ceph monitors - CephMonitors []string `json:"monitors" description:"a collection of Ceph monitors"` + CephMonitors []string `json:"monitors" description:"a collection of Ceph monitors; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it"` // Required: RBDImage is the rados image name - RBDImage string `json:"image" description:"rados image name"` + RBDImage string `json:"image" description:"rados image name; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it"` // Required: Filesystem type to mount. // Must be a filesystem type supported by the host operating system. // Ex. "ext4", "xfs", "ntfs" // TODO: how do we prevent errors in the filesystem from compromising the machine - FSType string `json:"fsType,omitempty" description:"file system type to mount, such as ext4, xfs, ntfs"` + FSType string `json:"fsType,omitempty" description:"file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it"` // Optional: RadosPool is the rados pool name,default is rbd - RBDPool string `json:"pool" description:"rados pool name; default is rbd; optional"` + RBDPool string `json:"pool" description:"rados pool name; default is rbd; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it"` // Optional: RBDUser is the rados user name, default is admin - RadosUser string `json:"user" description:"rados user name; default is admin; optional"` + RadosUser string `json:"user" description:"rados user name; default is admin; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it"` // Optional: Keyring is the path to key ring for RBDUser, default is /etc/ceph/keyring - Keyring string `json:"keyring" description:"keyring is the path to key ring for rados user; default is /etc/ceph/keyring; optional"` + Keyring string `json:"keyring" description:"keyring is the path to key ring for rados user; default is /etc/ceph/keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it"` // Optional: SecretRef is name of the authentication secret for RBDUser, default is empty. - SecretRef *LocalObjectReference `json:"secretRef" description:"name of a secret to authenticate the RBD user; if provided overrides keyring; optional"` + SecretRef *LocalObjectReference `json:"secretRef" description:"name of a secret to authenticate the RBD user; if provided overrides keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it"` // Optional: Defaults to false (read/write). ReadOnly here will force // the ReadOnly setting in VolumeMounts. - ReadOnly bool `json:"readOnly,omitempty" description:"rbd volume to be mounted with read-only permissions"` + ReadOnly bool `json:"readOnly,omitempty" description:"rbd volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it"` } const ( @@ -442,19 +442,19 @@ const ( // A GCE PD can only be mounted as read/write once. type GCEPersistentDiskVolumeSource struct { // Unique name of the PD resource. Used to identify the disk in GCE - PDName string `json:"pdName" description:"unique name of the PD resource in GCE"` + PDName string `json:"pdName" description:"unique name of the PD resource in GCE; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk"` // Required: Filesystem type to mount. // Must be a filesystem type supported by the host operating system. // Ex. "ext4", "xfs", "ntfs" // TODO: how do we prevent errors in the filesystem from compromising the machine - FSType string `json:"fsType" description:"file system type to mount, such as ext4, xfs, ntfs"` + FSType string `json:"fsType" description:"file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk"` // Optional: Partition on the disk to mount. // If omitted, kubelet will attempt to mount the device name. // Ex. For /dev/sda1, this field is "1", for /dev/sda, this field is 0 or empty. - Partition int `json:"partition,omitempty" description:"partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted"` + Partition int `json:"partition,omitempty" description:"partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk"` // Optional: Defaults to false (read/write). ReadOnly here will force // the ReadOnly setting in VolumeMounts. - ReadOnly bool `json:"readOnly,omitempty" description:"read-only if true, read-write otherwise (false or unspecified)"` + ReadOnly bool `json:"readOnly,omitempty" description:"read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk"` } // AWSElasticBlockStoreVolumeSource represents a Persistent Disk resource in AWS. @@ -464,19 +464,19 @@ type GCEPersistentDiskVolumeSource struct { // A AWS PD can only be mounted on a single machine. type AWSElasticBlockStoreVolumeSource struct { // Unique id of the PD resource. Used to identify the disk in AWS - VolumeID string `json:"volumeID" description:"unique id of the PD resource in AWS"` + VolumeID string `json:"volumeID" description:"unique id of the PD resource in AWS; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore"` // Required: Filesystem type to mount. // Must be a filesystem type supported by the host operating system. // Ex. "ext4", "xfs", "ntfs" // TODO: how do we prevent errors in the filesystem from compromising the machine - FSType string `json:"fsType" description:"file system type to mount, such as ext4, xfs, ntfs"` + FSType string `json:"fsType" description:"file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore"` // Optional: Partition on the disk to mount. // If omitted, kubelet will attempt to mount the device name. // Ex. For /dev/sda1, this field is "1", for /dev/sda, this field 0 or empty. - Partition int `json:"partition,omitempty" description:"partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted"` + Partition int `json:"partition,omitempty" description:"partition on the disk to mount (e.g., '1' for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore"` // Optional: Defaults to false (read/write). ReadOnly here will force // the ReadOnly setting in VolumeMounts. - ReadOnly bool `json:"readOnly,omitempty" description:"read-only if true, read-write otherwise (false or unspecified)"` + ReadOnly bool `json:"readOnly,omitempty" description:"read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore"` } // GitRepoVolumeSource represents a volume that is pulled from git when the pod is created. @@ -492,20 +492,20 @@ type GitRepoVolumeSource struct { // http://releases.k8s.io/HEAD/docs/design/secrets.md type SecretVolumeSource struct { // Name of the secret in the pod's namespace to use - SecretName string `json:"secretName" description:"secretName is the name of a secret in the pod's namespace"` + SecretName string `json:"secretName" description:"secretName is the name of a secret in the pod's namespace; see http://releases.k8s.io/HEAD/docs/volumes.md#secrets"` } // NFSVolumeSource represents an NFS mount that lasts the lifetime of a pod type NFSVolumeSource struct { // Server is the hostname or IP address of the NFS server - Server string `json:"server" description:"the hostname or IP address of the NFS server"` + Server string `json:"server" description:"the hostname or IP address of the NFS server; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs"` // Path is the exported NFS share - Path string `json:"path" description:"the path that is exported by the NFS server"` + Path string `json:"path" description:"the path that is exported by the NFS server; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs"` // Optional: Defaults to false (read/write). ReadOnly here will force // the NFS export to be mounted with read-only permissions - ReadOnly bool `json:"readOnly,omitempty" description:"forces the NFS export to be mounted with read-only permissions"` + ReadOnly bool `json:"readOnly,omitempty" description:"forces the NFS export to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs"` } // A ISCSI Disk can only be mounted as read/write once. @@ -626,9 +626,9 @@ type Probe struct { // The action taken to determine the health of a container Handler `json:",inline"` // Length of time before health checking is activated. In seconds. - InitialDelaySeconds int64 `json:"initialDelaySeconds,omitempty" description:"number of seconds after the container has started before liveness probes are initiated"` + InitialDelaySeconds int64 `json:"initialDelaySeconds,omitempty" description:"number of seconds after the container has started before liveness probes are initiated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes"` // Length of time before health checking times out. In seconds. - TimeoutSeconds int64 `json:"timeoutSeconds,omitempty" description:"number of seconds after which liveness probes timeout; defaults to 1 second"` + TimeoutSeconds int64 `json:"timeoutSeconds,omitempty" description:"number of seconds after which liveness probes timeout; defaults to 1 second; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes"` } // PullPolicy describes a policy for if/when to pull a container image @@ -657,12 +657,12 @@ type Capabilities struct { // ResourceRequirements describes the compute resource requirements. type ResourceRequirements struct { // Limits describes the maximum amount of compute resources required. - Limits ResourceList `json:"limits,omitempty" description:"Maximum amount of compute resources allowed"` + Limits ResourceList `json:"limits,omitempty" description:"Maximum amount of compute resources allowed; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications"` // Requests describes the minimum amount of compute resources required. // Note: 'Requests' are honored only for Persistent Volumes as of now. // TODO: Update the scheduler to use 'Requests' in addition to 'Limits'. If Request is omitted for a container, // it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value - Requests ResourceList `json:"requests,omitempty" description:"Minimum amount of resources requested; requests are honored only for persistent volumes as of now"` + Requests ResourceList `json:"requests,omitempty" description:"Minimum amount of resources requested; requests are honored only for persistent volumes as of now; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications"` } const ( @@ -676,34 +676,34 @@ type Container struct { // have a unique name. Name string `json:"name" description:"name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated"` // Optional. - Image string `json:"image,omitempty" description:"Docker image name"` + Image string `json:"image,omitempty" description:"Docker image name; see http://releases.k8s.io/HEAD/docs/images.md"` // Optional: The docker image's entrypoint is used if this is not provided; cannot be updated. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax // can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, // regardless of whether the variable exists or not. - Command []string `json:"command,omitempty" description:"entrypoint array; not executed within a shell; the docker image's entrypoint is used if this is not provided; cannot be updated; variable references $(VAR_NAME) are expanded using the container's environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not"` + Command []string `json:"command,omitempty" description:"entrypoint array; not executed within a shell; the docker image's entrypoint is used if this is not provided; cannot be updated; variable references $(VAR_NAME) are expanded using the container's environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not; see http://releases.k8s.io/HEAD/docs/containers.md#containers-and-commands"` // Optional: The docker image's cmd is used if this is not provided; cannot be updated. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax // can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, // regardless of whether the variable exists or not. - Args []string `json:"args,omitempty" description:"command array; the docker image's cmd is used if this is not provided; arguments to the entrypoint; cannot be updated; variable references $(VAR_NAME) are expanded using the container's environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not"` + Args []string `json:"args,omitempty" description:"command array; the docker image's cmd is used if this is not provided; arguments to the entrypoint; cannot be updated; variable references $(VAR_NAME) are expanded using the container's environment variables; if a variable cannot be resolved, the reference in the input string will be unchanged; the $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME) ; escaped references will never be expanded, regardless of whether the variable exists or not; see http://releases.k8s.io/HEAD/docs/containers.md#containers-and-commands"` // Optional: Defaults to Docker's default. WorkingDir string `json:"workingDir,omitempty" description:"container's working directory; defaults to image's default; cannot be updated"` Ports []ContainerPort `json:"ports,omitempty" description:"list of ports to expose from the container; cannot be updated" patchStrategy:"merge" patchMergeKey:"containerPort"` Env []EnvVar `json:"env,omitempty" description:"list of environment variables to set in the container; cannot be updated" patchStrategy:"merge" patchMergeKey:"name"` - Resources ResourceRequirements `json:"resources,omitempty" description:"Compute Resources required by this container; cannot be updated"` + Resources ResourceRequirements `json:"resources,omitempty" description:"Compute Resources required by this container; cannot be updated; see http://releases.k8s.io/HEAD/docs/compute_resources.md"` VolumeMounts []VolumeMount `json:"volumeMounts,omitempty" description:"pod volumes to mount into the container's filesyste; cannot be updated" patchStrategy:"merge" patchMergeKey:"name"` - LivenessProbe *Probe `json:"livenessProbe,omitempty" description:"periodic probe of container liveness; container will be restarted if the probe fails; cannot be updated"` - ReadinessProbe *Probe `json:"readinessProbe,omitempty" description:"periodic probe of container service readiness; container will be removed from service endpoints if the probe fails; cannot be updated"` + LivenessProbe *Probe `json:"livenessProbe,omitempty" description:"periodic probe of container liveness; container will be restarted if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes"` + ReadinessProbe *Probe `json:"readinessProbe,omitempty" description:"periodic probe of container service readiness; container will be removed from service endpoints if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes"` Lifecycle *Lifecycle `json:"lifecycle,omitempty" description:"actions that the management system should take in response to container lifecycle events; cannot be updated"` // Optional: Defaults to /dev/termination-log TerminationMessagePath string `json:"terminationMessagePath,omitempty" description:"path at which the file to which the container's termination message will be written is mounted into the container's filesystem; message written is intended to be brief final status, such as an assertion failure message; defaults to /dev/termination-log; cannot be updated"` // Optional: Policy for pulling images for this container - ImagePullPolicy PullPolicy `json:"imagePullPolicy,omitempty" description:"image pull policy; one of Always, Never, IfNotPresent; defaults to Always if :latest tag is specified, or IfNotPresent otherwise; cannot be updated"` + ImagePullPolicy PullPolicy `json:"imagePullPolicy,omitempty" description:"image pull policy; one of Always, Never, IfNotPresent; defaults to Always if :latest tag is specified, or IfNotPresent otherwise; cannot be updated; see http://releases.k8s.io/HEAD/docs/images.md#updating-images"` // Optional: SecurityContext defines the security options the pod should be run with - SecurityContext *SecurityContext `json:"securityContext,omitempty" description:"security options the pod should run with"` + SecurityContext *SecurityContext `json:"securityContext,omitempty" description:"security options the pod should run with; see http://releases.k8s.io/HEAD/docs/security_context.md"` } // Handler defines a specific action that should be taken @@ -725,10 +725,10 @@ type Handler struct { type Lifecycle struct { // PostStart is called immediately after a container is created. If the handler fails, the container // is terminated and restarted. - PostStart *Handler `json:"postStart,omitempty" description:"called immediately after a container is started; if the handler fails, the container is terminated and restarted according to its restart policy; other management of the container blocks until the hook completes"` + PostStart *Handler `json:"postStart,omitempty" description:"called immediately after a container is started; if the handler fails, the container is terminated and restarted according to its restart policy; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/container-environment.md#hook-details"` // PreStop is called immediately before a container is terminated. The reason for termination is // passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. - PreStop *Handler `json:"preStop,omitempty" description:"called before a container is terminated; the container is terminated after the handler completes; other management of the container blocks until the hook completes"` + PreStop *Handler `json:"preStop,omitempty" description:"called before a container is terminated; the container is terminated after the handler completes; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/container-environment.md#hook-details"` } type ConditionStatus string @@ -784,9 +784,9 @@ type ContainerStatus struct { RestartCount int `json:"restartCount" description:"the number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed"` // TODO(dchen1107): Which image the container is running with? // The image the container is running - Image string `json:"image" description:"image of the container"` + Image string `json:"image" description:"image of the container; see http://releases.k8s.io/HEAD/docs/images.md"` ImageID string `json:"imageID" description:"ID of the container's image"` - ContainerID string `json:"containerID,omitempty" description:"container's ID in the format 'docker://'"` + ContainerID string `json:"containerID,omitempty" description:"container's ID in the format 'docker://'; see http://releases.k8s.io/HEAD/docs/container-environment.md#container-information"` } // PodPhase is a label for the condition of a pod at the current time. @@ -825,9 +825,9 @@ const ( // TODO: add LastTransitionTime, Reason, Message to match NodeCondition api. type PodCondition struct { // Type is the type of the condition - Type PodConditionType `json:"type" description:"kind of the condition, currently only Ready"` + Type PodConditionType `json:"type" description:"kind of the condition, currently only Ready; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions"` // Status is the status of the condition - Status ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"` + Status ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions"` } // RestartPolicy describes how the container should be restarted. @@ -858,10 +858,10 @@ const ( // PodSpec is a description of a pod type PodSpec struct { - Volumes []Volume `json:"volumes,omitempty" description:"list of volumes that can be mounted by containers belonging to the pod" patchStrategy:"merge" patchMergeKey:"name"` + Volumes []Volume `json:"volumes,omitempty" description:"list of volumes that can be mounted by containers belonging to the pod; see http://releases.k8s.io/HEAD/docs/volumes.md" patchStrategy:"merge" patchMergeKey:"name"` // Required: there must be at least one container in a pod. - Containers []Container `json:"containers" description:"list of containers belonging to the pod; cannot be updated; containers cannot currently be added or removed; there must be at least one container in a Pod" patchStrategy:"merge" patchMergeKey:"name"` - RestartPolicy RestartPolicy `json:"restartPolicy,omitempty" description:"restart policy for all containers within the pod; one of Always, OnFailure, Never; defaults to Always"` + Containers []Container `json:"containers" description:"list of containers belonging to the pod; cannot be updated; containers cannot currently be added or removed; there must be at least one container in a Pod; see http://releases.k8s.io/HEAD/docs/containers.md" patchStrategy:"merge" patchMergeKey:"name"` + RestartPolicy RestartPolicy `json:"restartPolicy,omitempty" description:"restart policy for all containers within the pod; one of Always, OnFailure, Never; defaults to Always; see http://releases.k8s.io/HEAD/docs/pod-states.md#restartpolicy"` // Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. // Value must be non-negative integer. The value zero indicates delete immediately. // If this value is nil, the default grace period will be used instead. @@ -873,10 +873,10 @@ type PodSpec struct { // Optional: Set DNS policy. Defaults to "ClusterFirst" DNSPolicy DNSPolicy `json:"dnsPolicy,omitempty" description:"DNS policy for containers within the pod; one of 'ClusterFirst' or 'Default'"` // NodeSelector is a selector which must be true for the pod to fit on a node - NodeSelector map[string]string `json:"nodeSelector,omitempty" description:"selector which must match a node's labels for the pod to be scheduled on that node"` + NodeSelector map[string]string `json:"nodeSelector,omitempty" description:"selector which must match a node's labels for the pod to be scheduled on that node; see http://releases.k8s.io/HEAD/examples/node-selection/README.md"` // ServiceAccountName is the name of the ServiceAccount to use to run this pod - ServiceAccountName string `json:"serviceAccountName,omitempty" description:"name of the ServiceAccount to use to run this pod"` + ServiceAccountName string `json:"serviceAccountName,omitempty" description:"name of the ServiceAccount to use to run this pod; see http://releases.k8s.io/HEAD/docs/service_accounts.md"` // NodeName is a request to schedule this pod onto a specific node. If it is non-empty, // the scheduler simply schedules this pod onto that node, assuming that it fits resource @@ -889,14 +889,14 @@ type PodSpec struct { // ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. // If specified, these secrets will be passed to individual puller implementations for them to use. For example, // in the case of docker, only DockerConfig type secrets are honored. - ImagePullSecrets []LocalObjectReference `json:"imagePullSecrets,omitempty" description:"list of references to secrets in the same namespace available for pulling the container images" patchStrategy:"merge" patchMergeKey:"name"` + ImagePullSecrets []LocalObjectReference `json:"imagePullSecrets,omitempty" description:"list of references to secrets in the same namespace available for pulling the container images; see http://releases.k8s.io/HEAD/docs/images.md#specifying-imagepullsecrets-on-a-pod" patchStrategy:"merge" patchMergeKey:"name"` } // PodStatus represents information about the status of a pod. Status may trail the actual // state of a system. type PodStatus struct { - Phase PodPhase `json:"phase,omitempty" description:"current condition of the pod."` - Conditions []PodCondition `json:"conditions,omitempty" description:"current service state of pod" patchStrategy:"merge" patchMergeKey:"type"` + Phase PodPhase `json:"phase,omitempty" description:"current condition of the pod; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-phase"` + Conditions []PodCondition `json:"conditions,omitempty" description:"current service state of pod; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions" patchStrategy:"merge" patchMergeKey:"type"` // A human readable message indicating details about why the pod is in this state. Message string `json:"message,omitempty" description:"human readable message indicating details about why the pod is in this condition"` // A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk' @@ -909,7 +909,7 @@ type PodStatus struct { // The list has one entry per container in the manifest. Each entry is currently the output // of `docker inspect`. - ContainerStatuses []ContainerStatus `json:"containerStatuses,omitempty" description:"list of container statuses"` + ContainerStatuses []ContainerStatus `json:"containerStatuses,omitempty" description:"list of container statuses; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-statuses"` } // PodStatusResult is a wrapper for PodStatus returned by kubelet that can be encode/decoded @@ -940,7 +940,7 @@ type PodList struct { TypeMeta `json:",inline"` ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds"` - Items []Pod `json:"items" description:"list of pods"` + Items []Pod `json:"items" description:"list of pods; see http://releases.k8s.io/HEAD/docs/pods.md"` } // PodTemplateSpec describes the data a pod should have when created from a template @@ -972,11 +972,11 @@ type PodTemplateList struct { // ReplicationControllerSpec is the specification of a replication controller. type ReplicationControllerSpec struct { // Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. - Replicas *int `json:"replicas,omitempty" description:"number of replicas desired; defaults to 1"` + Replicas *int `json:"replicas,omitempty" description:"number of replicas desired; defaults to 1; see http://releases.k8s.io/HEAD/docs/replication-controller.md#what-is-a-replication-controller"` // Selector is a label query over pods that should match the Replicas count. // If Selector is empty, it is defaulted to the labels present on the Pod template. - Selector map[string]string `json:"selector,omitempty" description:"label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template"` + Selector map[string]string `json:"selector,omitempty" description:"label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template; see http://releases.k8s.io/HEAD/docs/labels.md#label-selectors"` // TemplateRef is a reference to an object that describes the pod that will be created if // insufficient replicas are detected. @@ -985,14 +985,14 @@ type ReplicationControllerSpec struct { // Template is the object that describes the pod that will be created if // insufficient replicas are detected. This takes precedence over a // TemplateRef. - Template *PodTemplateSpec `json:"template,omitempty" description:"object that describes the pod that will be created if insufficient replicas are detected; takes precendence over templateRef"` + Template *PodTemplateSpec `json:"template,omitempty" description:"object that describes the pod that will be created if insufficient replicas are detected; takes precendence over templateRef; see http://releases.k8s.io/HEAD/docs/replication-controller.md#pod-template"` } // ReplicationControllerStatus represents the current status of a replication // controller. type ReplicationControllerStatus struct { // Replicas is the number of actual replicas. - Replicas int `json:"replicas" description:"most recently oberved number of replicas"` + Replicas int `json:"replicas" description:"most recently oberved number of replicas; see http://releases.k8s.io/HEAD/docs/replication-controller.md#what-is-a-replication-controller"` // ObservedGeneration is the most recent generation observed by the controller. ObservedGeneration int64 `json:"observedGeneration,omitempty" description:"reflects the generation of the most recently observed replication controller"` @@ -1018,7 +1018,7 @@ type ReplicationControllerList struct { TypeMeta `json:",inline"` ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` - Items []ReplicationController `json:"items" description:"list of replication controllers"` + Items []ReplicationController `json:"items" description:"list of replication controllers; see http://releases.k8s.io/HEAD/docs/replication-controller.md"` } // Session Affinity Type string @@ -1079,27 +1079,27 @@ type LoadBalancerIngress struct { // ServiceSpec describes the attributes that a user creates on a service type ServiceSpec struct { // Required: The list of ports that are exposed by this service. - Ports []ServicePort `json:"ports" description:"ports exposed by the service"` + Ports []ServicePort `json:"ports" description:"ports exposed by the service; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies"` // This service will route traffic to pods having labels matching this selector. If null, no endpoints will be automatically created. If empty, all pods will be selected. - Selector map[string]string `json:"selector,omitempty" description:"label keys and values that must match in order to receive traffic for this service; if empty, all pods are selected, if not specified, endpoints must be manually specified"` + Selector map[string]string `json:"selector,omitempty" description:"label keys and values that must match in order to receive traffic for this service; if empty, all pods are selected, if not specified, endpoints must be manually specified; see http://releases.k8s.io/HEAD/docs/services.md#overview"` // ClusterIP is usually assigned by the master. If specified by the user // we will try to respect it or else fail the request. This field can // not be changed by updates. // Valid values are None, empty string (""), or a valid IP address // None can be specified for headless services when proxying is not required - ClusterIP string `json:"clusterIP,omitempty" description:"IP address of the service; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; cannot be updated; 'None' can be specified for a headless service when proxying is not required"` + ClusterIP string `json:"clusterIP,omitempty" description:"IP address of the service; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; cannot be updated; 'None' can be specified for a headless service when proxying is not required; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies"` // Type determines how the service will be exposed. Valid options: ClusterIP, NodePort, LoadBalancer - Type ServiceType `json:"type,omitempty" description:"type of this service; must be ClusterIP, NodePort, or LoadBalancer; defaults to ClusterIP"` + Type ServiceType `json:"type,omitempty" description:"type of this service; must be ClusterIP, NodePort, or LoadBalancer; defaults to ClusterIP; see http://releases.k8s.io/HEAD/docs/services.md#external-services"` // Deprecated. PublicIPs are used by external load balancers, or can be set by // users to handle external traffic that arrives at a node. DeprecatedPublicIPs []string `json:"deprecatedPublicIPs,omitempty" description:"deprecated. externally visible IPs (e.g. load balancers) that should be proxied to this service"` // Optional: Supports "ClientIP" and "None". Used to maintain session affinity. - SessionAffinity ServiceAffinity `json:"sessionAffinity,omitempty" description:"enable client IP based session affinity; must be ClientIP or None; defaults to None"` + SessionAffinity ServiceAffinity `json:"sessionAffinity,omitempty" description:"enable client IP based session affinity; must be ClientIP or None; defaults to None; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies"` } type ServicePort struct { @@ -1120,11 +1120,11 @@ type ServicePort struct { // If this is a string, it will be looked up as a named port in the // target Pod's container ports. If this is not specified, the value // of Port is used (an identity map). - TargetPort util.IntOrString `json:"targetPort,omitempty" description:"number or name of the port to access on the pods targeted by the service; defaults to the service port; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME"` + TargetPort util.IntOrString `json:"targetPort,omitempty" description:"number or name of the port to access on the pods targeted by the service; defaults to the service port; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME; see http://releases.k8s.io/HEAD/docs/services.md#defining-a-service"` // The port on each node on which this service is exposed. // Default is to auto-allocate a port if the ServiceType of this Service requires one. - NodePort int `json:"nodePort" description:"the port on each node on which this service is exposed when type=NodePort or LoadBalancer; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail"` + NodePort int `json:"nodePort" description:"the port on each node on which this service is exposed when type=NodePort or LoadBalancer; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; see http://releases.k8s.io/HEAD/docs/services.md#type--nodeport"` } // Service is a named abstraction of software service (for example, mysql) consisting of local port @@ -1164,12 +1164,12 @@ type ServiceAccount struct { ObjectMeta `json:"metadata,omitempty" description:"standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount - Secrets []ObjectReference `json:"secrets,omitempty" description:"list of secrets that can be used by pods running as this service account" patchStrategy:"merge" patchMergeKey:"name"` + Secrets []ObjectReference `json:"secrets,omitempty" description:"list of secrets that can be used by pods running as this service account; see http://releases.k8s.io/HEAD/docs/secrets.md" patchStrategy:"merge" patchMergeKey:"name"` // ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images // in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets // can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. - ImagePullSecrets []LocalObjectReference `json:"imagePullSecrets,omitempty" description:"list of references to secrets in the same namespace available for pulling container images"` + ImagePullSecrets []LocalObjectReference `json:"imagePullSecrets,omitempty" description:"list of references to secrets in the same namespace available for pulling container images; see http://releases.k8s.io/HEAD/docs/secrets.md#manually-specifying-an-imagepullsecret"` } // ServiceAccountList is a list of ServiceAccount objects @@ -1177,7 +1177,7 @@ type ServiceAccountList struct { TypeMeta `json:",inline"` ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` - Items []ServiceAccount `json:"items" description:"list of ServiceAccounts"` + Items []ServiceAccount `json:"items" description:"list of ServiceAccounts; see http://releases.k8s.io/HEAD/docs/service_accounts.md#service-accounts"` } // Endpoints is a collection of endpoints that implement the actual service. Example: @@ -1255,7 +1255,7 @@ type NodeSpec struct { // ID of the node assigned by the cloud provider ProviderID string `json:"providerID,omitempty" description:"ID of the node assigned by the cloud provider in the format: ://"` // Unschedulable controls node schedulability of new pods. By default node is schedulable. - Unschedulable bool `json:"unschedulable,omitempty" description:"disable pod scheduling on the node"` + Unschedulable bool `json:"unschedulable,omitempty" description:"disable pod scheduling on the node; see http://releases.k8s.io/HEAD/docs/node.md#manual-node-administration"` } // NodeSystemInfo is a set of ids/uuids to uniquely identify the node. @@ -1281,16 +1281,16 @@ type NodeSystemInfo struct { // NodeStatus is information about the current status of a node. type NodeStatus struct { // Capacity represents the available resources of a node. - // see http://releases.k8s.io/HEAD/docs/resources.md for more details. - Capacity ResourceList `json:"capacity,omitempty" description:"compute resource capacity of the node; http://releases.k8s.io/HEAD/docs/resources.md"` + // see http://releases.k8s.io/HEAD/docs/compute_resources.md for more details. + Capacity ResourceList `json:"capacity,omitempty" description:"compute resource capacity of the node; see http://releases.k8s.io/HEAD/docs/compute_resources.md"` // NodePhase is the current lifecycle phase of the node. - Phase NodePhase `json:"phase,omitempty" description:"most recently observed lifecycle phase of the node"` + Phase NodePhase `json:"phase,omitempty" description:"most recently observed lifecycle phase of the node; see http://releases.k8s.io/HEAD/docs/node.md#node-phase"` // Conditions is an array of current node conditions. - Conditions []NodeCondition `json:"conditions,omitempty" description:"list of node conditions observed" patchStrategy:"merge" patchMergeKey:"type"` + Conditions []NodeCondition `json:"conditions,omitempty" description:"list of node conditions observed; see http://releases.k8s.io/HEAD/docs/node.md#node-condition" patchStrategy:"merge" patchMergeKey:"type"` // Queried from cloud provider, if available. - Addresses []NodeAddress `json:"addresses,omitempty" description:"list of addresses reachable to the node" patchStrategy:"merge" patchMergeKey:"type"` + Addresses []NodeAddress `json:"addresses,omitempty" description:"list of addresses reachable to the node; see http://releases.k8s.io/HEAD/docs/node.md#node-addresses" patchStrategy:"merge" patchMergeKey:"type"` // NodeSystemInfo is a set of ids/uuids to uniquely identify the node - NodeInfo NodeSystemInfo `json:"nodeInfo,omitempty" description:"set of ids/uuids to uniquely identify the node"` + NodeInfo NodeSystemInfo `json:"nodeInfo,omitempty" description:"set of ids/uuids to uniquely identify the node; see http://releases.k8s.io/HEAD/docs/node.md#node-info"` } type NodePhase string @@ -1384,13 +1384,13 @@ const ( // NamespaceSpec describes the attributes on a Namespace type NamespaceSpec struct { // Finalizers is an opaque list of values that must be empty to permanently remove object from storage - Finalizers []FinalizerName `json:"finalizers,omitempty" description:"an opaque list of values that must be empty to permanently remove object from storage"` + Finalizers []FinalizerName `json:"finalizers,omitempty" description:"an opaque list of values that must be empty to permanently remove object from storage; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers"` } // NamespaceStatus is information about the current status of a Namespace. type NamespaceStatus struct { // Phase is the current lifecycle phase of the namespace. - Phase NamespacePhase `json:"phase,omitempty" description:"phase is the current lifecycle phase of the namespace"` + Phase NamespacePhase `json:"phase,omitempty" description:"phase is the current lifecycle phase of the namespace; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases"` } type NamespacePhase string @@ -1422,7 +1422,7 @@ type NamespaceList struct { ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // Items is the list of Namespace objects in the list - Items []Namespace `json:"items" description:"items is the list of Namespace objects in the list"` + Items []Namespace `json:"items" description:"items is the list of Namespace objects in the list; see http://releases.k8s.io/HEAD/docs/namespaces.md"` } // Binding ties one object to another - for example, a pod is bound to a node by a scheduler. @@ -1510,7 +1510,7 @@ type Status struct { ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // One of: "Success" or "Failure" - Status string `json:"status,omitempty" description:"status of the operation; either Success, or Failure"` + Status string `json:"status,omitempty" description:"status of the operation; either Success, or Failure; see http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status"` // A human-readable description of the status of this operation. Message string `json:"message,omitempty" description:"human-readable description of the status of this operation"` // A machine-readable description of why this operation is in the @@ -1539,7 +1539,7 @@ type StatusDetails struct { Name string `json:"name,omitempty" description:"the name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)"` // The kind attribute of the resource associated with the status StatusReason. // On some operations may differ from the requested resource Kind. - Kind string `json:"kind,omitempty" description:"the kind attribute of the resource associated with the status StatusReason; on some operations may differ from the requested resource Kind"` + Kind string `json:"kind,omitempty" description:"the kind attribute of the resource associated with the status StatusReason; on some operations may differ from the requested resource Kind; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds"` // The Causes array includes more details associated with the StatusReason // failure. Not all StatusReasons may provide detailed causes. Causes []StatusCause `json:"causes,omitempty" description:"the Causes array includes more details associated with the StatusReason failure; not all StatusReasons may provide detailed causes"` @@ -1660,10 +1660,10 @@ const ( // ObjectReference contains enough information to let you inspect or modify the referred object. type ObjectReference struct { - Kind string `json:"kind,omitempty" description:"kind of the referent"` - Namespace string `json:"namespace,omitempty" description:"namespace of the referent"` - Name string `json:"name,omitempty" description:"name of the referent"` - UID types.UID `json:"uid,omitempty" description:"uid of the referent"` + Kind string `json:"kind,omitempty" description:"kind of the referent; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds"` + Namespace string `json:"namespace,omitempty" description:"namespace of the referent; see http://releases.k8s.io/HEAD/docs/namespaces.md"` + Name string `json:"name,omitempty" description:"name of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#names"` + UID types.UID `json:"uid,omitempty" description:"uid of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#uids"` APIVersion string `json:"apiVersion,omitempty" description:"API version of the referent"` ResourceVersion string `json:"resourceVersion,omitempty" description:"specific resourceVersion to which this reference is made, if any: http://releases.k8s.io/HEAD/docs/api-conventions.md#concurrency-control-and-consistency"` @@ -1681,7 +1681,7 @@ type ObjectReference struct { // LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. type LocalObjectReference struct { //TODO: Add other useful fields. apiVersion, kind, uid? - Name string `json:"name,omitempty" description:"name of the referent"` + Name string `json:"name,omitempty" description:"name of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#names"` } type SerializedReference struct { @@ -1786,7 +1786,7 @@ type LimitRangeList struct { ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // Items is a list of LimitRange objects - Items []LimitRange `json:"items" description:"items is a list of LimitRange objects"` + Items []LimitRange `json:"items" description:"items is a list of LimitRange objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md"` } // The following identify resource constants for Kubernetes object types @@ -1808,13 +1808,13 @@ const ( // ResourceQuotaSpec defines the desired hard limits to enforce for Quota type ResourceQuotaSpec struct { // Hard is the set of desired hard limits for each named resource - Hard ResourceList `json:"hard,omitempty" description:"hard is the set of desired hard limits for each named resource"` + Hard ResourceList `json:"hard,omitempty" description:"hard is the set of desired hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota"` } // ResourceQuotaStatus defines the enforced hard limits and observed use type ResourceQuotaStatus struct { // Hard is the set of enforced hard limits for each named resource - Hard ResourceList `json:"hard,omitempty" description:"hard is the set of enforced hard limits for each named resource"` + Hard ResourceList `json:"hard,omitempty" description:"hard is the set of enforced hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota"` // Used is the current observed total usage of the resource in the namespace Used ResourceList `json:"used,omitempty" description:"used is the current observed total usage of the resource in the namespace"` } @@ -1837,7 +1837,7 @@ type ResourceQuotaList struct { ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` // Items is a list of ResourceQuota objects - Items []ResourceQuota `json:"items" description:"items is a list of ResourceQuota objects"` + Items []ResourceQuota `json:"items" description:"items is a list of ResourceQuota objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota"` } // Secret holds secret data of a certain type. The total bytes of the values in @@ -1897,7 +1897,7 @@ type SecretList struct { TypeMeta `json:",inline"` ListMeta `json:"metadata,omitempty" description:"standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata"` - Items []Secret `json:"items" description:"items is a list of secret objects"` + Items []Secret `json:"items" description:"items is a list of secret objects; see http://releases.k8s.io/HEAD/docs/secrets.md"` } // Type and constants for component health validation. @@ -1937,33 +1937,33 @@ type ComponentStatusList struct { type SecurityContext struct { // Capabilities are the capabilities to add/drop when running the container // Must match Container.Capabilities or be unset. Will be defaulted to Container.Capabilities if left unset - Capabilities *Capabilities `json:"capabilities,omitempty" description:"the linux capabilites that should be added or removed"` + Capabilities *Capabilities `json:"capabilities,omitempty" description:"the linux capabilites that should be added or removed; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context"` // Run the container in privileged mode // Must match Container.Privileged or be unset. Will be defaulted to Container.Privileged if left unset - Privileged *bool `json:"privileged,omitempty" description:"run the container in privileged mode"` + Privileged *bool `json:"privileged,omitempty" description:"run the container in privileged mode; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context"` // SELinuxOptions are the labels to be applied to the container // and volumes - SELinuxOptions *SELinuxOptions `json:"seLinuxOptions,omitempty" description:"options that control the SELinux labels applied"` + SELinuxOptions *SELinuxOptions `json:"seLinuxOptions,omitempty" description:"options that control the SELinux labels applied; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context"` // RunAsUser is the UID to run the entrypoint of the container process. - RunAsUser *int64 `json:"runAsUser,omitempty" description:"the user id that runs the first process in the container"` + RunAsUser *int64 `json:"runAsUser,omitempty" description:"the user id that runs the first process in the container; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context"` } // SELinuxOptions are the labels to be applied to the container type SELinuxOptions struct { // SELinux user label - User string `json:"user,omitempty" description:"the user label to apply to the container"` + User string `json:"user,omitempty" description:"the user label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md"` // SELinux role label - Role string `json:"role,omitempty" description:"the role label to apply to the container"` + Role string `json:"role,omitempty" description:"the role label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md"` // SELinux type label - Type string `json:"type,omitempty" description:"the type label to apply to the container"` + Type string `json:"type,omitempty" description:"the type label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md"` // SELinux level label. - Level string `json:"level,omitempty" description:"the level label to apply to the container"` + Level string `json:"level,omitempty" description:"the level label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md"` } // RangeAllocation is not a public type