Merge pull request #234 from perotinus/statusandca

Two updates to the cluster API: adding a condition to the status, and modifying the AuthInfo

Author: k8s-ci-robot

cluster-registry-crd.yaml

@@ -21,20 +21,10 @@ spec:
           properties:
             authInfo:
               properties:
-                providers:
-                  items:
-                    properties:
-                      config:
-                        type: object
-                      name:
-                        type: string
-                      type:
-                        properties:
-                          name:
-                            type: string
-                        type: object
-                    type: object
-                  type: array
+                controllerAuthInfo:
+                  type: object
+                userAuthInfo:
+                  type: object
               type: object
             kubernetesApiEndpoints:
               properties:
@@ -54,6 +44,26 @@ spec:
               type: object
           type: object
         status:
+          properties:
+            conditions:
+              items:
+                properties:
+                  lastHeartbeatTime:
+                    format: date-time
+                    type: string
+                  lastTransitionTime:
+                    format: date-time
+                    type: string
+                  message:
+                    type: string
+                  reason:
+                    type: string
+                  status:
+                    type: string
+                  type:
+                    type: string
+                type: object
+              type: array
           type: object
       type: object
   version: v1alpha1

docs/development.md

@@ -15,14 +15,14 @@ You must install [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
 in order to work in this repository. `kubebuilder` is in active development, and
 we expect that the structure of this repository will need to change as
 `kubebuilder` is improved. All of the commands below are verified to work with
-`kubebuilder` `0.1.7`.
+`kubebuilder` `0.1.9`.
 
 ## Run all tests
 
 To set up the testing environment, run:
 
 ```
-$ kubebuilder update vendor
+$ kubebuilder update vendor --overwrite-dep-manifest
 $ KUBEBUILDER_PATH=<path_to_your_kubebuilder_install>
 $ export TEST_ASSET_ETCD=$KUBEBUILDER_PATH/bin/etcd
 $ export TEST_ASSET_KUBE_APISERVER=$KUBEBUILDER_PATH/bin/kube-apiserver
@@ -49,8 +49,12 @@ To update generated code after modifying the cluster type, run these commands
 from the repo root:
 
 ```
+$ kubebuilder update vendor --overwrite-dep-manifest
 $ kubebuilder generate
-$ kubebuilder docs --cleanup=false
+$ kubebuilder docs  # This will fail because of missing dependencies.
+$ dep ensure
+$ kubebuilder docs
+$ chown -R $USER docs/reference/build  # The generated docs are owned by root.
 $ kubebuilder create config --crds --output cluster-registry-crd.yaml
 ```
 
@@ -59,9 +63,7 @@ OpenAPI spec in `docs/reference/openapi-spec`, and update the CRD YAML
 definition in the repo root.
 
 After running the commands, edit `cluster-registry-crd.yaml` to remove the
-`status` field, the `creationTimestamp` and `labels` from the `metadata`, and
-the `additionalProperties` field (as in
-https://github.com/kubernetes/cluster-registry/pull/231).
+`status` field, and the `creationTimestamp` and `labels` from the `metadata`.
 
 ## Verify Go source files
 

docs/reference/build/documents/_clusterregistry.md

@@ -1,5 +1,5 @@
 
-# <strong>clusterregistry</strong>
+# <strong>Clusterregistry</strong>
 
 ------------
 

docs/reference/build/documents/_definitions.md

@@ -1,5 +1,5 @@
 
-# <strong>Definitions</strong>
+# <strong>Field Definitions</strong>
 
 ------------
 

docs/reference/build/documents/_generated_apigroup_v1_meta_definition.md

@@ -1,23 +1,22 @@
-## AuthInfo v1alpha1 clusterregistry
+## AuthInfo v1alpha1
 
 Group        | Version     | Kind
 ------------ | ---------- | -----------
-clusterregistry | v1alpha1 | AuthInfo
+`clusterregistry` | `v1alpha1` | `AuthInfo`
 
 
 
-AuthInfo holds public information that describes how a client can get credentials to access the cluster. For example, OAuth2 client registration endpoints and supported flows, or Kerberos servers locations.
-
-It should not hold any private or sensitive information.
+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.
 
 <aside class="notice">
 Appears In:
 
 <ul> 
-<li><a href="#clusterspec-v1alpha1-clusterregistry">ClusterSpec clusterregistry/v1alpha1</a></li>
+<li><a href="#clusterspec-v1alpha1">ClusterSpec v1alpha1</a></li>
 </ul></aside>
 
 Field        | Description
 ------------ | -----------
-providers <br /> *[AuthProviderConfig](#authproviderconfig-v1alpha1-clusterregistry) array*    | AuthProviders is a list of configurations for auth providers.
+`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.
+`userAuthInfo`<br /> *[ObjectReference](#objectreference-v1)*    | UserAuthInfo references an object that contains implementation-specific details about how a user should authenticate against this cluster.
 

docs/reference/build/documents/_generated_apiresource_v1_meta_definition.md

@@ -1,13 +1,13 @@
 
 
 -----------
-# Cluster v1alpha1 clusterregistry
+# Cluster v1alpha1
 
 
 
 Group        | Version     | Kind
 ------------ | ---------- | -----------
-clusterregistry | v1alpha1 | Cluster
+`clusterregistry` | `v1alpha1` | `Cluster`
 
 
 
@@ -17,58 +17,43 @@ clusterregistry | v1alpha1 | Cluster
 
 Cluster contains information about a cluster in a cluster registry.
 
-<aside class="notice">
-Appears In:
 
-<ul> 
-<li><a href="#clusterlist-v1alpha1-clusterregistry">ClusterList clusterregistry/v1alpha1</a></li>
-</ul> </aside>
 
 Field        | Description
 ------------ | -----------
-apiVersion <br /> *string*    | 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
-kind <br /> *string*    | 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
-metadata <br /> *[ObjectMeta](#objectmeta-v1-meta)*    | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
-spec <br /> *[ClusterSpec](#clusterspec-v1alpha1-clusterregistry)*    | Spec is the specification of the cluster. This may or may not be reconciled by an active controller.
-status <br /> *[ClusterStatus](#clusterstatus-v1alpha1-clusterregistry)*    | Status is the status of the cluster.
+`apiVersion`<br /> *string*    | 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
+`kind`<br /> *string*    | 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+`metadata`<br /> *[ObjectMeta](#objectmeta-v1)*    | Standard object&#39;s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+`spec`<br /> *[ClusterSpec](#clusterspec-v1alpha1)*    | Spec is the specification of the cluster. This may or may not be reconciled by an active controller.
+`status`<br /> *[ClusterStatus](#clusterstatus-v1alpha1)*    | Status is the status of the cluster.
 
 
-### ClusterSpec v1alpha1 clusterregistry
+### ClusterSpec v1alpha1
 
 <aside class="notice">
 Appears In:
 
 <ul>
-<li><a href="#cluster-v1alpha1-clusterregistry">Cluster clusterregistry/v1alpha1</a></li>
+<li><a href="#cluster-v1alpha1">Cluster v1alpha1</a></li>
 </ul></aside>
 
 Field        | Description
 ------------ | -----------
-authInfo <br /> *[AuthInfo](#authinfo-v1alpha1-clusterregistry)*    | 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.
-kubernetesApiEndpoints <br /> *[KubernetesAPIEndpoints](#kubernetesapiendpoints-v1alpha1-clusterregistry)*    | KubernetesAPIEndpoints represents the endpoints of the API server for this cluster.
+`authInfo`<br /> *[AuthInfo](#authinfo-v1alpha1)*    | 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.
+`kubernetesApiEndpoints`<br /> *[KubernetesAPIEndpoints](#kubernetesapiendpoints-v1alpha1)*    | KubernetesAPIEndpoints represents the endpoints of the API server for this cluster.
 
-### ClusterStatus v1alpha1 clusterregistry
+### ClusterStatus v1alpha1
 
 <aside class="notice">
 Appears In:
 
 <ul>
-<li><a href="#cluster-v1alpha1-clusterregistry">Cluster clusterregistry/v1alpha1</a></li>
+<li><a href="#cluster-v1alpha1">Cluster v1alpha1</a></li>
 </ul></aside>
 
 Field        | Description
 ------------ | -----------
-
-### ClusterList v1alpha1 clusterregistry
-
-
-
-Field        | Description
------------- | -----------
-apiVersion <br /> *string*    | 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
-items <br /> *[Cluster](#cluster-v1alpha1-clusterregistry) array*    | 
-kind <br /> *string*    | 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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
-metadata <br /> *[ListMeta](#listmeta-v1-meta)*    | 
+`conditions`<br /> *[ClusterCondition](#clustercondition-v1alpha1) array*    | Conditions contains the different condition statuses for this cluster.