docs/reference/build/index.html

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>API Reference</title>
<link rel="shortcut icon" href="favicon.ico" type="image/vnd.microsoft.icon">
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="node_modules/bootstrap/dist/css/bootstrap.min.css">
<link rel="stylesheet" href="node_modules/font-awesome/css/font-awesome.min.css" type="text/css">
<link rel="stylesheet" href="node_modules/highlight.js/styles/default.css" type="text/css">
<link rel="stylesheet" href="stylesheet.css" type="text/css">
</head>
<body>
<div id="sidebar-wrapper" class="side-nav side-bar-nav"><ul><li class="nav-level-1 strong-nav"><a href="#-strong-clusterregistry-strong-" class="nav-item"><strong>Clusterregistry</strong></a></li></ul><ul><li class="nav-level-1"><a href="#cluster-v1alpha1" class="nav-item">Cluster v1alpha1</a></li></ul><ul><li class="nav-level-1 strong-nav"><a href="#-strong-old-api-versions-strong-" class="nav-item"><strong>Old API Versions</strong></a></li></ul><ul><li class="nav-level-1 strong-nav"><a href="#-strong-field-definitions-strong-" class="nav-item"><strong>Field Definitions</strong></a></li><ul id="-strong-field-definitions-strong--nav" style="display: none;"><li class="nav-level-2"><a href="#authinfo-v1alpha1" class="nav-item">AuthInfo v1alpha1</a></li><li class="nav-level-2"><a href="#clustercondition-v1alpha1" class="nav-item">ClusterCondition v1alpha1</a></li><li class="nav-level-2"><a href="#initializer-v1" class="nav-item">Initializer v1</a></li><li class="nav-level-2"><a href="#initializers-v1" class="nav-item">Initializers v1</a></li><li class="nav-level-2"><a href="#kubernetesapiendpoints-v1alpha1" class="nav-item">KubernetesAPIEndpoints v1alpha1</a></li><li class="nav-level-2"><a href="#listmeta-v1" class="nav-item">ListMeta v1</a></li><li class="nav-level-2"><a href="#objectmeta-v1" class="nav-item">ObjectMeta v1</a></li><li class="nav-level-2"><a href="#objectreference-v1alpha1" class="nav-item">ObjectReference v1alpha1</a></li><li class="nav-level-2"><a href="#ownerreference-v1" class="nav-item">OwnerReference v1</a></li><li class="nav-level-2"><a href="#serveraddressbyclientcidr-v1alpha1" class="nav-item">ServerAddressByClientCIDR v1alpha1</a></li><li class="nav-level-2"><a href="#status-v1" class="nav-item">Status v1</a></li><li class="nav-level-2"><a href="#statuscause-v1" class="nav-item">StatusCause v1</a></li><li class="nav-level-2"><a href="#statusdetails-v1" class="nav-item">StatusDetails v1</a></li><li class="nav-level-2"><a href="#time-v1" class="nav-item">Time v1</a></li></ul></ul><br/><div class="copyright"><a href="https://github.com/kubernetes/kubernetes">Copyright 2018 The Kubernetes Authors.</a></div></div>
<div id="wrapper">
<div id="code-tabs-wrapper" class="code-tabs"><ul class="code-tab-list"></ul></div>
<div id="page-content-wrapper" class="body-content container-fluid"><h1 id="-strong-clusterregistry-strong-"><strong>Clusterregistry</strong></h1>
<hr>
<hr>
<h1 id="cluster-v1alpha1">Cluster v1alpha1</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clusterregistry</code></td>
<td><code>v1alpha1</code></td>
<td><code>Cluster</code></td>
</tr>
</tbody>
</table>
<p>Cluster contains information about a cluster in a cluster registry.</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/api-conventions.md#resources</a></td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> <em><a href="#objectmeta-v1">ObjectMeta</a></em></td>
<td>Standard object&#39;s metadata. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata</a></td>
</tr>
<tr>
<td><code>spec</code><br /> <em><a href="#clusterspec-v1alpha1">ClusterSpec</a></em></td>
<td>Spec is the specification of the cluster. This may or may not be reconciled by an active controller.</td>
</tr>
<tr>
<td><code>status</code><br /> <em><a href="#clusterstatus-v1alpha1">ClusterStatus</a></em></td>
<td>Status is the status of the cluster.</td>
</tr>
</tbody>
</table>
<h3 id="clusterspec-v1alpha1">ClusterSpec v1alpha1</h3>
<aside class="notice">
Appears In:

