Merge pull request #100 from BlaineEXE/fix-kustomize-install

Update kustomize deployment and readme

Author: k8s-ci-robot

README.md

@@ -1,49 +1,32 @@
 ![version](https://img.shields.io/badge/status-pre--alpha-lightgrey) ![apiVersion](https://img.shields.io/badge/apiVersion-v1alpha1-lightgreen)
 
 
-# Container Object Storage Interface API
+# Container Object Storage Interface
 
-This repository hosts the API defintion of the Custom Resource Definitions (CRD) used for the Container Object Storage Interface (COSI) project. The provisioned unit of storage is a `Bucket`. The following CRDs are defined for managing the lifecycle of Buckets:
+This repository hosts the Container Object Storage Interface (COSI) project.
 
- - BucketClaim - Represents a request to provision a Bucket
- - BucketClass - Represents a class of Buckets with similar characteristics
- - Bucket - Represents a Bucket or its equivalent in the storage backend
+## Documentation
 
- The following CRDs are defined for managing the lifecycle of workloads accessing the Bucket:
+To deploy, run `kubectl apply -k .`
 
- - BucketAccessClass - Represents a class of accessors with similar access requirements
- - BucketAccess - Represents a access token or service account in the storage backend
-
-**NOTE**: All of the APIs are defined under the API group `objectstorage.k8s.io`.
-
-For more information about COSI, visit our [documentation](https://container-object-storage-interface.github.io/docs).
 ## Developer Guide
 
-All API definitions are in [`apis/objectstorage.k8s.io/`](./apis/objectstorage/). All API changes **_MUST_** satisfy the following requirements:
+All API definitions are in [`client/apis/objectstorage`](./client/apis/objectstorage/). All API changes **_MUST_** satisfy the following requirements:
 
- - Must be backwards compatible
- - Must be in-sync with the API definitions in [sigs.k8s.io/container-object-storage-interface-spec](https://sigs.k8s.io/container-object-storage-interface-spec)
+- Must be backwards compatible
+- Must be in-sync with the API definitions in [sigs.k8s.io/container-object-storage-interface-spec](https://sigs.k8s.io/container-object-storage-interface-spec)
 
 ### Build and Test
 
-1. Test and Build the project
-
-```
-make all
-```
-
-2. Generate CRDs
-
-```
-make codegen
-```
+See `make help` for assistance
 
 ## Adding new fields to protocols
 
-1. Create a new issue raising a RFC for the changes following this format:
+Create a new issue raising a RFC for the changes following this format:
+
+**Title:** [RFC] Changes to protocol xyz
 
-Title: [RFC] Changes to protocol xyz
-> **Info**:
+**Description:**
 > 1. Protocol:
 > 2. Fields Added:
 > 3. Why is this change neccessary?
@@ -54,10 +37,8 @@ Title: [RFC] Changes to protocol xyz
 
 ## References
 
- - [Documentation](https://container-object-storage-interface.github.io/)
- - [Deployment Guide](https://container-object-storage-interface.github.io/docs/deployment-guide)
- - [Weekly Meetings](https://container-object-storage-interface.github.io/docs/community/weekly-meetings)
- - [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/8)
+ - Weekly Meetings: Thursdays from 13:30 to 14:00 US Eastern Time
+ - [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/63/)
 
 ## Community, discussion, contribution, and support
 

controller/kustomization.yaml

@@ -2,11 +2,13 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 
-commonLabels:
-  app.kubernetes.io/part-of: container-object-storage-interface
-  app.kubernetes.io/component: controller
-  app.kubernetes.io/version: main
-  app.kubernetes.io/name: container-object-storage-interface-controller
+labels:
+  - includeTemplates: true
+    pairs:
+      app.kubernetes.io/component: controller
+      app.kubernetes.io/name: container-object-storage-interface-controller
+      app.kubernetes.io/part-of: container-object-storage-interface
+      app.kubernetes.io/managed-by: kustomize
 
 resources:
 - resources/sa.yaml

controller/resources/deployment.yaml

@@ -4,10 +4,7 @@ apiVersion: apps/v1
 metadata:
   name: objectstorage-controller
   labels:
-    app.kubernetes.io/part-of: container-object-storage-interface
-    app.kubernetes.io/component: controller
-    app.kubernetes.io/version: main
-    app.kubernetes.io/name: container-object-storage-interface-controller
+    app: container-object-storage-interface-controller
 spec:
   replicas: 1
   strategy:
@@ -16,22 +13,15 @@ spec:
       maxSurge: 1
   selector:
     matchLabels:
-      app.kubernetes.io/part-of: container-object-storage-interface
-      app.kubernetes.io/component: controller
-      app.kubernetes.io/version: main
-      app.kubernetes.io/name: container-object-storage-interface-controller
+      app: container-object-storage-interface-controller
   template:
     metadata:
       labels:
-        app.kubernetes.io/part-of: container-object-storage-interface
-        app.kubernetes.io/component: controller
-        app.kubernetes.io/version: main
-        app.kubernetes.io/name: container-object-storage-interface-controller
+        app: container-object-storage-interface-controller
     spec:
       serviceAccountName: objectstorage-controller-sa
       containers:
         - name: objectstorage-controller
           image: gcr.io/k8s-staging-sig-storage/objectstorage-controller:v20221027-v0.1.1-8-g300019f
-          imagePullPolicy: Always
           args:
-          - "--v=5"
+            - "--v=5"

controller/resources/rbac.yaml

@@ -4,28 +4,22 @@ apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: objectstorage-controller-role
   namespace: default
-  labels:
-    app.kubernetes.io/part-of: container-object-storage-interface
-    app.kubernetes.io/component: controller
-    app.kubernetes.io/version: main
-    app.kubernetes.io/name: container-object-storage-interface-controller
 rules:
-- apiGroups: ["objectstorage.k8s.io"]
-  resources: ["bucketclaims", "bucketaccesses", "bucketclaims/status", "bucketaccesses/status"]
-  verbs: ["get", "list", "watch", "update"]
-- apiGroups: ["objectstorage.k8s.io"]
-  resources: ["buckets"]
-  verbs: ["get", "list", "watch", "update", "create", "delete"]
-- apiGroups: ["objectstorage.k8s.io"]
-  resources: ["bucketclasses","bucketaccessclasses"]
-  verbs: ["get", "list"]
-- apiGroups: [""]
-  resources: ["events"]
-  verbs: ["list", "watch", "create", "update", "patch"]
-- apiGroups: [""]
-  resources: ["configmaps", "serviceaccounts"]
-  verbs: ["list", "get"]
-
+  - apiGroups: ["objectstorage.k8s.io"]
+    resources: ["bucketclaims", "bucketaccesses", "bucketclaims/status", "bucketaccesses/status"]
+    verbs: ["get", "list", "watch", "update"]
+  - apiGroups: ["objectstorage.k8s.io"]
+    resources: ["buckets"]
+    verbs: ["get", "list", "watch", "update", "create", "delete"]
+  - apiGroups: ["objectstorage.k8s.io"]
+    resources: ["bucketclasses","bucketaccessclasses"]
+    verbs: ["get", "list"]
+  - apiGroups: [""]
+    resources: ["events"]
+    verbs: ["list", "watch", "create", "update", "patch"]
+  - apiGroups: [""]
+    resources: ["configmaps", "serviceaccounts"]
+    verbs: ["list", "get"]
 ---
 kind: ClusterRoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
@@ -57,9 +51,9 @@ metadata:
     app.kubernetes.io/version: main
     app.kubernetes.io/name: container-object-storage-interface-controller
 rules:
-- apiGroups: ["coordination.k8s.io"]
-  resources: ["leases"]
-  verbs: ["get", "watch", "list", "delete", "update", "create"]
+  - apiGroups: ["coordination.k8s.io"]
+    resources: ["leases"]
+    verbs: ["get", "watch", "list", "delete", "update", "create"]
 ---
 kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1

controller/resources/sa.yaml

@@ -3,8 +3,3 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: objectstorage-controller-sa
-  labels:
-    app.kubernetes.io/part-of: container-object-storage-interface
-    app.kubernetes.io/component: controller
-    app.kubernetes.io/version: main
-    app.kubernetes.io/name: container-object-storage-interface-controller

kustomization.yaml

@@ -3,16 +3,15 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 
 commonAnnotations:
-  cosi.storage.k8s.io/authors: "Kubernetes Authors"
-  cosi.storage.k8s.io/license: "Apache V2"
-  cosi.storage.k8s.io/support: "https://github.com/kubernetes-sigs/container-object-storage-api"
-  controller-gen.kubebuilder.io/version: (devel)
+  objectstorage.k8s.io/authors: "Kubernetes Authors"
+  objectstorage.k8s.io/license: "Apache V2"
+  objectstorage.k8s.io/support: "https://github.com/kubernetes-sigs/container-object-storage-api"
   api-approved.kubernetes.io: https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1979-object-storage-support
 
-
 resources:
-- crds/objectstorage.k8s.io_bucketaccesses.yaml
-- crds/objectstorage.k8s.io_bucketaccessclasses.yaml
-- crds/objectstorage.k8s.io_bucketclasses.yaml
-- crds/objectstorage.k8s.io_bucketclaims.yaml
-- crds/objectstorage.k8s.io_buckets.yaml
+- client/config/crd/objectstorage.k8s.io_bucketaccesses.yaml
+- client/config/crd/objectstorage.k8s.io_bucketaccessclasses.yaml
+- client/config/crd/objectstorage.k8s.io_bucketclasses.yaml
+- client/config/crd/objectstorage.k8s.io_bucketclaims.yaml
+- client/config/crd/objectstorage.k8s.io_buckets.yaml
+- controller