diff --git a/federation/apis/federation/v1beta1/types_swagger_doc_generated.go b/federation/apis/federation/v1beta1/types_swagger_doc_generated.go
new file mode 100644
index 00000000000..7c49777fb98
--- /dev/null
+++ b/federation/apis/federation/v1beta1/types_swagger_doc_generated.go
@@ -0,0 +1,96 @@
+/*
+Copyright 2016 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+// This file contains a collection of methods that can be used from go-restful to
+// generate Swagger API documentation for its models. Please read this PR for more
+// information on the implementation: https://github.com/emicklei/go-restful/pull/215
+//
+// TODOs are ignored from the parser (e.g. TODO(andronat):... || TODO:...) if and only if
+// they are on one line! For multiple line or blocks that you want to ignore use ---.
+// Any context after a --- is ignored.
+//
+// Those methods can be generated by using hack/update-generated-swagger-docs.sh
+
+// AUTO-GENERATED FUNCTIONS START HERE
+var map_Cluster = map[string]string{
+ "": "Information about a registered cluster in a federated kubernetes setup. Clusters are not namespaced and have unique names in the federation.",
+ "metadata": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
+ "spec": "Spec defines the behavior of the Cluster.",
+ "status": "Status describes the current status of a Cluster",
+}
+
+func (Cluster) SwaggerDoc() map[string]string {
+ return map_Cluster
+}
+
+var map_ClusterCondition = map[string]string{
+ "": "ClusterCondition describes current state of a cluster.",
+ "type": "Type of cluster condition, Complete or Failed.",
+ "status": "Status of the condition, one of True, False, Unknown.",
+ "lastProbeTime": "Last time the condition was checked.",
+ "lastTransitionTime": "Last time the condition transit from one status to another.",
+ "reason": "(brief) reason for the condition's last transition.",
+ "message": "Human readable message indicating details about last transition.",
+}
+
+func (ClusterCondition) SwaggerDoc() map[string]string {
+ return map_ClusterCondition
+}
+
+var map_ClusterList = map[string]string{
+ "": "A list of all the kubernetes clusters registered to the federation",
+ "metadata": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds",
+ "items": "List of Cluster objects.",
+}
+
+func (ClusterList) SwaggerDoc() map[string]string {
+ return map_ClusterList
+}
+
+var map_ClusterSpec = map[string]string{
+ "": "ClusterSpec describes the attributes of a kubernetes cluster.",
+ "serverAddressByClientCIDRs": "A map of client CIDR to server address. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR.",
+ "secretRef": "Name of the secret containing kubeconfig to access this cluster. The secret is read from the kubernetes cluster that is hosting federation control plane. Admin needs to ensure that the required secret exists. Secret should be in the same namespace where federation control plane is hosted and it should have kubeconfig in its data with key \"kubeconfig\". This will later be changed to a reference to secret in federation control plane when the federation control plane supports secrets. This can be left empty if the cluster allows insecure access.",
+}
+
+func (ClusterSpec) SwaggerDoc() map[string]string {
+ return map_ClusterSpec
+}
+
+var map_ClusterStatus = map[string]string{
+ "": "ClusterStatus is information about the current status of a cluster updated by cluster controller peridocally.",
+ "conditions": "Conditions is an array of current cluster conditions.",
+ "zones": "Zones is the list of avaliability zones in which the nodes of the cluster exist, e.g. 'us-east1-a'. These will always be in the same region.",
+ "region": "Region is the name of the region in which all of the nodes in the cluster exist. e.g. 'us-east1'.",
+}
+
+func (ClusterStatus) SwaggerDoc() map[string]string {
+ return map_ClusterStatus
+}
+
+var map_ServerAddressByClientCIDR = map[string]string{
+ "": "ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.",
+ "clientCIDR": "The CIDR with which clients can match their IP to figure out the server address that they should use.",
+ "serverAddress": "Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.",
+}
+
+func (ServerAddressByClientCIDR) SwaggerDoc() map[string]string {
+ return map_ServerAddressByClientCIDR
+}
+
+// AUTO-GENERATED FUNCTIONS END HERE
diff --git a/federation/apis/swagger-spec/api.json b/federation/apis/swagger-spec/api.json
index 11431a5a2f4..6ec7dba9c8e 100644
--- a/federation/apis/swagger-spec/api.json
+++ b/federation/apis/swagger-spec/api.json
@@ -3,6 +3,10 @@
"apiVersion": "",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/api",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/api",
diff --git a/federation/apis/swagger-spec/apis.json b/federation/apis/swagger-spec/apis.json
index 2f1f9d59995..dea7ec02cf7 100644
--- a/federation/apis/swagger-spec/apis.json
+++ b/federation/apis/swagger-spec/apis.json
@@ -3,6 +3,10 @@
"apiVersion": "",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/apis",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/apis",
diff --git a/federation/apis/swagger-spec/extensions.json b/federation/apis/swagger-spec/extensions.json
index 9e6eeb8b0fa..6d2375f1a61 100644
--- a/federation/apis/swagger-spec/extensions.json
+++ b/federation/apis/swagger-spec/extensions.json
@@ -3,6 +3,10 @@
"apiVersion": "",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/apis/extensions",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/apis/extensions",
diff --git a/federation/apis/swagger-spec/extensions_v1beta1.json b/federation/apis/swagger-spec/extensions_v1beta1.json
index b6becb37ac6..2622b2fd6b4 100644
--- a/federation/apis/swagger-spec/extensions_v1beta1.json
+++ b/federation/apis/swagger-spec/extensions_v1beta1.json
@@ -3,6 +3,10 @@
"apiVersion": "extensions/v1beta1",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/apis/extensions/v1beta1",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/apis/extensions/v1beta1/namespaces/{namespace}/ingresses",
@@ -2225,6 +2229,10 @@
"type": "string"
},
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."
+ },
+ "clusterName": {
+ "type": "string",
+ "description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
}
}
},
@@ -2357,7 +2365,7 @@
"properties": {
"path": {
"type": "string",
- "description": "Path is a extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend."
+ "description": "Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend."
},
"backend": {
"$ref": "v1beta1.IngressBackend",
@@ -2846,6 +2854,14 @@
"vsphereVolume": {
"$ref": "v1.VsphereVirtualDiskVolumeSource",
"description": "VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"
+ },
+ "quobyte": {
+ "$ref": "v1.QuobyteVolumeSource",
+ "description": "Quobyte represents a Quobyte mount on the host that shares a pod's lifetime"
+ },
+ "azureDisk": {
+ "$ref": "v1.AzureDiskVolumeSource",
+ "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."
}
}
},
@@ -2959,6 +2975,11 @@
"$ref": "v1.KeyToPath"
},
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'."
+ },
+ "defaultMode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."
}
}
},
@@ -2977,6 +2998,11 @@
"path": {
"type": "string",
"description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."
+ },
+ "mode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."
}
}
},
@@ -3241,6 +3267,11 @@
"$ref": "v1.DownwardAPIVolumeFile"
},
"description": "Items is a list of downward API volume file"
+ },
+ "defaultMode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."
}
}
},
@@ -3262,6 +3293,11 @@
"resourceFieldRef": {
"$ref": "v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."
+ },
+ "mode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."
}
}
},
@@ -3369,6 +3405,11 @@
"$ref": "v1.KeyToPath"
},
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'."
+ },
+ "defaultMode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."
}
}
},
@@ -3389,6 +3430,70 @@
}
}
},
+ "v1.QuobyteVolumeSource": {
+ "id": "v1.QuobyteVolumeSource",
+ "description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
+ "required": [
+ "registry",
+ "volume"
+ ],
+ "properties": {
+ "registry": {
+ "type": "string",
+ "description": "Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes"
+ },
+ "volume": {
+ "type": "string",
+ "description": "Volume is a string that references an already created Quobyte volume by name."
+ },
+ "readOnly": {
+ "type": "boolean",
+ "description": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false."
+ },
+ "user": {
+ "type": "string",
+ "description": "User to map volume access to Defaults to serivceaccount user"
+ },
+ "group": {
+ "type": "string",
+ "description": "Group to map volume access to Default is no group"
+ }
+ }
+ },
+ "v1.AzureDiskVolumeSource": {
+ "id": "v1.AzureDiskVolumeSource",
+ "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
+ "required": [
+ "diskName",
+ "diskURI"
+ ],
+ "properties": {
+ "diskName": {
+ "type": "string",
+ "description": "The Name of the data disk in the blob storage"
+ },
+ "diskURI": {
+ "type": "string",
+ "description": "The URI the data disk in the blob storage"
+ },
+ "cachingMode": {
+ "$ref": "v1.AzureDataDiskCachingMode",
+ "description": "Host Caching mode: None, Read Only, Read Write."
+ },
+ "fsType": {
+ "type": "string",
+ "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."
+ },
+ "readOnly": {
+ "type": "boolean",
+ "description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."
+ }
+ }
+ },
+ "v1.AzureDataDiskCachingMode": {
+ "id": "v1.AzureDataDiskCachingMode",
+ "properties": {}
+ },
"v1.Container": {
"id": "v1.Container",
"description": "A single application container that you want to run within a pod.",
@@ -3543,7 +3648,7 @@
"properties": {
"fieldRef": {
"$ref": "v1.ObjectFieldSelector",
- "description": "Selects a field of the pod; only name and namespace are supported."
+ "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP."
},
"resourceFieldRef": {
"$ref": "v1.ResourceFieldSelector",
@@ -3909,6 +4014,11 @@
"format": "int32",
"description": "The number of pods that have labels matching the labels of the pod template of the replicaset."
},
+ "readyReplicas": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of ready replicas for this replica set."
+ },
"observedGeneration": {
"type": "integer",
"format": "int64",
diff --git a/federation/apis/swagger-spec/federation.json b/federation/apis/swagger-spec/federation.json
index 45f52c88b0e..2c133632ffd 100644
--- a/federation/apis/swagger-spec/federation.json
+++ b/federation/apis/swagger-spec/federation.json
@@ -3,6 +3,10 @@
"apiVersion": "",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/apis/federation",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/apis/federation",
diff --git a/federation/apis/swagger-spec/federation_v1beta1.json b/federation/apis/swagger-spec/federation_v1beta1.json
index a25c32dd042..19b438e3600 100644
--- a/federation/apis/swagger-spec/federation_v1beta1.json
+++ b/federation/apis/swagger-spec/federation_v1beta1.json
@@ -3,6 +3,10 @@
"apiVersion": "federation/v1beta1",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/apis/federation/v1beta1",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/apis/federation/v1beta1/clusters",
@@ -639,6 +643,7 @@
"models": {
"v1beta1.ClusterList": {
"id": "v1beta1.ClusterList",
+ "description": "A list of all the kubernetes clusters registered to the federation",
"required": [
"items"
],
@@ -652,13 +657,15 @@
"description": "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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources"
},
"metadata": {
- "$ref": "unversioned.ListMeta"
+ "$ref": "unversioned.ListMeta",
+ "description": "Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
},
"items": {
"type": "array",
"items": {
"$ref": "v1beta1.Cluster"
- }
+ },
+ "description": "List of Cluster objects."
}
}
},
@@ -678,6 +685,7 @@
},
"v1beta1.Cluster": {
"id": "v1beta1.Cluster",
+ "description": "Information about a registered cluster in a federated kubernetes setup. Clusters are not namespaced and have unique names in the federation.",
"properties": {
"kind": {
"type": "string",
@@ -688,13 +696,16 @@
"description": "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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources"
},
"metadata": {
- "$ref": "v1.ObjectMeta"
+ "$ref": "v1.ObjectMeta",
+ "description": "Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata"
},
"spec": {
- "$ref": "v1beta1.ClusterSpec"
+ "$ref": "v1beta1.ClusterSpec",
+ "description": "Spec defines the behavior of the Cluster."
},
"status": {
- "$ref": "v1beta1.ClusterStatus"
+ "$ref": "v1beta1.ClusterStatus",
+ "description": "Status describes the current status of a Cluster"
}
}
},
@@ -767,6 +778,10 @@
"type": "string"
},
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."
+ },
+ "clusterName": {
+ "type": "string",
+ "description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
}
}
},
@@ -804,6 +819,7 @@
},
"v1beta1.ClusterSpec": {
"id": "v1beta1.ClusterSpec",
+ "description": "ClusterSpec describes the attributes of a kubernetes cluster.",
"required": [
"serverAddressByClientCIDRs"
],
@@ -812,25 +828,30 @@
"type": "array",
"items": {
"$ref": "v1beta1.ServerAddressByClientCIDR"
- }
+ },
+ "description": "A map of client CIDR to server address. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR."
},
"secretRef": {
- "$ref": "v1.LocalObjectReference"
+ "$ref": "v1.LocalObjectReference",
+ "description": "Name of the secret containing kubeconfig to access this cluster. The secret is read from the kubernetes cluster that is hosting federation control plane. Admin needs to ensure that the required secret exists. Secret should be in the same namespace where federation control plane is hosted and it should have kubeconfig in its data with key \"kubeconfig\". This will later be changed to a reference to secret in federation control plane when the federation control plane supports secrets. This can be left empty if the cluster allows insecure access."
}
}
},
"v1beta1.ServerAddressByClientCIDR": {
"id": "v1beta1.ServerAddressByClientCIDR",
+ "description": "ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.",
"required": [
"clientCIDR",
"serverAddress"
],
"properties": {
"clientCIDR": {
- "type": "string"
+ "type": "string",
+ "description": "The CIDR with which clients can match their IP to figure out the server address that they should use."
},
"serverAddress": {
- "type": "string"
+ "type": "string",
+ "description": "Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port."
}
}
},
@@ -846,50 +867,61 @@
},
"v1beta1.ClusterStatus": {
"id": "v1beta1.ClusterStatus",
+ "description": "ClusterStatus is information about the current status of a cluster updated by cluster controller peridocally.",
"properties": {
"conditions": {
"type": "array",
"items": {
"$ref": "v1beta1.ClusterCondition"
- }
+ },
+ "description": "Conditions is an array of current cluster conditions."
},
"zones": {
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "Zones is the list of avaliability zones in which the nodes of the cluster exist, e.g. 'us-east1-a'. These will always be in the same region."
},
"region": {
- "type": "string"
+ "type": "string",
+ "description": "Region is the name of the region in which all of the nodes in the cluster exist. e.g. 'us-east1'."
}
}
},
"v1beta1.ClusterCondition": {
"id": "v1beta1.ClusterCondition",
+ "description": "ClusterCondition describes current state of a cluster.",
"required": [
"type",
"status"
],
"properties": {
"type": {
- "type": "string"
+ "type": "string",
+ "description": "Type of cluster condition, Complete or Failed."
},
"status": {
- "type": "string"
+ "type": "string",
+ "description": "Status of the condition, one of True, False, Unknown."
},
"lastProbeTime": {
"type": "string",
- "format": "date-time"
+ "format": "date-time",
+ "description": "Last time the condition was checked."
},
"lastTransitionTime": {
"type": "string",
- "format": "date-time"
+ "format": "date-time",
+ "description": "Last time the condition transit from one status to another."
},
"reason": {
- "type": "string"
+ "type": "string",
+ "description": "(brief) reason for the condition's last transition."
},
"message": {
- "type": "string"
+ "type": "string",
+ "description": "Human readable message indicating details about last transition."
}
}
},
diff --git a/federation/apis/swagger-spec/logs.json b/federation/apis/swagger-spec/logs.json
index d74c43bf616..971cc9a5b70 100644
--- a/federation/apis/swagger-spec/logs.json
+++ b/federation/apis/swagger-spec/logs.json
@@ -3,6 +3,10 @@
"apiVersion": "",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/logs",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/logs/{logpath}",
diff --git a/federation/apis/swagger-spec/v1.json b/federation/apis/swagger-spec/v1.json
index 965a6fd113e..059f54e8e50 100644
--- a/federation/apis/swagger-spec/v1.json
+++ b/federation/apis/swagger-spec/v1.json
@@ -3,6 +3,10 @@
"apiVersion": "v1",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/api/v1",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/api/v1/namespaces/{namespace}/events",
@@ -3404,6 +3408,10 @@
"type": "string"
},
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."
+ },
+ "clusterName": {
+ "type": "string",
+ "description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
}
}
},
@@ -3833,15 +3841,15 @@
},
"selector": {
"type": "object",
- "description": "This service will route traffic to pods having labels matching this selector. Label keys and values that must match in order to receive traffic for this service. If not specified, endpoints must be manually specified and the system will not automatically manage them. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview"
+ "description": "Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview"
},
"clusterIP": {
"type": "string",
- "description": "ClusterIP is usually assigned by the master and is the IP address of the service. If specified, it will be allocated to the service if it is unused or else creation of the service will fail. Valid values are None, empty string (\"\"), or a valid IP address. 'None' can be specified for a headless service when proxying is not required. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies"
+ "description": "clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are \"None\", empty string (\"\"), or a valid IP address. \"None\" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies"
},
"type": {
"type": "string",
- "description": "Type of exposed service. Must be ClusterIP, NodePort, or LoadBalancer. Defaults to ClusterIP. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#external-services"
+ "description": "type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. \"ExternalName\" maps to the specified externalName. \"ClusterIP\" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is \"None\", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. \"NodePort\" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. \"LoadBalancer\" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview"
},
"externalIPs": {
"type": "array",
@@ -3871,6 +3879,10 @@
"type": "string"
},
"description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.\" More info: http://releases.k8s.io/HEAD/docs/user-guide/services-firewalls.md"
+ },
+ "externalName": {
+ "type": "string",
+ "description": "externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName."
}
}
},
diff --git a/federation/apis/swagger-spec/version.json b/federation/apis/swagger-spec/version.json
index 59f268aa424..1b60aa14b9e 100644
--- a/federation/apis/swagger-spec/version.json
+++ b/federation/apis/swagger-spec/version.json
@@ -3,6 +3,10 @@
"apiVersion": "",
"basePath": "https://10.10.10.10:6443",
"resourcePath": "/version",
+ "info": {
+ "title": "",
+ "description": ""
+ },
"apis": [
{
"path": "/version",
diff --git a/federation/docs/api-reference/extensions/v1beta1/definitions.html b/federation/docs/api-reference/extensions/v1beta1/definitions.html
new file mode 100755
index 00000000000..0e267b46c26
--- /dev/null
+++ b/federation/docs/api-reference/extensions/v1beta1/definitions.html
@@ -0,0 +1,4820 @@
+
+
+
+
+
+
+Top Level API Objects
+
+
+
+
+
+
+
Top Level API Objects
+
+
+
+
Definitions
+
+
+
v1.Preconditions
+
+
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+uid |
+Specifies the target UID. |
+false |
+types.UID |
+ |
+
+
+
+
+
+
+
v1.SELinuxOptions
+
+
SELinuxOptions are the labels to be applied to the container
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+user |
+User is a SELinux user label that applies to the container. |
+false |
+string |
+ |
+
+
+role |
+Role is a SELinux role label that applies to the container. |
+false |
+string |
+ |
+
+
+type |
+Type is a SELinux type label that applies to the container. |
+false |
+string |
+ |
+
+
+level |
+Level is SELinux level label that applies to the container. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.ObjectFieldSelector
+
+
ObjectFieldSelector selects an APIVersioned field of an object.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+apiVersion |
+Version of the schema the FieldPath is written in terms of, defaults to "v1". |
+false |
+string |
+ |
+
+
+fieldPath |
+Path of the field to select in the specified API version. |
+true |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.ScaleStatus
+
+
represents the current status of a scale subresource.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+replicas |
+actual number of observed instances of the scaled object. |
+true |
+integer (int32) |
+ |
+
+
+selector |
+label query over pods that should match the replicas count. More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors |
+false |
+object |
+ |
+
+
+targetSelector |
+label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.VolumeMount
+
+
VolumeMount describes a mounting of a Volume within a container.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+This must match the Name of a Volume. |
+true |
+string |
+ |
+
+
+readOnly |
+Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
+false |
+boolean |
+false |
+
+
+mountPath |
+Path within the container at which the volume should be mounted. Must not contain :. |
+true |
+string |
+ |
+
+
+subPath |
+Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.IngressSpec
+
+
IngressSpec describes the Ingress the user wishes to exist.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+backend |
+A default backend capable of servicing requests that don’t match any rule. At least one of backend or rules must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. |
+false |
+v1beta1.IngressBackend |
+ |
+
+
+tls |
+TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. |
+false |
+v1beta1.IngressTLS array |
+ |
+
+
+rules |
+A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. |
+false |
+v1beta1.IngressRule array |
+ |
+
+
+
+
+
+
+
v1.NFSVolumeSource
+
+
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
+
+
+
+
+
+
v1beta1.IngressBackend
+
+
IngressBackend describes all endpoints for a given service and port.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+serviceName |
+Specifies the name of the referenced service. |
+true |
+string |
+ |
+
+
+servicePort |
+Specifies the port of the referenced service. |
+true |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.ReplicaSetList
+
+
ReplicaSetList is a collection of ReplicaSets.
+
+
+
+
+
+
v1.CephFSVolumeSource
+
+
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
+
+
+
+
+
+
+
+
HTTPHeader describes a custom header to be used in HTTP probes
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+The header field name |
+true |
+string |
+ |
+
+
+value |
+The header field value |
+true |
+string |
+ |
+
+
+
+
+
+
+
v1.FCVolumeSource
+
+
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+targetWWNs |
+Required: FC target world wide names (WWNs) |
+true |
+string array |
+ |
+
+
+lun |
+Required: FC target lun number |
+true |
+integer (int32) |
+ |
+
+
+fsType |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
+false |
+string |
+ |
+
+
+readOnly |
+Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1beta1.IngressStatus
+
+
IngressStatus describe the current state of the Ingress.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+loadBalancer |
+LoadBalancer contains the current status of the load-balancer. |
+false |
+v1.LoadBalancerStatus |
+ |
+
+
+
+
+
+
+
v1.DownwardAPIVolumeSource
+
+
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+items |
+Items is a list of downward API volume file |
+false |
+v1.DownwardAPIVolumeFile array |
+ |
+
+
+defaultMode |
+Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
unversioned.StatusCause
+
+
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+reason |
+A machine-readable description of the cause of the error. If this value is empty there is no information available. |
+false |
+string |
+ |
+
+
+message |
+A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
+false |
+string |
+ |
+
+
+field |
+The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
+
+Examples:
+ "name" - the field "name" on the current resource
+ "items[0].name" - the field "name" on the first array entry in "items" |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.GCEPersistentDiskVolumeSource
+
+
Represents a Persistent Disk resource in Google Compute Engine.
+
+
+
A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
+
+
+
+
+
+
v1.TCPSocketAction
+
+
TCPSocketAction describes an action based on opening a socket
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+port |
+Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
+true |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.IngressRule
+
+
IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+host |
+Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
+ IP in the Spec of the parent Ingress.
+2. The : delimiter is not respected because ports are not allowed.
+ Currently the port of an Ingress is implicitly :80 for http and
+ :443 for https.
+Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. |
+false |
+string |
+ |
+
+
+http |
+ |
+false |
+v1beta1.HTTPIngressRuleValue |
+ |
+
+
+
+
+
+
+
v1beta1.HTTPIngressRuleValue
+
+
HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last / and before the first ? or #.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+paths |
+A collection of paths that map requests to backends. |
+true |
+v1beta1.HTTPIngressPath array |
+ |
+
+
+
+
+
+
+
v1.ConfigMapVolumeSource
+
+
Adapts a ConfigMap into a volume.
+
+
+
The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
+false |
+string |
+ |
+
+
+items |
+If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ... |
+false |
+v1.KeyToPath array |
+ |
+
+
+defaultMode |
+Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
*versioned.Event
+
+
+
+
unversioned.StatusDetails
+
+
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
+false |
+string |
+ |
+
+
+group |
+The group attribute of the resource associated with the status StatusReason. |
+false |
+string |
+ |
+
+
+kind |
+The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+causes |
+The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
+false |
+unversioned.StatusCause array |
+ |
+
+
+retryAfterSeconds |
+If specified, the time in seconds before the operation should be retried. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
v1.GitRepoVolumeSource
+
+
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+repository |
+Repository URL |
+true |
+string |
+ |
+
+
+revision |
+Commit hash for the specified revision. |
+false |
+string |
+ |
+
+
+directory |
+Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.HTTPGetAction
+
+
HTTPGetAction describes an action based on HTTP Get requests.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+path |
+Path to access on the HTTP server. |
+false |
+string |
+ |
+
+
+port |
+Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
+true |
+string |
+ |
+
+
+host |
+Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
+false |
+string |
+ |
+
+
+scheme |
+Scheme to use for connecting to the host. Defaults to HTTP. |
+false |
+string |
+ |
+
+
+httpHeaders |
+Custom headers to set in the request. HTTP allows repeated headers. |
+false |
+v1.HTTPHeader array |
+ |
+
+
+
+
+
+
+
v1.Capabilities
+
+
Adds and removes POSIX capabilities from running containers.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+add |
+Added capabilities |
+false |
+v1.Capability array |
+ |
+
+
+drop |
+Removed capabilities |
+false |
+v1.Capability array |
+ |
+
+
+
+
+
+
+
v1.LocalObjectReference
+
+
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+
+
+
+
+
+
v1.LoadBalancerStatus
+
+
LoadBalancerStatus represents the status of a load-balancer.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+ingress |
+Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |
+false |
+v1.LoadBalancerIngress array |
+ |
+
+
+
+
+
+
+
v1.Container
+
+
A single application container that you want to run within a pod.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
+true |
+string |
+ |
+
+
+image |
+Docker image name. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md |
+false |
+string |
+ |
+
+
+command |
+Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. 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. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands |
+false |
+string array |
+ |
+
+
+args |
+Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. 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. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands |
+false |
+string array |
+ |
+
+
+workingDir |
+Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
+false |
+string |
+ |
+
+
+ports |
+List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. |
+false |
+v1.ContainerPort array |
+ |
+
+
+env |
+List of environment variables to set in the container. Cannot be updated. |
+false |
+v1.EnvVar array |
+ |
+
+
+resources |
+Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources |
+false |
+v1.ResourceRequirements |
+ |
+
+
+volumeMounts |
+Pod volumes to mount into the container’s filesystem. Cannot be updated. |
+false |
+v1.VolumeMount array |
+ |
+
+
+livenessProbe |
+Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
+false |
+v1.Probe |
+ |
+
+
+readinessProbe |
+Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
+false |
+v1.Probe |
+ |
+
+
+lifecycle |
+Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
+false |
+v1.Lifecycle |
+ |
+
+
+terminationMessagePath |
+Optional: 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. |
+false |
+string |
+ |
+
+
+imagePullPolicy |
+Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images |
+false |
+string |
+ |
+
+
+securityContext |
+Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md |
+false |
+v1.SecurityContext |
+ |
+
+
+stdin |
+Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
+false |
+boolean |
+false |
+
+
+stdinOnce |
+Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
+false |
+boolean |
+false |
+
+
+tty |
+Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1.PodSecurityContext
+
+
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+seLinuxOptions |
+The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
+false |
+v1.SELinuxOptions |
+ |
+
+
+runAsUser |
+The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
+false |
+integer (int64) |
+ |
+
+
+runAsNonRoot |
+Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
+false |
+boolean |
+false |
+
+
+supplementalGroups |
+A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container. |
+false |
+integer (int32) array |
+ |
+
+
+fsGroup |
+A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
+
+1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw |
+false |
+integer (int64) |
+ |
+
+
+
+
+
+
+
v1.ExecAction
+
+
ExecAction describes a "run in container" action.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+command |
+Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (' |
+', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
+false |
+string array |
+
+
+
+
+
+
+
+
+
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+Name must be unique within a namespace. Is required when creating resources, although 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. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
+false |
+string |
+ |
+
+
+generateName |
+GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
+
+If this field is specified and the generated name exists, the server will NOT return a 409 - 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).
+
+Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency |
+false |
+string |
+ |
+
+
+namespace |
+Namespace defines the space within each 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.
+
+Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md |
+false |
+string |
+ |
+
+
+selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
+ |
+
+
+uid |
+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.
+
+Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids |
+false |
+string |
+ |
+
+
+resourceVersion |
+An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
+
+Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
+ |
+
+
+generation |
+A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
+false |
+integer (int64) |
+ |
+
+
+creationTimestamp |
+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.
+
+Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+false |
+string (date-time) |
+ |
+
+
+deletionTimestamp |
+DeletionTimestamp is RFC 3339 date and time at 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 directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that 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. If not set, graceful deletion of the object has not been requested.
+
+Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+false |
+string (date-time) |
+ |
+
+
+deletionGracePeriodSeconds |
+Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
+false |
+integer (int64) |
+ |
+
+
+labels |
+Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md |
+false |
+object |
+ |
+
+
+annotations |
+Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/HEAD/docs/user-guide/annotations.md |
+false |
+object |
+ |
+
+
+ownerReferences |
+List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. |
+false |
+v1.OwnerReference array |
+ |
+
+
+finalizers |
+Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
+false |
+string array |
+ |
+
+
+clusterName |
+The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.OwnerReference
+
+
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
+
+
+
+
+
+
v1beta1.ReplicaSetStatus
+
+
ReplicaSetStatus represents the current status of a ReplicaSet.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+replicas |
+Replicas is the most recently oberved number of replicas. More info: http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller |
+true |
+integer (int32) |
+ |
+
+
+fullyLabeledReplicas |
+The number of pods that have labels matching the labels of the pod template of the replicaset. |
+false |
+integer (int32) |
+ |
+
+
+readyReplicas |
+The number of ready replicas for this replica set. |
+false |
+integer (int32) |
+ |
+
+
+observedGeneration |
+ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
+false |
+integer (int64) |
+ |
+
+
+
+
+
+
+
v1beta1.ReplicaSetSpec
+
+
ReplicaSetSpec is the specification of a ReplicaSet.
+
+
+
+
+
+
v1beta1.LabelSelector
+
+
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+matchLabels |
+matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
+false |
+object |
+ |
+
+
+matchExpressions |
+matchExpressions is a list of label selector requirements. The requirements are ANDed. |
+false |
+v1beta1.LabelSelectorRequirement array |
+ |
+
+
+
+
+
+
+
v1.AzureFileVolumeSource
+
+
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+secretName |
+the name of secret that contains Azure Storage Account Name and Key |
+true |
+string |
+ |
+
+
+shareName |
+Share Name |
+true |
+string |
+ |
+
+
+readOnly |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1beta1.ReplicaSet
+
+
ReplicaSet represents the configuration of a ReplicaSet.
+
+
+
+
+
+
types.UID
+
+
+
+
v1.HostPathVolumeSource
+
+
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
+
+
+
+
+
+
v1.ISCSIVolumeSource
+
+
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+targetPortal |
+iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
+true |
+string |
+ |
+
+
+iqn |
+Target iSCSI Qualified Name. |
+true |
+string |
+ |
+
+
+lun |
+iSCSI target lun number. |
+true |
+integer (int32) |
+ |
+
+
+iscsiInterface |
+Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport. |
+false |
+string |
+ |
+
+
+fsType |
+Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#iscsi |
+false |
+string |
+ |
+
+
+readOnly |
+ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1beta1.IngressList
+
+
IngressList is a collection of Ingress.
+
+
+
+
+
+
v1.EmptyDirVolumeSource
+
+
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+medium |
+What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.ScaleSpec
+
+
describes the attributes of a scale subresource
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+replicas |
+desired number of instances for the scaled object. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
unversioned.Patch
+
+
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+
+
+
+
v1.CinderVolumeSource
+
+
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
v1.SecurityContext
+
+
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+capabilities |
+The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
+false |
+v1.Capabilities |
+ |
+
+
+privileged |
+Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
+false |
+boolean |
+false |
+
+
+seLinuxOptions |
+The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
+false |
+v1.SELinuxOptions |
+ |
+
+
+runAsUser |
+The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
+false |
+integer (int64) |
+ |
+
+
+runAsNonRoot |
+Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
+false |
+boolean |
+false |
+
+
+readOnlyRootFilesystem |
+Whether this container has a read-only root filesystem. Default is false. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1.AWSElasticBlockStoreVolumeSource
+
+
Represents a Persistent Disk resource in AWS.
+
+
+
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+volumeID |
+Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
+true |
+string |
+ |
+
+
+fsType |
+Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
+false |
+string |
+ |
+
+
+partition |
+The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). |
+false |
+integer (int32) |
+ |
+
+
+readOnly |
+Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1.PersistentVolumeClaimVolumeSource
+
+
PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
+
+
+
+
+
+
v1.FlockerVolumeSource
+
+
Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+datasetName |
+Required: the volume name. This is going to be store on metadata → name on the payload for Flocker |
+true |
+string |
+ |
+
+
+
+
+
+
+
+
+
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
+ |
+
+
+resourceVersion |
+String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.QuobyteVolumeSource
+
+
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+registry |
+Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
+true |
+string |
+ |
+
+
+volume |
+Volume is a string that references an already created Quobyte volume by name. |
+true |
+string |
+ |
+
+
+readOnly |
+ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
+false |
+boolean |
+false |
+
+
+user |
+User to map volume access to Defaults to serivceaccount user |
+false |
+string |
+ |
+
+
+group |
+Group to map volume access to Default is no group |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.LabelSelectorRequirement
+
+
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+key |
+key is the label key that the selector applies to. |
+true |
+string |
+ |
+
+
+operator |
+operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist. |
+true |
+string |
+ |
+
+
+values |
+values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
+false |
+string array |
+ |
+
+
+
+
+
+
+
v1.EnvVar
+
+
EnvVar represents an environment variable present in a Container.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+Name of the environment variable. Must be a C_IDENTIFIER. |
+true |
+string |
+ |
+
+
+value |
+Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service 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. Defaults to "". |
+false |
+string |
+ |
+
+
+valueFrom |
+Source for the environment variable’s value. Cannot be used if value is not empty. |
+false |
+v1.EnvVarSource |
+ |
+
+
+
+
+
+
+
v1.SecretVolumeSource
+
+
Adapts a Secret into a volume.
+
+
+
The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+secretName |
+Name of the secret in the pod’s namespace to use. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets |
+false |
+string |
+ |
+
+
+items |
+If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ... |
+false |
+v1.KeyToPath array |
+ |
+
+
+defaultMode |
+Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
v1.ResourceRequirements
+
+
ResourceRequirements describes the compute resource requirements.
+
+
+
+
+
+
v1.EnvVarSource
+
+
EnvVarSource represents a source for the value of an EnvVar.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+fieldRef |
+Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP. |
+false |
+v1.ObjectFieldSelector |
+ |
+
+
+resourceFieldRef |
+Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
+false |
+v1.ResourceFieldSelector |
+ |
+
+
+configMapKeyRef |
+Selects a key of a ConfigMap. |
+false |
+v1.ConfigMapKeySelector |
+ |
+
+
+secretKeyRef |
+Selects a key of a secret in the pod’s namespace |
+false |
+v1.SecretKeySelector |
+ |
+
+
+
+
+
+
+
v1.FlexVolumeSource
+
+
FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+driver |
+Driver is the name of the driver to use for this volume. |
+true |
+string |
+ |
+
+
+fsType |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
+false |
+string |
+ |
+
+
+secretRef |
+Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |
+false |
+v1.LocalObjectReference |
+ |
+
+
+readOnly |
+Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
+false |
+boolean |
+false |
+
+
+options |
+Optional: Extra command options if any. |
+false |
+object |
+ |
+
+
+
+
+
+
+
v1.LoadBalancerIngress
+
+
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+ip |
+IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) |
+false |
+string |
+ |
+
+
+hostname |
+Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.PodTemplateSpec
+
+
PodTemplateSpec describes the data a pod should have when created from a template
+
+
+
+
+
+
v1.AzureDiskVolumeSource
+
+
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+diskName |
+The Name of the data disk in the blob storage |
+true |
+string |
+ |
+
+
+diskURI |
+The URI the data disk in the blob storage |
+true |
+string |
+ |
+
+
+cachingMode |
+Host Caching mode: None, Read Only, Read Write. |
+false |
+v1.AzureDataDiskCachingMode |
+ |
+
+
+fsType |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
+false |
+string |
+ |
+
+
+readOnly |
+Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1.KeyToPath
+
+
Maps a string key to a path within a volume.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+key |
+The key to project. |
+true |
+string |
+ |
+
+
+path |
+The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ... |
+true |
+string |
+ |
+
+
+mode |
+Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
v1.VsphereVirtualDiskVolumeSource
+
+
Represents a vSphere volume resource.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+volumePath |
+Path that identifies vSphere volume vmdk |
+true |
+string |
+ |
+
+
+fsType |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.DeleteOptions
+
+
DeleteOptions may be provided when deleting an API object
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+gracePeriodSeconds |
+The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
+false |
+integer (int64) |
+ |
+
+
+preconditions |
+Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
+false |
+v1.Preconditions |
+ |
+
+
+orphanDependents |
+Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1.Volume
+
+
Volume represents a named volume in a pod that may be accessed by any container in the pod.
+
+
+
+
+
+
v1.ResourceFieldSelector
+
+
ResourceFieldSelector represents container resources (cpu, memory) and their output format
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+containerName |
+Container name: required for volumes, optional for env vars |
+false |
+string |
+ |
+
+
+resource |
+Required: resource to select |
+true |
+string |
+ |
+
+
+divisor |
+Specifies the output format of the exposed resources, defaults to "1" |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.Probe
+
+
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+exec |
+One and only one of the following should be specified. Exec specifies the action to take. |
+false |
+v1.ExecAction |
+ |
+
+
+httpGet |
+HTTPGet specifies the http request to perform. |
+false |
+v1.HTTPGetAction |
+ |
+
+
+tcpSocket |
+TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
+false |
+v1.TCPSocketAction |
+ |
+
+
+initialDelaySeconds |
+Number of seconds after the container has started before liveness probes are initiated. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
+false |
+integer (int32) |
+ |
+
+
+timeoutSeconds |
+Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
+false |
+integer (int32) |
+ |
+
+
+periodSeconds |
+How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
+false |
+integer (int32) |
+ |
+
+
+successThreshold |
+Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
+false |
+integer (int32) |
+ |
+
+
+failureThreshold |
+Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
unversioned.APIResourceList
+
+
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+groupVersion |
+groupVersion is the group and version this APIResourceList is for. |
+true |
+string |
+ |
+
+
+resources |
+resources contains the name of the resources and if they are namespaced. |
+true |
+unversioned.APIResource array |
+ |
+
+
+
+
+
+
+
v1.SecretKeySelector
+
+
SecretKeySelector selects a key of a Secret.
+
+
+
+
+
+
v1.Capability
+
+
+
+
unversioned.Status
+
+
Status is a return value for calls that don’t return other objects.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+metadata |
+Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+unversioned.ListMeta |
+ |
+
+
+status |
+Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
+false |
+string |
+ |
+
+
+message |
+A human-readable description of the status of this operation. |
+false |
+string |
+ |
+
+
+reason |
+A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. |
+false |
+string |
+ |
+
+
+details |
+Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. |
+false |
+unversioned.StatusDetails |
+ |
+
+
+code |
+Suggested HTTP return code for this status, 0 if not set. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
unversioned.APIResource
+
+
APIResource specifies the name of a resource and whether it is namespaced.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+name is the name of the resource. |
+true |
+string |
+ |
+
+
+namespaced |
+namespaced indicates if a resource is namespaced or not. |
+true |
+boolean |
+false |
+
+
+kind |
+kind is the kind for the resource (e.g. Foo is the kind for a resource foo) |
+true |
+string |
+ |
+
+
+
+
+
+
+
v1.DownwardAPIVolumeFile
+
+
DownwardAPIVolumeFile represents information to create the file containing the pod field
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+path |
+Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with .. |
+true |
+string |
+ |
+
+
+fieldRef |
+Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
+false |
+v1.ObjectFieldSelector |
+ |
+
+
+resourceFieldRef |
+Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
+false |
+v1.ResourceFieldSelector |
+ |
+
+
+mode |
+Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
v1.ContainerPort
+
+
ContainerPort represents a network port in a single container.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
+false |
+string |
+ |
+
+
+hostPort |
+Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
+false |
+integer (int32) |
+ |
+
+
+containerPort |
+Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
+true |
+integer (int32) |
+ |
+
+
+protocol |
+Protocol for port. Must be UDP or TCP. Defaults to "TCP". |
+false |
+string |
+ |
+
+
+hostIP |
+What host IP to bind the external port to. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.PodSpec
+
+
PodSpec is a description of a pod.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+volumes |
+List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md |
+false |
+v1.Volume array |
+ |
+
+
+containers |
+List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/containers.md |
+true |
+v1.Container array |
+ |
+
+
+restartPolicy |
+Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy |
+false |
+string |
+ |
+
+
+terminationGracePeriodSeconds |
+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. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
+false |
+integer (int64) |
+ |
+
+
+activeDeadlineSeconds |
+Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
+false |
+integer (int64) |
+ |
+
+
+dnsPolicy |
+Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst". |
+false |
+string |
+ |
+
+
+nodeSelector |
+NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md |
+false |
+object |
+ |
+
+
+serviceAccountName |
+ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md |
+false |
+string |
+ |
+
+
+serviceAccount |
+DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
+false |
+string |
+ |
+
+
+nodeName |
+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 requirements. |
+false |
+string |
+ |
+
+
+hostNetwork |
+Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false. |
+false |
+boolean |
+false |
+
+
+hostPID |
+Use the host’s pid namespace. Optional: Default to false. |
+false |
+boolean |
+false |
+
+
+hostIPC |
+Use the host’s ipc namespace. Optional: Default to false. |
+false |
+boolean |
+false |
+
+
+securityContext |
+SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
+false |
+v1.PodSecurityContext |
+ |
+
+
+imagePullSecrets |
+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. More info: http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod |
+false |
+v1.LocalObjectReference array |
+ |
+
+
+hostname |
+Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value. |
+false |
+string |
+ |
+
+
+subdomain |
+If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.Lifecycle
+
+
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
+
+
+
+
+
+
v1.ConfigMapKeySelector
+
+
Selects a key from a ConfigMap.
+
+
+
+
+
+
v1.Handler
+
+
Handler defines a specific action that should be taken
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+exec |
+One and only one of the following should be specified. Exec specifies the action to take. |
+false |
+v1.ExecAction |
+ |
+
+
+httpGet |
+HTTPGet specifies the http request to perform. |
+false |
+v1.HTTPGetAction |
+ |
+
+
+tcpSocket |
+TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
+false |
+v1.TCPSocketAction |
+ |
+
+
+
+
+
+
+
v1.GlusterfsVolumeSource
+
+
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
+
+
+
+
+
+
v1beta1.HTTPIngressPath
+
+
HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+path |
+Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend. |
+false |
+string |
+ |
+
+
+backend |
+Backend defines the referenced service endpoint to which the traffic will be forwarded to. |
+true |
+v1beta1.IngressBackend |
+ |
+
+
+
+
+
+
+
v1beta1.IngressTLS
+
+
IngressTLS describes the transport layer security associated with an Ingress.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+hosts |
+Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. |
+false |
+string array |
+ |
+
+
+secretName |
+SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.Ingress
+
+
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
+
+
+
+
+
+
v1beta1.Scale
+
+
represents a scaling request for a resource.
+
+
+
+
+
+
v1.AzureDataDiskCachingMode
+
+
+
+
v1.RBDVolumeSource
+
+
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
any
+
+
Represents an untyped JSON map - see the description of the field for more info about the structure of this object.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/federation/docs/api-reference/extensions/v1beta1/operations.html b/federation/docs/api-reference/extensions/v1beta1/operations.html
new file mode 100755
index 00000000000..2c5c8326f9d
--- /dev/null
+++ b/federation/docs/api-reference/extensions/v1beta1/operations.html
@@ -0,0 +1,4687 @@
+
+
+
+
+
+
+Operations
+
+
+
+
+
+
+
Operations
+
+
+
get available resources
+
+
+
GET /apis/extensions/v1beta1
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
list or watch objects of kind Ingress
+
+
+
GET /apis/extensions/v1beta1/ingresses
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
list or watch objects of kind Ingress
+
+
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
delete collection of Ingress
+
+
+
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
create a Ingress
+
+
+
POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.Ingress |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Ingress |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
read the specified Ingress
+
+
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+export |
+Should this value be exported. Export strips fields that a user can not specify. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+exact |
+Should the export be exact. Exact export maintains cluster-specific fields like Namespace |
+false |
+boolean |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Ingress |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Ingress |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
replace the specified Ingress
+
+
+
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.Ingress |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Ingress |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Ingress |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
delete a Ingress
+
+
+
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.DeleteOptions |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Ingress |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
partially update the specified Ingress
+
+
+
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Ingress |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Ingress |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
read status of the specified Ingress
+
+
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Ingress |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Ingress |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
replace status of the specified Ingress
+
+
+
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.Ingress |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Ingress |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Ingress |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
partially update status of the specified Ingress
+
+
+
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Ingress |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Ingress |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
list or watch objects of kind ReplicaSet
+
+
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
delete collection of ReplicaSet
+
+
+
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
create a ReplicaSet
+
+
+
POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.ReplicaSet |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.ReplicaSet |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
read the specified ReplicaSet
+
+
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+export |
+Should this value be exported. Export strips fields that a user can not specify. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+exact |
+Should the export be exact. Exact export maintains cluster-specific fields like Namespace |
+false |
+boolean |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.ReplicaSet |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
replace the specified ReplicaSet
+
+
+
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.ReplicaSet |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.ReplicaSet |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
delete a ReplicaSet
+
+
+
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.DeleteOptions |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
partially update the specified ReplicaSet
+
+
+
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.ReplicaSet |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
read scale of the specified Scale
+
+
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Scale |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Scale |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
replace scale of the specified Scale
+
+
+
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.Scale |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Scale |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Scale |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
partially update scale of the specified Scale
+
+
+
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Scale |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Scale |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
read status of the specified ReplicaSet
+
+
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.ReplicaSet |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
replace status of the specified ReplicaSet
+
+
+
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.ReplicaSet |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.ReplicaSet |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
partially update status of the specified ReplicaSet
+
+
+
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.ReplicaSet |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
list or watch objects of kind ReplicaSet
+
+
+
GET /apis/extensions/v1beta1/replicasets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
watch individual changes to a list of Ingress
+
+
+
GET /apis/extensions/v1beta1/watch/ingresses
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
watch individual changes to a list of Ingress
+
+
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
watch changes to an object of kind Ingress
+
+
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Ingress |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
watch individual changes to a list of ReplicaSet
+
+
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
watch changes to an object of kind ReplicaSet
+
+
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
watch individual changes to a list of ReplicaSet
+
+
+
GET /apis/extensions/v1beta1/watch/replicasets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+-
+
apisextensionsv1beta1
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/federation/docs/api-reference/federation/v1beta1/definitions.html b/federation/docs/api-reference/federation/v1beta1/definitions.html
new file mode 100755
index 00000000000..d9cb146985f
--- /dev/null
+++ b/federation/docs/api-reference/federation/v1beta1/definitions.html
@@ -0,0 +1,1409 @@
+
+
+
+
+
+
+Top Level API Objects
+
+
+
+
+
+
+
Top Level API Objects
+
+
+
+
Definitions
+
+
+
unversioned.Patch
+
+
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+
+
+
+
v1.DeleteOptions
+
+
DeleteOptions may be provided when deleting an API object
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+gracePeriodSeconds |
+The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
+false |
+integer (int64) |
+ |
+
+
+preconditions |
+Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
+false |
+v1.Preconditions |
+ |
+
+
+orphanDependents |
+Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
v1beta1.ServerAddressByClientCIDR
+
+
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+clientCIDR |
+The CIDR with which clients can match their IP to figure out the server address that they should use. |
+true |
+string |
+ |
+
+
+serverAddress |
+Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port. |
+true |
+string |
+ |
+
+
+
+
+
+
+
*versioned.Event
+
+
+
+
v1beta1.ClusterList
+
+
A list of all the kubernetes clusters registered to the federation
+
+
+
+
+
+
unversioned.StatusDetails
+
+
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
+false |
+string |
+ |
+
+
+group |
+The group attribute of the resource associated with the status StatusReason. |
+false |
+string |
+ |
+
+
+kind |
+The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+causes |
+The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
+false |
+unversioned.StatusCause array |
+ |
+
+
+retryAfterSeconds |
+If specified, the time in seconds before the operation should be retried. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
+
+
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
+ |
+
+
+resourceVersion |
+String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.ClusterStatus
+
+
ClusterStatus is information about the current status of a cluster updated by cluster controller peridocally.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+conditions |
+Conditions is an array of current cluster conditions. |
+false |
+v1beta1.ClusterCondition array |
+ |
+
+
+zones |
+Zones is the list of avaliability zones in which the nodes of the cluster exist, e.g. us-east1-a. These will always be in the same region. |
+false |
+string array |
+ |
+
+
+region |
+Region is the name of the region in which all of the nodes in the cluster exist. e.g. us-east1. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.Preconditions
+
+
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+uid |
+Specifies the target UID. |
+false |
+types.UID |
+ |
+
+
+
+
+
+
+
v1.LocalObjectReference
+
+
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+
+
+
+
+
+
unversioned.APIResourceList
+
+
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+groupVersion |
+groupVersion is the group and version this APIResourceList is for. |
+true |
+string |
+ |
+
+
+resources |
+resources contains the name of the resources and if they are namespaced. |
+true |
+unversioned.APIResource array |
+ |
+
+
+
+
+
+
+
v1beta1.ClusterSpec
+
+
ClusterSpec describes the attributes of a kubernetes cluster.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+serverAddressByClientCIDRs |
+A map of client CIDR to server address. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. |
+true |
+v1beta1.ServerAddressByClientCIDR array |
+ |
+
+
+secretRef |
+Name of the secret containing kubeconfig to access this cluster. The secret is read from the kubernetes cluster that is hosting federation control plane. Admin needs to ensure that the required secret exists. Secret should be in the same namespace where federation control plane is hosted and it should have kubeconfig in its data with key "kubeconfig". This will later be changed to a reference to secret in federation control plane when the federation control plane supports secrets. This can be left empty if the cluster allows insecure access. |
+false |
+v1.LocalObjectReference |
+ |
+
+
+
+
+
+
+
unversioned.Status
+
+
Status is a return value for calls that don’t return other objects.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+metadata |
+Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+unversioned.ListMeta |
+ |
+
+
+status |
+Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
+false |
+string |
+ |
+
+
+message |
+A human-readable description of the status of this operation. |
+false |
+string |
+ |
+
+
+reason |
+A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. |
+false |
+string |
+ |
+
+
+details |
+Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. |
+false |
+unversioned.StatusDetails |
+ |
+
+
+code |
+Suggested HTTP return code for this status, 0 if not set. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
unversioned.APIResource
+
+
APIResource specifies the name of a resource and whether it is namespaced.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+name is the name of the resource. |
+true |
+string |
+ |
+
+
+namespaced |
+namespaced indicates if a resource is namespaced or not. |
+true |
+boolean |
+false |
+
+
+kind |
+kind is the kind for the resource (e.g. Foo is the kind for a resource foo) |
+true |
+string |
+ |
+
+
+
+
+
+
+
+
+
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+Name must be unique within a namespace. Is required when creating resources, although 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. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
+false |
+string |
+ |
+
+
+generateName |
+GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
+
+If this field is specified and the generated name exists, the server will NOT return a 409 - 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).
+
+Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency |
+false |
+string |
+ |
+
+
+namespace |
+Namespace defines the space within each 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.
+
+Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md |
+false |
+string |
+ |
+
+
+selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
+ |
+
+
+uid |
+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.
+
+Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids |
+false |
+string |
+ |
+
+
+resourceVersion |
+An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
+
+Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
+ |
+
+
+generation |
+A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
+false |
+integer (int64) |
+ |
+
+
+creationTimestamp |
+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.
+
+Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+false |
+string (date-time) |
+ |
+
+
+deletionTimestamp |
+DeletionTimestamp is RFC 3339 date and time at 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 directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that 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. If not set, graceful deletion of the object has not been requested.
+
+Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+false |
+string (date-time) |
+ |
+
+
+deletionGracePeriodSeconds |
+Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
+false |
+integer (int64) |
+ |
+
+
+labels |
+Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md |
+false |
+object |
+ |
+
+
+annotations |
+Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/HEAD/docs/user-guide/annotations.md |
+false |
+object |
+ |
+
+
+ownerReferences |
+List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. |
+false |
+v1.OwnerReference array |
+ |
+
+
+finalizers |
+Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
+false |
+string array |
+ |
+
+
+clusterName |
+The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.OwnerReference
+
+
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
+
+
+
+
+
+
v1beta1.ClusterCondition
+
+
ClusterCondition describes current state of a cluster.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+type |
+Type of cluster condition, Complete or Failed. |
+true |
+string |
+ |
+
+
+status |
+Status of the condition, one of True, False, Unknown. |
+true |
+string |
+ |
+
+
+lastProbeTime |
+Last time the condition was checked. |
+false |
+string (date-time) |
+ |
+
+
+lastTransitionTime |
+Last time the condition transit from one status to another. |
+false |
+string (date-time) |
+ |
+
+
+reason |
+(brief) reason for the condition’s last transition. |
+false |
+string |
+ |
+
+
+message |
+Human readable message indicating details about last transition. |
+false |
+string |
+ |
+
+
+
+
+
+
+
types.UID
+
+
+
+
unversioned.StatusCause
+
+
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+reason |
+A machine-readable description of the cause of the error. If this value is empty there is no information available. |
+false |
+string |
+ |
+
+
+message |
+A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
+false |
+string |
+ |
+
+
+field |
+The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
+
+Examples:
+ "name" - the field "name" on the current resource
+ "items[0].name" - the field "name" on the first array entry in "items" |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1beta1.Cluster
+
+
Information about a registered cluster in a federated kubernetes setup. Clusters are not namespaced and have unique names in the federation.
+
+
+
+
+
+
any
+
+
Represents an untyped JSON map - see the description of the field for more info about the structure of this object.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/federation/docs/api-reference/federation/v1beta1/operations.html b/federation/docs/api-reference/federation/v1beta1/operations.html
new file mode 100755
index 00000000000..ebd75421a26
--- /dev/null
+++ b/federation/docs/api-reference/federation/v1beta1/operations.html
@@ -0,0 +1,1760 @@
+
+
+
+
+
+
+Operations
+
+
+
+
+
+
+
Operations
+
+
+
get available resources
+
+
+
GET /apis/federation/v1beta1
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
list or watch objects of kind Cluster
+
+
+
GET /apis/federation/v1beta1/clusters
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
delete collection of Cluster
+
+
+
DELETE /apis/federation/v1beta1/clusters
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
create a Cluster
+
+
+
POST /apis/federation/v1beta1/clusters
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.Cluster |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Cluster |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
read the specified Cluster
+
+
+
GET /apis/federation/v1beta1/clusters/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+export |
+Should this value be exported. Export strips fields that a user can not specify. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+exact |
+Should the export be exact. Exact export maintains cluster-specific fields like Namespace |
+false |
+boolean |
+ |
+
+
+PathParameter |
+name |
+name of the Cluster |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Cluster |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
replace the specified Cluster
+
+
+
PUT /apis/federation/v1beta1/clusters/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.Cluster |
+ |
+
+
+PathParameter |
+name |
+name of the Cluster |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Cluster |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
delete a Cluster
+
+
+
DELETE /apis/federation/v1beta1/clusters/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.DeleteOptions |
+ |
+
+
+PathParameter |
+name |
+name of the Cluster |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
partially update the specified Cluster
+
+
+
PATCH /apis/federation/v1beta1/clusters/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+name |
+name of the Cluster |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Cluster |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
replace status of the specified Cluster
+
+
+
PUT /apis/federation/v1beta1/clusters/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1beta1.Cluster |
+ |
+
+
+PathParameter |
+name |
+name of the Cluster |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1beta1.Cluster |
+
+
+
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
watch individual changes to a list of Cluster
+
+
+
GET /apis/federation/v1beta1/watch/clusters
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
watch changes to an object of kind Cluster
+
+
+
GET /apis/federation/v1beta1/watch/clusters/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+name |
+name of the Cluster |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+-
+
apisfederationv1beta1
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/federation/docs/api-reference/v1/definitions.html b/federation/docs/api-reference/v1/definitions.html
new file mode 100755
index 00000000000..d186234b527
--- /dev/null
+++ b/federation/docs/api-reference/v1/definitions.html
@@ -0,0 +1,2054 @@
+
+
+
+
+
+
+Top Level API Objects
+
+
+
+
+
+
+
Top Level API Objects
+
+
+
+
Definitions
+
+
+
unversioned.Patch
+
+
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+
+
+
+
v1.NamespaceList
+
+
NamespaceList is a list of Namespaces.
+
+
+
+
+
+
v1.Namespace
+
+
Namespace provides a scope for Names. Use of multiple namespaces is optional.
+
+
+
+
+
+
+
+
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
+ |
+
+
+resourceVersion |
+String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.Preconditions
+
+
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+uid |
+Specifies the target UID. |
+false |
+types.UID |
+ |
+
+
+
+
+
+
+
v1.ServiceStatus
+
+
ServiceStatus represents the current status of a service.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+loadBalancer |
+LoadBalancer contains the current status of the load-balancer, if one is present. |
+false |
+v1.LoadBalancerStatus |
+ |
+
+
+
+
+
+
+
v1.Secret
+
+
Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+metadata |
+Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+false |
+v1.ObjectMeta |
+ |
+
+
+data |
+Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
+false |
+object |
+ |
+
+
+stringData |
+stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. |
+false |
+object |
+ |
+
+
+type |
+Used to facilitate programmatic handling of secret data. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.Event
+
+
Event is a report of an event somewhere in the cluster.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+metadata |
+Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+true |
+v1.ObjectMeta |
+ |
+
+
+involvedObject |
+The object that this event is about. |
+true |
+v1.ObjectReference |
+ |
+
+
+reason |
+This should be a short, machine understandable string that gives the reason for the transition into the object’s current status. |
+false |
+string |
+ |
+
+
+message |
+A human-readable description of the status of this operation. |
+false |
+string |
+ |
+
+
+source |
+The component reporting this event. Should be a short machine understandable string. |
+false |
+v1.EventSource |
+ |
+
+
+firstTimestamp |
+The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
+false |
+string (date-time) |
+ |
+
+
+lastTimestamp |
+The time at which the most recent occurrence of this event was recorded. |
+false |
+string (date-time) |
+ |
+
+
+count |
+The number of times this event has occurred. |
+false |
+integer (int32) |
+ |
+
+
+type |
+Type of this event (Normal, Warning), new types could be added in the future |
+false |
+string |
+ |
+
+
+
+
+
+
+
unversioned.StatusCause
+
+
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+reason |
+A machine-readable description of the cause of the error. If this value is empty there is no information available. |
+false |
+string |
+ |
+
+
+message |
+A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
+false |
+string |
+ |
+
+
+field |
+The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
+
+Examples:
+ "name" - the field "name" on the current resource
+ "items[0].name" - the field "name" on the first array entry in "items" |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.LoadBalancerIngress
+
+
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+ip |
+IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) |
+false |
+string |
+ |
+
+
+hostname |
+Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.NamespaceStatus
+
+
NamespaceStatus is information about the current status of a Namespace.
+
+
+
+
+
+
v1.NamespaceSpec
+
+
NamespaceSpec describes the attributes on a Namespace.
+
+
+
+
+
+
v1.ServiceList
+
+
ServiceList holds a list of services.
+
+
+
+
+
+
v1.Service
+
+
Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
+
+
+
+
+
+
v1.DeleteOptions
+
+
DeleteOptions may be provided when deleting an API object
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+gracePeriodSeconds |
+The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
+false |
+integer (int64) |
+ |
+
+
+preconditions |
+Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
+false |
+v1.Preconditions |
+ |
+
+
+orphanDependents |
+Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. |
+false |
+boolean |
+false |
+
+
+
+
+
+
+
*versioned.Event
+
+
+
+
unversioned.StatusDetails
+
+
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
+false |
+string |
+ |
+
+
+group |
+The group attribute of the resource associated with the status StatusReason. |
+false |
+string |
+ |
+
+
+kind |
+The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+causes |
+The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
+false |
+unversioned.StatusCause array |
+ |
+
+
+retryAfterSeconds |
+If specified, the time in seconds before the operation should be retried. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
v1.ObjectReference
+
+
ObjectReference contains enough information to let you inspect or modify the referred object.
+
+
+
+
+
+
unversioned.APIResourceList
+
+
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+groupVersion |
+groupVersion is the group and version this APIResourceList is for. |
+true |
+string |
+ |
+
+
+resources |
+resources contains the name of the resources and if they are namespaced. |
+true |
+unversioned.APIResource array |
+ |
+
+
+
+
+
+
+
v1.LoadBalancerStatus
+
+
LoadBalancerStatus represents the status of a load-balancer.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+ingress |
+Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |
+false |
+v1.LoadBalancerIngress array |
+ |
+
+
+
+
+
+
+
v1.SecretList
+
+
SecretList is a list of Secret.
+
+
+
+
+
+
unversioned.Status
+
+
Status is a return value for calls that don’t return other objects.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
+ |
+
+
+apiVersion |
+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. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
+false |
+string |
+ |
+
+
+metadata |
+Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
+false |
+unversioned.ListMeta |
+ |
+
+
+status |
+Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
+false |
+string |
+ |
+
+
+message |
+A human-readable description of the status of this operation. |
+false |
+string |
+ |
+
+
+reason |
+A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. |
+false |
+string |
+ |
+
+
+details |
+Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. |
+false |
+unversioned.StatusDetails |
+ |
+
+
+code |
+Suggested HTTP return code for this status, 0 if not set. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
unversioned.APIResource
+
+
APIResource specifies the name of a resource and whether it is namespaced.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+name is the name of the resource. |
+true |
+string |
+ |
+
+
+namespaced |
+namespaced indicates if a resource is namespaced or not. |
+true |
+boolean |
+false |
+
+
+kind |
+kind is the kind for the resource (e.g. Foo is the kind for a resource foo) |
+true |
+string |
+ |
+
+
+
+
+
+
+
v1.FinalizerName
+
+
+
+
v1.ServicePort
+
+
ServicePort contains information on service’s port.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the Name field in EndpointPort objects. Optional if only one ServicePort is defined on this service. |
+false |
+string |
+ |
+
+
+protocol |
+The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP. |
+false |
+string |
+ |
+
+
+port |
+The port that will be exposed by this service. |
+true |
+integer (int32) |
+ |
+
+
+targetPort |
+Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. 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 the port field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the port field. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#defining-a-service |
+false |
+string |
+ |
+
+
+nodePort |
+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. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#type—nodeport |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
v1.OwnerReference
+
+
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
+
+
+
+
+
+
+
+
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+name |
+Name must be unique within a namespace. Is required when creating resources, although 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. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
+false |
+string |
+ |
+
+
+generateName |
+GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
+
+If this field is specified and the generated name exists, the server will NOT return a 409 - 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).
+
+Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency |
+false |
+string |
+ |
+
+
+namespace |
+Namespace defines the space within each 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.
+
+Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md |
+false |
+string |
+ |
+
+
+selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
+ |
+
+
+uid |
+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.
+
+Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids |
+false |
+string |
+ |
+
+
+resourceVersion |
+An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
+
+Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
+ |
+
+
+generation |
+A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
+false |
+integer (int64) |
+ |
+
+
+creationTimestamp |
+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.
+
+Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+false |
+string (date-time) |
+ |
+
+
+deletionTimestamp |
+DeletionTimestamp is RFC 3339 date and time at 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 directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that 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. If not set, graceful deletion of the object has not been requested.
+
+Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
+false |
+string (date-time) |
+ |
+
+
+deletionGracePeriodSeconds |
+Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
+false |
+integer (int64) |
+ |
+
+
+labels |
+Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md |
+false |
+object |
+ |
+
+
+annotations |
+Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/HEAD/docs/user-guide/annotations.md |
+false |
+object |
+ |
+
+
+ownerReferences |
+List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. |
+false |
+v1.OwnerReference array |
+ |
+
+
+finalizers |
+Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
+false |
+string array |
+ |
+
+
+clusterName |
+The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.EventList
+
+
EventList is a list of events.
+
+
+
+
+
+
v1.ServiceSpec
+
+
ServiceSpec describes the attributes that a user creates on a service.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+ports |
+The list of ports that are exposed by this service. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies |
+true |
+v1.ServicePort array |
+ |
+
+
+selector |
+Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview |
+false |
+object |
+ |
+
+
+clusterIP |
+clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies |
+false |
+string |
+ |
+
+
+type |
+type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview |
+false |
+string |
+ |
+
+
+externalIPs |
+externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field. |
+false |
+string array |
+ |
+
+
+deprecatedPublicIPs |
+deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used. |
+false |
+string array |
+ |
+
+
+sessionAffinity |
+Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies |
+false |
+string |
+ |
+
+
+loadBalancerIP |
+Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. |
+false |
+string |
+ |
+
+
+loadBalancerSourceRanges |
+If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: http://releases.k8s.io/HEAD/docs/user-guide/services-firewalls.md |
+false |
+string array |
+ |
+
+
+externalName |
+externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName. |
+false |
+string |
+ |
+
+
+
+
+
+
+
v1.EventSource
+
+
EventSource contains information for an event.
+
+
+
+
+
+
+
+
+
+
+
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+component |
+Component from which the event is generated. |
+false |
+string |
+ |
+
+
+host |
+Host name on which the event is generated. |
+false |
+string |
+ |
+
+
+
+
+
+
+
types.UID
+
+
+
+
any
+
+
Represents an untyped JSON map - see the description of the field for more info about the structure of this object.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/federation/docs/api-reference/v1/operations.html b/federation/docs/api-reference/v1/operations.html
new file mode 100755
index 00000000000..8a6684c5d57
--- /dev/null
+++ b/federation/docs/api-reference/v1/operations.html
@@ -0,0 +1,7019 @@
+
+
+
+
+
+
+Operations
+
+
+
+
+
+
+
Operations
+
+
+
get available resources
+
+
+
+
+
+
+
+
list or watch objects of kind Event
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.EventList |
+
+
+
+
+
+
+
+
+
+
+
list or watch objects of kind Namespace
+
+
+
GET /api/v1/namespaces
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.NamespaceList |
+
+
+
+
+
+
+
+
+
+
+
delete collection of Namespace
+
+
+
DELETE /api/v1/namespaces
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
create a Namespace
+
+
+
POST /api/v1/namespaces
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Namespace |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Namespace |
+
+
+
+
+
+
+
+
+
+
+
list or watch objects of kind Event
+
+
+
GET /api/v1/namespaces/{namespace}/events
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.EventList |
+
+
+
+
+
+
+
+
+
+
+
delete collection of Event
+
+
+
DELETE /api/v1/namespaces/{namespace}/events
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
create a Event
+
+
+
POST /api/v1/namespaces/{namespace}/events
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Event |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Event |
+
+
+
+
+
+
+
+
+
+
+
read the specified Event
+
+
+
GET /api/v1/namespaces/{namespace}/events/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+export |
+Should this value be exported. Export strips fields that a user can not specify.` |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+exact |
+Should the export be exact. Exact export maintains cluster-specific fields like Namespace |
+false |
+boolean |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Event |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Event |
+
+
+
+
+
+
+
+
+
+
+
replace the specified Event
+
+
+
PUT /api/v1/namespaces/{namespace}/events/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Event |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Event |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Event |
+
+
+
+
+
+
+
+
+
+
+
delete a Event
+
+
+
DELETE /api/v1/namespaces/{namespace}/events/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.DeleteOptions |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Event |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
partially update the specified Event
+
+
+
PATCH /api/v1/namespaces/{namespace}/events/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Event |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Event |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
list or watch objects of kind Secret
+
+
+
GET /api/v1/namespaces/{namespace}/secrets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.SecretList |
+
+
+
+
+
+
+
+
+
+
+
delete collection of Secret
+
+
+
DELETE /api/v1/namespaces/{namespace}/secrets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
create a Secret
+
+
+
POST /api/v1/namespaces/{namespace}/secrets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Secret |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Secret |
+
+
+
+
+
+
+
+
+
+
+
read the specified Secret
+
+
+
GET /api/v1/namespaces/{namespace}/secrets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+export |
+Should this value be exported. Export strips fields that a user can not specify.` |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+exact |
+Should the export be exact. Exact export maintains cluster-specific fields like Namespace |
+false |
+boolean |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Secret |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Secret |
+
+
+
+
+
+
+
+
+
+
+
replace the specified Secret
+
+
+
PUT /api/v1/namespaces/{namespace}/secrets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Secret |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Secret |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Secret |
+
+
+
+
+
+
+
+
+
+
+
delete a Secret
+
+
+
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.DeleteOptions |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Secret |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
partially update the specified Secret
+
+
+
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Secret |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Secret |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
list or watch objects of kind Service
+
+
+
GET /api/v1/namespaces/{namespace}/services
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.ServiceList |
+
+
+
+
+
+
+
+
+
+
+
delete collection of Service
+
+
+
DELETE /api/v1/namespaces/{namespace}/services
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
create a Service
+
+
+
POST /api/v1/namespaces/{namespace}/services
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Service |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Service |
+
+
+
+
+
+
+
+
+
+
+
read the specified Service
+
+
+
GET /api/v1/namespaces/{namespace}/services/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+export |
+Should this value be exported. Export strips fields that a user can not specify.` |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+exact |
+Should the export be exact. Exact export maintains cluster-specific fields like Namespace |
+false |
+boolean |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Service |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Service |
+
+
+
+
+
+
+
+
+
+
+
replace the specified Service
+
+
+
PUT /api/v1/namespaces/{namespace}/services/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Service |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Service |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Service |
+
+
+
+
+
+
+
+
+
+
+
delete a Service
+
+
+
DELETE /api/v1/namespaces/{namespace}/services/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.DeleteOptions |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Service |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
partially update the specified Service
+
+
+
PATCH /api/v1/namespaces/{namespace}/services/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Service |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Service |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
read status of the specified Service
+
+
+
GET /api/v1/namespaces/{namespace}/services/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Service |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Service |
+
+
+
+
+
+
+
+
+
+
+
replace status of the specified Service
+
+
+
PUT /api/v1/namespaces/{namespace}/services/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Service |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Service |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Service |
+
+
+
+
+
+
+
+
+
+
+
partially update status of the specified Service
+
+
+
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Service |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Service |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
read the specified Namespace
+
+
+
GET /api/v1/namespaces/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+export |
+Should this value be exported. Export strips fields that a user can not specify.` |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+exact |
+Should the export be exact. Exact export maintains cluster-specific fields like Namespace |
+false |
+boolean |
+ |
+
+
+PathParameter |
+name |
+name of the Namespace |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Namespace |
+
+
+
+
+
+
+
+
+
+
+
replace the specified Namespace
+
+
+
PUT /api/v1/namespaces/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Namespace |
+ |
+
+
+PathParameter |
+name |
+name of the Namespace |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Namespace |
+
+
+
+
+
+
+
+
+
+
+
delete a Namespace
+
+
+
DELETE /api/v1/namespaces/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.DeleteOptions |
+ |
+
+
+PathParameter |
+name |
+name of the Namespace |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+unversioned.Status |
+
+
+
+
+
+
+
+
+
+
+
partially update the specified Namespace
+
+
+
PATCH /api/v1/namespaces/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+name |
+name of the Namespace |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Namespace |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
read status of the specified Namespace
+
+
+
GET /api/v1/namespaces/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Namespace |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Namespace |
+
+
+
+
+
+
+
+
+
+
+
replace status of the specified Namespace
+
+
+
PUT /api/v1/namespaces/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+v1.Namespace |
+ |
+
+
+PathParameter |
+name |
+name of the Namespace |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Namespace |
+
+
+
+
+
+
+
+
+
+
+
partially update status of the specified Namespace
+
+
+
PATCH /api/v1/namespaces/{name}/status
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+BodyParameter |
+body |
+ |
+true |
+unversioned.Patch |
+ |
+
+
+PathParameter |
+name |
+name of the Namespace |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.Namespace |
+
+
+
+
+
+
+
Consumes
+
+
+-
+
application/json-patch+json
+
+-
+
application/merge-patch+json
+
+-
+
application/strategic-merge-patch+json
+
+
+
+
+
+
+
+
+
list or watch objects of kind Secret
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.SecretList |
+
+
+
+
+
+
+
+
+
+
+
list or watch objects of kind Service
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+v1.ServiceList |
+
+
+
+
+
+
+
+
+
+
+
watch individual changes to a list of Event
+
+
+
GET /api/v1/watch/events
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch individual changes to a list of Namespace
+
+
+
GET /api/v1/watch/namespaces
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch individual changes to a list of Event
+
+
+
GET /api/v1/watch/namespaces/{namespace}/events
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch changes to an object of kind Event
+
+
+
GET /api/v1/watch/namespaces/{namespace}/events/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Event |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch individual changes to a list of Secret
+
+
+
GET /api/v1/watch/namespaces/{namespace}/secrets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch changes to an object of kind Secret
+
+
+
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Secret |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch individual changes to a list of Service
+
+
+
GET /api/v1/watch/namespaces/{namespace}/services
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch changes to an object of kind Service
+
+
+
GET /api/v1/watch/namespaces/{namespace}/services/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
+ |
+
+
+PathParameter |
+name |
+name of the Service |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch changes to an object of kind Namespace
+
+
+
GET /api/v1/watch/namespaces/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+PathParameter |
+name |
+name of the Namespace |
+true |
+string |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch individual changes to a list of Secret
+
+
+
GET /api/v1/watch/secrets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
watch individual changes to a list of Service
+
+
+
GET /api/v1/watch/services
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+Type |
+Name |
+Description |
+Required |
+Schema |
+Default |
+
+
+
+
+QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
+ |
+
+
+QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
+ |
+
+
+QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
+ |
+
+
+QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. |
+false |
+string |
+ |
+
+
+QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
+ |
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+HTTP Code |
+Description |
+Schema |
+
+
+
+
+200 |
+success |
+*versioned.Event |
+
+
+
+
+
+
+
+
Produces
+
+
+-
+
application/json
+
+-
+
application/json;stream=watch
+
+-
+
application/vnd.kubernetes.protobuf
+
+-
+
application/vnd.kubernetes.protobuf;stream=watch
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/hack/lib/swagger.sh b/hack/lib/swagger.sh
new file mode 100644
index 00000000000..2759370c32a
--- /dev/null
+++ b/hack/lib/swagger.sh
@@ -0,0 +1,154 @@
+#!/bin/bash
+
+# Copyright 2016 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Contains swagger related util functions.
+#
+set -o errexit
+set -o nounset
+set -o pipefail
+
+# The root of the build/dist directory
+KUBE_ROOT="$(cd "$(dirname "${BASH_SOURCE}")/../.." && pwd -P)"
+
+# Generates types_swagger_doc_generated file for the given group version.
+# $1: Name of the group version
+# $2: Path to the directory where types.go for that group version exists. This
+# is the directory where the file will be generated.
+kube::swagger::gen_types_swagger_doc() {
+ local group_version=$1
+ local gv_dir=$2
+ local TMPFILE="/tmp/types_swagger_doc_generated.$(date +%s).go"
+
+ echo "Generating swagger type docs for ${group_version} at ${gv_dir}"
+
+ sed 's/YEAR/2016/' hack/boilerplate/boilerplate.go.txt > "$TMPFILE"
+ echo "package ${group_version##*/}" >> "$TMPFILE"
+ cat >> "$TMPFILE" <> "$TMPFILE"
+
+ echo "// AUTO-GENERATED FUNCTIONS END HERE" >> "$TMPFILE"
+
+ gofmt -w -s "$TMPFILE"
+ mv "$TMPFILE" ""${gv_dir}"/types_swagger_doc_generated.go"
+}
+
+# Generates API reference docs for the given API group versions.
+# Required env vars:
+# GROUP_VERSIONS: Array of group versions to be included in the reference
+# docs.
+# GV_DIRS: Array of root directories for those group versions.
+# Input vars:
+# $1: Root directory path for swagger spec
+# $2: Root directory path where the reference docs should be generated.
+kube::swagger::gen_api_ref_docs() {
+ : "${GROUP_VERSIONS?Must set GROUP_VERSIONS env var}"
+ : "${GV_DIRS?Must set GV_DIRS env var}"
+
+ echo "Generating API reference docs for group versions: ${GROUP_VERSIONS[@]}, at dirs: ${GV_DIRS[@]}"
+ GROUP_VERSIONS=(${GROUP_VERSIONS[@]})
+ GV_DIRS=(${GV_DIRS[@]})
+ local swagger_spec_path=${1}
+ local output_dir=${2}
+ echo "Reading swagger spec from: ${swagger_spec_path}"
+ echo "Generating the docs at: ${output_dir}"
+
+ # Use REPO_DIR if provided so we can set it to the host-resolvable path
+ # to the repo root if we are running this script from a container with
+ # docker mounted in as a volume.
+ # We pass the host output dir as the source dir to `docker run -v`, but use
+ # the regular one to compute diff (they will be the same if running this
+ # test on the host, potentially different if running in a container).
+ local repo_dir=${REPO_DIR:-"${KUBE_ROOT}"}
+ local tmp_subpath="_output/generated_html"
+ local output_tmp_in_host="${repo_dir}/${tmp_subpath}"
+ local output_tmp="${KUBE_ROOT}/${tmp_subpath}"
+
+ echo "Generating api reference docs at ${output_tmp}"
+
+ for ver in "${GROUP_VERSIONS[@]}"; do
+ mkdir -p "${output_tmp}/${ver}"
+ done
+
+ user_flags="-u $(id -u)"
+ if [[ $(uname) == "Darwin" ]]; then
+ # mapping in a uid from OS X doesn't make any sense
+ user_flags=""
+ fi
+
+ for i in "${!GROUP_VERSIONS[@]}"; do
+ local ver=${GROUP_VERSIONS[i]}
+ local dir=${GV_DIRS[i]}
+ local tmp_in_host="${output_tmp_in_host}/${ver}"
+ local register_file="${dir}/register.go"
+ local swagger_json_name="$(kube::util::gv-to-swagger-name "${ver}")"
+
+ docker run ${user_flags} \
+ --rm -v "${tmp_in_host}":/output:z \
+ -v "${swagger_spec_path}":/swagger-source:z \
+ -v "${register_file}":/register.go:z \
+ --net=host -e "https_proxy=${KUBERNETES_HTTPS_PROXY:-}" \
+ gcr.io/google_containers/gen-swagger-docs:v8 \
+ "${swagger_json_name}"
+ done
+
+ # Check if we actually changed anything
+ pushd "${output_tmp}" > /dev/null
+ touch .generated_html
+ find . -type f | cut -sd / -f 2- | LC_ALL=C sort > .generated_html
+ popd > /dev/null
+
+ while read file; do
+ if [[ -e "${output_dir}/${file}" && -e "${output_tmp}/${file}" ]]; then
+ echo "comparing ${output_dir}/${file} with ${output_tmp}/${file}"
+ # Filter all munges from original content.
+ original=$(cat "${output_dir}/${file}")
+ generated=$(cat "${output_tmp}/${file}")
+
+ # Filter out meaningless lines with timestamps
+ original=$(echo "${original}" | grep -v "Last updated" || :)
+ generated=$(echo "${generated}" | grep -v "Last updated" || :)
+
+ # By now, the contents should be normalized and stripped of any
+ # auto-managed content.
+ if diff -B >/dev/null <(echo "${original}") <(echo "${generated}"); then
+ # actual contents same, overwrite generated with original.
+ cp "${output_dir}/${file}" "${output_tmp}/${file}"
+ fi
+ fi
+ done <"${output_tmp}/.generated_html"
+
+ echo "Moving api reference docs from ${output_tmp} to ${output_dir}"
+
+ cp -af "${output_tmp}"/* "${output_dir}"
+ rm -r "${output_tmp}"
+}
diff --git a/hack/update-api-reference-docs.sh b/hack/update-api-reference-docs.sh
index 6827fc909c0..756164940b0 100755
--- a/hack/update-api-reference-docs.sh
+++ b/hack/update-api-reference-docs.sh
@@ -1,6 +1,6 @@
#!/bin/bash
-# Copyright 2015 The Kubernetes Authors.
+# Copyright 2016 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -25,86 +25,21 @@ echo "Note: This assumes that swagger spec has been updated. Please run hack/upd
KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
source "${KUBE_ROOT}/hack/lib/init.sh"
+source "${KUBE_ROOT}/hack/lib/swagger.sh"
kube::golang::setup_env
-DEFAULT_OUTPUT="${KUBE_ROOT}/docs/api-reference"
-OUTPUT=${1:-${DEFAULT_OUTPUT}}
-# Use REPO_DIR if provided so we can set it to the host-resolvable path
-# to the repo root if we are running this script from a container with
-# docker mounted in as a volume.
-# We pass the host output dir as the source dir to `docker run -v`, but use
-# the regular one to compute diff (they will be the same if running this
-# test on the host, potentially different if running in a container).
REPO_DIR=${REPO_DIR:-"${KUBE_ROOT}"}
-TMP_SUBPATH="_output/generated_html"
-OUTPUT_TMP_IN_HOST="${REPO_DIR}/${TMP_SUBPATH}"
-OUTPUT_TMP="${KUBE_ROOT}/${TMP_SUBPATH}"
+DEFAULT_OUTPUT="${REPO_DIR}/docs/api-reference"
+OUTPUT=${1:-${DEFAULT_OUTPUT}}
-echo "Generating api reference docs at ${OUTPUT_TMP}"
+SWAGGER_SPEC_PATH="${REPO_DIR}/api/swagger-spec"
-DEFAULT_GROUP_VERSIONS="v1 extensions/v1beta1 batch/v1 autoscaling/v1 certificates/v1alpha1"
-VERSIONS=${VERSIONS:-$DEFAULT_GROUP_VERSIONS}
-for ver in $VERSIONS; do
- mkdir -p "${OUTPUT_TMP}/${ver}"
+GROUP_VERSIONS=("v1" "extensions/v1beta1" "batch/v1" "autoscaling/v1" "certificates/v1alpha1")
+GV_DIRS=()
+for gv in "${GROUP_VERSIONS[@]}"; do
+ GV_DIRS+=("${REPO_DIR}/pkg/$(kube::util::group-version-to-pkg-path "${gv}")")
done
-SWAGGER_PATH="${REPO_DIR}/api/swagger-spec/"
-
-echo "Reading swagger spec from: ${SWAGGER_PATH}"
-
-user_flags="-u $(id -u)"
-if [[ $(uname) == "Darwin" ]]; then
- # mapping in a uid from OS X doesn't make any sense
- user_flags=""
-fi
-
-for ver in $VERSIONS; do
- TMP_IN_HOST="${OUTPUT_TMP_IN_HOST}/${ver}"
- if [[ ${ver} == "v1" ]]; then
- REGISTER_FILE="${REPO_DIR}/pkg/api/${ver}/register.go"
- else
- REGISTER_FILE="${REPO_DIR}/pkg/apis/${ver}/register.go"
- fi
- SWAGGER_JSON_NAME="$(kube::util::gv-to-swagger-name "${ver}")"
-
- docker run ${user_flags} \
- --rm -v "${TMP_IN_HOST}":/output:z \
- -v "${SWAGGER_PATH}":/swagger-source:z \
- -v "${REGISTER_FILE}":/register.go:z \
- --net=host -e "https_proxy=${KUBERNETES_HTTPS_PROXY:-}" \
- gcr.io/google_containers/gen-swagger-docs:v8 \
- "${SWAGGER_JSON_NAME}"
-done
-
-# Check if we actually changed anything
-pushd "${OUTPUT_TMP}" > /dev/null
-touch .generated_html
-find . -type f | cut -sd / -f 2- | LC_ALL=C sort > .generated_html
-popd > /dev/null
-
-while read file; do
- if [[ -e "${OUTPUT}/${file}" && -e "${OUTPUT_TMP}/${file}" ]]; then
- echo "comparing ${OUTPUT}/${file} with ${OUTPUT_TMP}/${file}"
- # Filter all munges from original content.
- original=$(cat "${OUTPUT}/${file}")
- generated=$(cat "${OUTPUT_TMP}/${file}")
-
- # Filter out meaningless lines with timestamps
- original=$(echo "${original}" | grep -v "Last updated" || :)
- generated=$(echo "${generated}" | grep -v "Last updated" || :)
-
- # By now, the contents should be normalized and stripped of any
- # auto-managed content.
- if diff -B >/dev/null <(echo "${original}") <(echo "${generated}"); then
- # actual contents same, overwrite generated with original.
- cp "${OUTPUT}/${file}" "${OUTPUT_TMP}/${file}"
- fi
- fi
-done <"${OUTPUT_TMP}/.generated_html"
-
-echo "Moving api reference docs from ${OUTPUT_TMP} to ${OUTPUT}"
-
-cp -af "${OUTPUT_TMP}"/* "${OUTPUT}"
-rm -r "${OUTPUT_TMP}"
+GROUP_VERSIONS="${GROUP_VERSIONS[@]}" GV_DIRS="${GV_DIRS[@]}" kube::swagger::gen_api_ref_docs "${SWAGGER_SPEC_PATH}" "${OUTPUT}"
# ex: ts=2 sw=2 et filetype=sh
diff --git a/hack/update-federation-api-reference-docs.sh b/hack/update-federation-api-reference-docs.sh
new file mode 100755
index 00000000000..7d0a160ac90
--- /dev/null
+++ b/hack/update-federation-api-reference-docs.sh
@@ -0,0 +1,50 @@
+#!/bin/bash
+
+# Copyright 2016 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generates updated api-reference docs from the latest swagger spec for
+# federation apiserver. The docs are generated at federation/docs/api-reference
+# Usage: ./update-federation-api-reference-docs.sh
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+echo "Note: This assumes that swagger spec has been updated. Please run hack/update-federation-swagger-spec.sh to ensure that."
+
+KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
+source "${KUBE_ROOT}/hack/lib/init.sh"
+source "${KUBE_ROOT}/hack/lib/swagger.sh"
+kube::golang::setup_env
+
+REPO_DIR=${REPO_DIR:-"${KUBE_ROOT}"}
+DEFAULT_OUTPUT="${REPO_DIR}/federation/docs/api-reference"
+OUTPUT=${1:-${DEFAULT_OUTPUT}}
+
+SWAGGER_SPEC_PATH="${REPO_DIR}/federation/apis/swagger-spec"
+
+GROUP_VERSIONS=("federation/v1beta1" "v1" "extensions/v1beta1")
+GV_DIRS=()
+for gv in "${GROUP_VERSIONS[@]}"; do
+ if [[ ${gv} == "federation/v1beta1" ]]; then
+ GV_DIRS+=("${REPO_DIR}/federation/$(kube::util::group-version-to-pkg-path "${gv}")")
+ else
+ GV_DIRS+=("${REPO_DIR}/pkg/$(kube::util::group-version-to-pkg-path "${gv}")")
+ fi
+done
+
+GROUP_VERSIONS="${GROUP_VERSIONS[@]}" GV_DIRS="${GV_DIRS[@]}" kube::swagger::gen_api_ref_docs "${SWAGGER_SPEC_PATH}" "${OUTPUT}"
+
+# ex: ts=2 sw=2 et filetype=sh
diff --git a/hack/update-federation-generated-swagger-docs.sh b/hack/update-federation-generated-swagger-docs.sh
new file mode 100755
index 00000000000..dc566b7ed84
--- /dev/null
+++ b/hack/update-federation-generated-swagger-docs.sh
@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# Copyright 2016 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generates `types_swagger_doc_generated.go` files for federation API group
+# versions. That file contains functions on API structs that return the comments
+# that should be surfaced for the corresponding API type in our API docs.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
+source "${KUBE_ROOT}/hack/lib/init.sh"
+source "${KUBE_ROOT}/hack/lib/swagger.sh"
+
+kube::golang::setup_env
+
+GROUP_VERSIONS=(federation/v1beta1)
+GV_DIRS=()
+for gv in "${GROUP_VERSIONS[@]}"; do
+ GV_DIRS+=("federation/$(kube::util::group-version-to-pkg-path "${gv}")")
+done
+
+# To avoid compile errors, remove the currently existing files.
+for gv_dir in "${GV_DIRS[@]}"; do
+ rm -f "${gv_dir}/types_swagger_doc_generated.go"
+done
+for i in "${!GROUP_VERSIONS[@]}"; do
+ kube::swagger::gen_types_swagger_doc "${GROUP_VERSIONS[i]}" "${GV_DIRS[i]}"
+done
diff --git a/hack/update-federation-swagger-spec.sh b/hack/update-federation-swagger-spec.sh
index 13ac615c49a..3ef3264c79b 100755
--- a/hack/update-federation-swagger-spec.sh
+++ b/hack/update-federation-swagger-spec.sh
@@ -24,7 +24,8 @@ set -o pipefail
cat << __EOF__
Note: This assumes that the 'types_swagger_doc_generated.go' file has been
updated for all API group versions. If you are unsure, please run
-hack/update-generated-swagger-docs.sh first.
+hack/update-generated-swagger-docs.sh and
+hack/update-federation-generated-swagger-docs.sh first.
__EOF__
KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
diff --git a/hack/update-generated-swagger-docs.sh b/hack/update-generated-swagger-docs.sh
index f90aab28b67..af56c9de929 100755
--- a/hack/update-generated-swagger-docs.sh
+++ b/hack/update-generated-swagger-docs.sh
@@ -14,54 +14,25 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+# Generates `types_swagger_doc_generated.go` files for federation API group
+# versions. That file contains functions on API structs that return the comments
+# that should be surfaced for the corresponding API type in our API docs.
+
set -o errexit
set -o nounset
set -o pipefail
KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
source "${KUBE_ROOT}/hack/lib/init.sh"
+source "${KUBE_ROOT}/hack/lib/swagger.sh"
kube::golang::setup_env
-function generate_version() {
- local group_version=$1
- local TMPFILE="/tmp/types_swagger_doc_generated.$(date +%s).go"
-
- echo "Generating swagger type docs for ${group_version}"
-
- sed 's/YEAR/2016/' hack/boilerplate/boilerplate.go.txt > "$TMPFILE"
- echo "package ${group_version##*/}" >> "$TMPFILE"
- cat >> "$TMPFILE" <> "$TMPFILE"
-
- echo "// AUTO-GENERATED FUNCTIONS END HERE" >> "$TMPFILE"
-
- gofmt -w -s "$TMPFILE"
- mv "$TMPFILE" "pkg/$(kube::util::group-version-to-pkg-path "${group_version}")/types_swagger_doc_generated.go"
-}
-
GROUP_VERSIONS=(unversioned v1 authentication/v1beta1 authorization/v1beta1 autoscaling/v1 batch/v1 batch/v2alpha1 extensions/v1beta1 apps/v1alpha1 policy/v1alpha1 rbac/v1alpha1 certificates/v1alpha1)
# To avoid compile errors, remove the currently existing files.
for group_version in "${GROUP_VERSIONS[@]}"; do
rm -f "pkg/$(kube::util::group-version-to-pkg-path "${group_version}")/types_swagger_doc_generated.go"
done
for group_version in "${GROUP_VERSIONS[@]}"; do
- generate_version "${group_version}"
+ kube::swagger::gen_types_swagger_doc "${group_version}" "pkg/$(kube::util::group-version-to-pkg-path "${group_version}")"
done