<ul>
<li><a href="#cluster-v1alpha1">Cluster v1alpha1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>authInfo</code><br /> <em><a href="#authinfo-v1alpha1">AuthInfo</a></em></td>
<td>AuthInfo contains public information that can be used to authenticate to and authorize with this cluster. It is not meant to store private information (e.g., tokens or client certificates) and cluster registry implementations are not expected to provide hardened storage for secrets.</td>
</tr>
<tr>
<td><code>kubernetesApiEndpoints</code><br /> <em><a href="#kubernetesapiendpoints-v1alpha1">KubernetesAPIEndpoints</a></em></td>
<td>KubernetesAPIEndpoints represents the endpoints of the API server for this cluster.</td>
</tr>
</tbody>
</table>
<h3 id="clusterstatus-v1alpha1">ClusterStatus v1alpha1</h3>
<aside class="notice">
Appears In:

<ul>
<li><a href="#cluster-v1alpha1">Cluster v1alpha1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>conditions</code><br /> <em><a href="#clustercondition-v1alpha1">ClusterCondition</a> array</em></td>
<td>Conditions contains the different condition statuses for this cluster.</td>
</tr>
</tbody>
</table>
<h1 id="-strong-old-api-versions-strong-"><strong>Old API Versions</strong></h1>
<hr>
<h1 id="-strong-field-definitions-strong-"><strong>Field Definitions</strong></h1>
<hr>
<h2 id="authinfo-v1alpha1">AuthInfo v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clusterregistry</code></td>
<td><code>v1alpha1</code></td>
<td><code>AuthInfo</code></td>
</tr>
</tbody>
</table>
<p>AuthInfo holds information that describes how a client can get credentials to access the cluster. For example, OAuth2 client registration endpoints and supported flows, or Kerberos server locations.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#clusterspec-v1alpha1">ClusterSpec v1alpha1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>controller</code><br /> <em><a href="#objectreference-v1alpha1">ObjectReference</a></em></td>
<td>Controller references an object that contains implementation-specific details about how a controller should authenticate. A simple use case for this would be to reference a secret in another namespace that stores a bearer token that can be used to authenticate against this cluster&#39;s API server.</td>
</tr>
<tr>
<td><code>user</code><br /> <em><a href="#objectreference-v1alpha1">ObjectReference</a></em></td>
<td>User references an object that contains implementation-specific details about how a user should authenticate against this cluster.</td>
</tr>
</tbody>
</table>
<h2 id="clustercondition-v1alpha1">ClusterCondition v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clusterregistry</code></td>
<td><code>v1alpha1</code></td>
<td><code>ClusterCondition</code></td>
</tr>
</tbody>
</table>
<p>ClusterCondition contains condition information for a cluster.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#clusterstatus-v1alpha1">ClusterStatus v1alpha1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>lastHeartbeatTime</code><br /> <em><a href="#time-v1">Time</a></em></td>
<td>LastHeartbeatTime is the last time this condition was updated.</td>
</tr>
<tr>
<td><code>lastTransitionTime</code><br /> <em><a href="#time-v1">Time</a></em></td>
<td>LastTransitionTime is the last time the condition changed from one status to another.</td>
</tr>
<tr>
<td><code>message</code><br /> <em>string</em></td>
<td>Message is a human-readable message indicating details about the last status change.</td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>Reason is a (brief) reason for the condition&#39;s last status change.</td>
</tr>
<tr>
<td><code>status</code><br /> <em>string</em></td>
<td>Status is the status of the condition. One of True, False, Unknown.</td>
</tr>
<tr>
<td><code>type</code><br /> <em>string</em></td>
<td>Type is the type of the cluster condition.</td>
</tr>
</tbody>
</table>
<h2 id="initializer-v1">Initializer v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>Initializer</code></td>
</tr>
</tbody>
</table>
<p>Initializer is information about an initializer that has not yet completed.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#initializers-v1">Initializers v1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>name of the process that is responsible for initializing this object.</td>
</tr>
</tbody>
</table>
<h2 id="initializers-v1">Initializers v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>Initializers</code></td>
</tr>
</tbody>
</table>
<p>Initializers tracks the progress of initialization.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#objectmeta-v1">ObjectMeta v1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>pending</code><br /> <em><a href="#initializer-v1">Initializer</a> array</em>  <br /> <strong>patch type</strong>: <em>merge</em>  <br /> <strong>patch merge key</strong>: <em>name</em></td>
<td>Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.</td>
</tr>
<tr>
<td><code>result</code><br /> <em><a href="#status-v1">Status</a></em></td>
<td>If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.</td>
</tr>
</tbody>
</table>
<h2 id="kubernetesapiendpoints-v1alpha1">KubernetesAPIEndpoints v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clusterregistry</code></td>
<td><code>v1alpha1</code></td>
<td><code>KubernetesAPIEndpoints</code></td>
</tr>
</tbody>
</table>
<p>KubernetesAPIEndpoints represents the endpoints for one and only one Kubernetes API server.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#clusterspec-v1alpha1">ClusterSpec v1alpha1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>caBundle</code><br /> <em>string</em></td>
<td>CABundle contains the certificate authority information.</td>
</tr>
<tr>
<td><code>serverEndpoints</code><br /> <em><a href="#serveraddressbyclientcidr-v1alpha1">ServerAddressByClientCIDR</a> array</em></td>
<td>ServerEndpoints specifies the address(es) of the Kubernetes API server’s network identity or identities.</td>
</tr>
</tbody>
</table>
<h2 id="listmeta-v1">ListMeta v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>ListMeta</code></td>
</tr>
</tbody>
</table>
<p>ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#status-v1">Status v1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>continue</code><br /> <em>string</em></td>
<td>continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.</td>
</tr>
<tr>
<td><code>resourceVersion</code><br /> <em>string</em></td>
<td>String that identifies the server&#39;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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency">https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency</a></td>
</tr>
<tr>
<td><code>selfLink</code><br /> <em>string</em></td>
<td>selfLink is a URL representing this object. Populated by the system. Read-only.</td>
</tr>
</tbody>
</table>
<h2 id="objectmeta-v1">ObjectMeta v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>ObjectMeta</code></td>
</tr>
</tbody>
</table>
<p>ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#cluster-v1alpha1">Cluster v1alpha1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>annotations</code><br /> <em>object</em></td>
<td>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: <a href="http://kubernetes.io/docs/user-guide/annotations">http://kubernetes.io/docs/user-guide/annotations</a></td>
</tr>
<tr>
<td><code>clusterName</code><br /> <em>string</em></td>
<td>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.</td>
</tr>
<tr>
<td><code>creationTimestamp</code><br /> <em><a href="#time-v1">Time</a></em></td>
<td>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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata</a></td>
</tr>
<tr>
<td><code>deletionGracePeriodSeconds</code><br /> <em>integer</em></td>
<td>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.</td>
</tr>
<tr>
<td><code>deletionTimestamp</code><br /> <em><a href="#time-v1">Time</a></em></td>
<td>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 is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is 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. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. 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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata">https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata</a></td>
</tr>
<tr>
<td><code>finalizers</code><br /> <em>string array</em>  <br /> <strong>patch type</strong>: <em>merge</em></td>
<td>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.</td>
</tr>
<tr>
<td><code>generateName</code><br /> <em>string</em></td>
<td>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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency">https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency</a></td>
</tr>
<tr>
<td><code>generation</code><br /> <em>integer</em></td>
<td>A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.</td>
</tr>
<tr>
<td><code>initializers</code><br /> <em><a href="#initializers-v1">Initializers</a></em></td>
<td>An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven&#39;t explicitly asked to observe uninitialized objects.  When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.</td>
</tr>
<tr>
<td><code>labels</code><br /> <em>object</em></td>
<td>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: <a href="http://kubernetes.io/docs/user-guide/labels">http://kubernetes.io/docs/user-guide/labels</a></td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>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: <a href="http://kubernetes.io/docs/user-guide/identifiers#names">http://kubernetes.io/docs/user-guide/identifiers#names</a></td>
</tr>
<tr>
<td><code>namespace</code><br /> <em>string</em></td>
<td>Namespace defines the space within each name must be unique. An empty namespace is equivalent to the &#34;default&#34; namespace, but &#34;default&#34; 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: <a href="http://kubernetes.io/docs/user-guide/namespaces">http://kubernetes.io/docs/user-guide/namespaces</a></td>
</tr>
<tr>
<td><code>ownerReferences</code><br /> <em><a href="#ownerreference-v1">OwnerReference</a> array</em>  <br /> <strong>patch type</strong>: <em>merge</em>  <br /> <strong>patch merge key</strong>: <em>uid</em></td>
<td>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.</td>
</tr>
<tr>
<td><code>resourceVersion</code><br /> <em>string</em></td>
<td>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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency">https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency</a></td>
</tr>
<tr>
<td><code>selfLink</code><br /> <em>string</em></td>
<td>SelfLink is a URL representing this object. Populated by the system. Read-only.</td>
</tr>
<tr>
<td><code>uid</code><br /> <em>string</em></td>
<td>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: <a href="http://kubernetes.io/docs/user-guide/identifiers#uids">http://kubernetes.io/docs/user-guide/identifiers#uids</a></td>
</tr>
</tbody>
</table>
<h2 id="objectreference-v1alpha1">ObjectReference v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clusterregistry</code></td>
<td><code>v1alpha1</code></td>
<td><code>ObjectReference</code></td>
</tr>
</tbody>
</table>
<p>ObjectReference contains enough information to let you inspect or modify the referred object.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#authinfo-v1alpha1">AuthInfo v1alpha1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>Kind contains the kind of the referent, e.g., Secret or ConfigMap More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>Name contains the name of the referent. More info: <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names">https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names</a></td>
</tr>
<tr>
<td><code>namespace</code><br /> <em>string</em></td>
<td>Namespace contains the namespace of the referent. More info: <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/">https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/</a></td>
</tr>
</tbody>
</table>
<h2 id="ownerreference-v1">OwnerReference v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>OwnerReference</code></td>
</tr>
</tbody>
</table>
<p>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.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#objectmeta-v1">ObjectMeta v1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>API version of the referent.</td>
</tr>
<tr>
<td><code>blockOwnerDeletion</code><br /> <em>boolean</em></td>
<td>If true, AND if the owner has the &#34;foregroundDeletion&#34; finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs &#34;delete&#34; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.</td>
</tr>
<tr>
<td><code>controller</code><br /> <em>boolean</em></td>
<td>If true, this reference points to the managing controller.</td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>Kind of the referent. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>Name of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#names">http://kubernetes.io/docs/user-guide/identifiers#names</a></td>
</tr>
<tr>
<td><code>uid</code><br /> <em>string</em></td>
<td>UID of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#uids">http://kubernetes.io/docs/user-guide/identifiers#uids</a></td>
</tr>
</tbody>
</table>
<h2 id="serveraddressbyclientcidr-v1alpha1">ServerAddressByClientCIDR v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clusterregistry</code></td>
<td><code>v1alpha1</code></td>
<td><code>ServerAddressByClientCIDR</code></td>
</tr>
</tbody>
</table>
<p>ServerAddressByClientCIDR helps clients determine the server address that they should use, depending on the ClientCIDR that they match.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#kubernetesapiendpoints-v1alpha1">KubernetesAPIEndpoints v1alpha1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clientCIDR</code><br /> <em>string</em></td>
<td>The CIDR with which clients can match their IP to figure out if they should use the corresponding server address.</td>
</tr>
<tr>
<td><code>serverAddress</code><br /> <em>string</em></td>
<td>Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.</td>
</tr>
</tbody>
</table>
<h2 id="status-v1">Status v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>Status</code></td>
</tr>
</tbody>
</table>
<p>Status is a return value for calls that don&#39;t return other objects.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#initializers-v1">Initializers v1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/api-conventions.md#resources</a></td>
</tr>
<tr>
<td><code>code</code><br /> <em>integer</em></td>
<td>Suggested HTTP return code for this status, 0 if not set.</td>
</tr>
<tr>
<td><code>details</code><br /> <em><a href="#statusdetails-v1">StatusDetails</a></em></td>
<td>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.</td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>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: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>message</code><br /> <em>string</em></td>
<td>A human-readable description of the status of this operation.</td>
</tr>
<tr>
<td><code>metadata</code><br /> <em><a href="#listmeta-v1">ListMeta</a></em></td>
<td>Standard list metadata. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>A machine-readable description of why this operation is in the &#34;Failure&#34; status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.</td>
</tr>
<tr>
<td><code>status</code><br /> <em>string</em></td>
<td>Status of the operation. One of: &#34;Success&#34; or &#34;Failure&#34;. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status">https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status</a></td>
</tr>
</tbody>
</table>
<h2 id="statuscause-v1">StatusCause v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>StatusCause</code></td>
</tr>
</tbody>
</table>
<p>StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#statusdetails-v1">StatusDetails v1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>field</code><br /> <em>string</em></td>
<td>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:   &#34;name&#34; - the field &#34;name&#34; on the current resource   &#34;items[0].name&#34; - the field &#34;name&#34; on the first array entry in &#34;items&#34;</td>
</tr>
<tr>
<td><code>message</code><br /> <em>string</em></td>
<td>A human-readable description of the cause of the error.  This field may be presented as-is to a reader.</td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>A machine-readable description of the cause of the error. If this value is empty there is no information available.</td>
</tr>
</tbody>
</table>
<h2 id="statusdetails-v1">StatusDetails v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>StatusDetails</code></td>
</tr>
</tbody>
</table>
<p>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.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#status-v1">Status v1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>causes</code><br /> <em><a href="#statuscause-v1">StatusCause</a> array</em></td>
<td>The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.</td>
</tr>
<tr>
<td><code>group</code><br /> <em>string</em></td>
<td>The group attribute of the resource associated with the status StatusReason.</td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).</td>
</tr>
<tr>
<td><code>retryAfterSeconds</code><br /> <em>integer</em></td>
<td>If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.</td>
</tr>
<tr>
<td><code>uid</code><br /> <em>string</em></td>
<td>UID of the resource. (when there is a single resource which can be described). More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#uids">http://kubernetes.io/docs/user-guide/identifiers#uids</a></td>
</tr>
</tbody>
</table>
<h2 id="time-v1">Time v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>Time</code></td>
</tr>
</tbody>
</table>
<p>Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.</p>
<aside class="notice">
Appears In:

<ul> 
<li><a href="#clustercondition-v1alpha1">ClusterCondition v1alpha1</a></li>
<li><a href="#objectmeta-v1">ObjectMeta v1</a></li>
</ul></aside>

<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td></td>
</tr>
</tbody>
</table>
</div>
</div>
<script src="node_modules/jquery/dist/jquery.min.js"></script>
<script src="node_modules/jquery.scrollto/jquery.scrollTo.min.js"></script>
<script src="navData.js"></script>
<script src="scroll.js"></script>
<!--<script src="actions.js"></script>-->
<script src="tabvisibility.js"></script>
</body>
</html>