Skip to content
This repository was archived by the owner on Mar 26, 2021. It is now read-only.

Commit c7e786a

Browse files
authored
Merge pull request #238 from perotinus/lor
Update the cluster type definition to use a locally-defined object reference.
2 parents 815e7ca + 41c0fd7 commit c7e786a

12 files changed

+164
-96
lines changed

cluster-registry-crd.yaml

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ metadata:
44
creationTimestamp: null
55
labels:
66
api: ""
7-
kubebuilder.k8s.io: 0.1.9
7+
kubebuilder.k8s.io: 0.1.10
88
name: clusters.clusterregistry.k8s.io
99
spec:
1010
group: clusterregistry.k8s.io
@@ -25,9 +25,23 @@ spec:
2525
properties:
2626
authInfo:
2727
properties:
28-
controllerAuthInfo:
28+
controller:
29+
properties:
30+
kind:
31+
type: string
32+
name:
33+
type: string
34+
namespace:
35+
type: string
2936
type: object
30-
userAuthInfo:
37+
user:
38+
properties:
39+
kind:
40+
type: string
41+
name:
42+
type: string
43+
namespace:
44+
type: string
3145
type: object
3246
type: object
3347
kubernetesApiEndpoints:

docs/reference/build/documents/_generated_authinfo_v1alpha1_clusterregistry_definition.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ Appears In:
1717

1818
Field | Description
1919
------------ | -----------
20-
`controllerAuthInfo`<br /> *[ObjectReference](#objectreference-v1)* | ControllerAuthInfo 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.
21-
`userAuthInfo`<br /> *[ObjectReference](#objectreference-v1)* | UserAuthInfo references an object that contains implementation-specific details about how a user should authenticate against this cluster.
20+
`controller`<br /> *[ObjectReference](#objectreference-v1alpha1)* | 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.
21+
`user`<br /> *[ObjectReference](#objectreference-v1alpha1)* | User references an object that contains implementation-specific details about how a user should authenticate against this cluster.
2222

docs/reference/build/documents/_generated_objectreference_v1_core_definition.md

Lines changed: 0 additions & 27 deletions
This file was deleted.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## ObjectReference v1alpha1
2+
3+
Group | Version | Kind
4+
------------ | ---------- | -----------
5+
`clusterregistry` | `v1alpha1` | `ObjectReference`
6+
7+
8+
9+
ObjectReference contains enough information to let you inspect or modify the referred object.
10+
11+
<aside class="notice">
12+
Appears In:
13+
14+
<ul>
15+
<li><a href="#authinfo-v1alpha1">AuthInfo v1alpha1</a></li>
16+
</ul></aside>
17+
18+
Field | Description
19+
------------ | -----------
20+
`kind`<br /> *string* | Kind contains the kind of the referent, e.g., Secret or ConfigMap More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
21+
`name`<br /> *string* | Name contains the name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
22+
`namespace`<br /> *string* | Namespace contains the namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
23+

docs/reference/build/index.html

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" href="stylesheet.css" type="text/css">
1212
</head>
1313
<body>
14-
<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-v1" class="nav-item">ObjectReference v1</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>
14+
<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>
1515
<div id="wrapper">
1616
<div id="code-tabs-wrapper" class="code-tabs"><ul class="code-tab-list"></ul></div>
1717
<div id="page-content-wrapper" class="body-content container-fluid"><h1 id="-strong-clusterregistry-strong-"><strong>Clusterregistry</strong></h1>
@@ -151,12 +151,12 @@ <h2 id="authinfo-v1alpha1">AuthInfo v1alpha1</h2>
151151
</thead>
152152
<tbody>
153153
<tr>
154-
<td><code>controllerAuthInfo</code><br /> <em><a href="#objectreference-v1">ObjectReference</a></em></td>
155-
<td>ControllerAuthInfo 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>
154+
<td><code>controller</code><br /> <em><a href="#objectreference-v1alpha1">ObjectReference</a></em></td>
155+
<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>
156156
</tr>
157157
<tr>
158-
<td><code>userAuthInfo</code><br /> <em><a href="#objectreference-v1">ObjectReference</a></em></td>
159-
<td>UserAuthInfo references an object that contains implementation-specific details about how a user should authenticate against this cluster.</td>
158+
<td><code>user</code><br /> <em><a href="#objectreference-v1alpha1">ObjectReference</a></em></td>
159+
<td>User references an object that contains implementation-specific details about how a user should authenticate against this cluster.</td>
160160
</tr>
161161
</tbody>
162162
</table>
@@ -490,7 +490,7 @@ <h2 id="objectmeta-v1">ObjectMeta v1</h2>
490490
</tr>
491491
</tbody>
492492
</table>
493-
<h2 id="objectreference-v1">ObjectReference v1</h2>
493+
<h2 id="objectreference-v1alpha1">ObjectReference v1alpha1</h2>
494494
<table>
495495
<thead>
496496
<tr>
@@ -501,8 +501,8 @@ <h2 id="objectreference-v1">ObjectReference v1</h2>
501501
</thead>
502502
<tbody>
503503
<tr>
504-
<td><code>core</code></td>
505-
<td><code>v1</code></td>
504+
<td><code>clusterregistry</code></td>
505+
<td><code>v1alpha1</code></td>
506506
<td><code>ObjectReference</code></td>
507507
</tr>
508508
</tbody>
@@ -524,32 +524,16 @@ <h2 id="objectreference-v1">ObjectReference v1</h2>
524524
</thead>
525525
<tbody>
526526
<tr>
527-
<td><code>apiVersion</code><br /> <em>string</em></td>
528-
<td>API version of the referent.</td>
529-
</tr>
530-
<tr>
531-
<td><code>fieldPath</code><br /> <em>string</em></td>
532-
<td>If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: &#34;spec.containers{name}&#34; (where &#34;name&#34; refers to the name of the container that triggered the event) or if no container name is specified &#34;spec.containers[2]&#34; (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.</td>
533-
</tr>
534-
<tr>
535527
<td><code>kind</code><br /> <em>string</em></td>
536-
<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>
528+
<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>
537529
</tr>
538530
<tr>
539531
<td><code>name</code><br /> <em>string</em></td>
540-
<td>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>
532+
<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>
541533
</tr>
542534
<tr>
543535
<td><code>namespace</code><br /> <em>string</em></td>
544-
<td>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>
545-
</tr>
546-
<tr>
547-
<td><code>resourceVersion</code><br /> <em>string</em></td>
548-
<td>Specific resourceVersion to which this reference is made, if any. 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>
549-
</tr>
550-
<tr>
551-
<td><code>uid</code><br /> <em>string</em></td>
552-
<td>UID of the referent. More info: <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids">https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids</a></td>
536+
<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>
553537
</tr>
554538
</tbody>
555539
</table>

docs/reference/build/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"filename": "_generated_objectmeta_v1_meta_definition.md"
3636
},
3737
{
38-
"filename": "_generated_objectreference_v1_core_definition.md"
38+
"filename": "_generated_objectreference_v1alpha1_clusterregistry_definition.md"
3939
},
4040
{
4141
"filename": "_generated_ownerreference_v1_meta_definition.md"

docs/reference/build/navData.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)