prep v0.3.1 release

Author: tinyzimmer

Makefile

@@ -129,6 +129,9 @@ build-kvdictl:
 	cd cmd/kvdictl && \
 		go build -ldflags=$(LDFLAGS) -o $(GOBIN)/kvdictl .
 
+kvdictl-docs:
+	go run hack/gen-kvdictl-docs.go
+
 GOX ?= $(GOBIN)/gox
 $(GOX):
 	GO111MODULE=off go get github.com/mitchellh/gox
@@ -423,4 +426,4 @@ check-release:
 		echo "You must specify a VERSION for release" ; exit 1 ; \
 	fi
 
-prep-release: check-release generate manifests helm-chart api-docs helm-docs package-chart package-index
+prep-release: check-release generate manifests helm-chart api-docs helm-docs kvdictl-docs package-chart package-index

README.md

@@ -15,9 +15,6 @@ _Except as I've continued to work on this, I've noticed this is really just a fr
 This project has reached a point where I am not going to be making enormous changes all the time anymore. As such I am tagging a "stable" release and incrementing from there. 
 That still doesn't mean I highly recommend it's usage, but rather I am relatively confident in its overall stability.
 
-This also means I won't be doing any major refactoring in the near future. So, if you were considering a pull request, I'm not as likely to be making all your work irrelevant.
-If I end up doing more refactoring, I'll work on branches and update documentation on `main` to reflect the work-in-progress. 
-
  - [API Reference](doc/appv1.md)
    - [RBAC Reference](doc/rbacv1.md)
    - [Templates Reference](doc/desktopsv1.md)
@@ -27,6 +24,7 @@ If I end up doing more refactoring, I'll work on branches and update documentati
       - [Helm](#helm)
       - [Bundle](#bundle-manifest)
       - [Kustomize](#kustomize)
+ - [CLI](#doc/kvdictl/kvdictl.md)
  - [Upgrading](#Upgrading)
  - [Building Desktop Images](build/desktops/README.md)
  - [Security](#security)
@@ -54,11 +52,10 @@ I wrote up a [`CONTRIBUTING`](CONTRIBUTING.md) doc just outlining some of the st
   - Use built-in local authentication, LDAP, or OpenID.
 
   - App metrics to either scrape externally or view in the UI. More details in the `helm` doc.
-
 ### TODO
 
   - "App Profiles" - I have a POC implementation on `main` but it is still pretty buggy
-  - DOSBox/Game profiles could be cool...
+  - DOSBox/Game profiles could be cool...same as "App Profiles"
   - UI could use a serious makeover from someone who actually knows what they are doing
 
 ## Requirements

config/manager/kustomization.yaml

@@ -13,4 +13,4 @@ kind: Kustomization
 images:
 - name: controller
   newName: ghcr.io/tinyzimmer/kvdi
-  newTag: manager-v0.3.0
+  newTag: manager-v0.3.1

deploy/bundle.yaml

@@ -475,7 +475,7 @@ spec:
                 description: Arbitrary tags for displaying in the app UI.
                 type: object
               volumes:
-                description: Additional volumes to attach to pods booted from this template. To mount them there must be cooresponding `volumeMounts` or `volumeDevices` specified.
+                description: Additional volumes to attach to pods booted from this template. To mount them there must be corresponding `volumeMounts` or `volumeDevices` specified.
                 items:
                   description: Volume represents a named volume in a pod that may be accessed by any container in the pod.
                   properties:
@@ -1378,14 +1378,9 @@ spec:
                   type: object
                 type: array
             type: object
-          status:
-            description: TemplateStatus defines the observed state of Template
-            type: object
         type: object
     served: true
     storage: true
-    subresources:
-      status: {}
 status:
   acceptedNames:
     kind: ""
@@ -1735,8 +1730,18 @@ spec:
                         type: string
                     type: object
                 type: object
+              userdataSelector:
+                description: A configuration for selecting pre-existing PVCs to use as the $HOME directory for sessions. This configuration takes precedence over `userdataSpec`.
+                properties:
+                  matchLabel:
+                    description: MatchLabel is a label **key** to use to select a PVC for the user. The value will in the selector will be the name of the user launching the session. Use this if your usernames may not always be DNS compliant.
+                    type: string
+                  matchName:
+                    description: MatchName is a pattern to match for the name of the PVC. The string ${USERNAME} will be replaced in the pattern with the actual username when searching for the volume. Note, this will only work if usernames are DNS compliant.
+                    type: string
+                type: object
               userdataSpec:
-                description: The configuration for user volumes. **NOTE:** Even though the controller will try to force the reclaim policy on created volumes to `Retain`, you may want to set it explicitly on your storage-class controller as an extra safeguard.
+                description: "The configuration for user $HOME volumes to be managed by kVDI. \n **NOTE:** Even though the controller will try to force the reclaim policy on created volumes to `Retain`, you may want to set it explicitly on your storage-class controller as an extra safeguard."
                 properties:
                   accessModes:
                     description: 'AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
@@ -2404,7 +2409,7 @@ spec:
                 description: Arbitrary tags for displaying in the app UI.
                 type: object
               volumes:
-                description: Additional volumes to attach to pods booted from this template. To mount them there must be cooresponding `volumeMounts` or `volumeDevices` specified.
+                description: Additional volumes to attach to pods booted from this template. To mount them there must be corresponding `volumeMounts` or `volumeDevices` specified.
                 items:
                   description: Volume represents a named volume in a pod that may be accessed by any container in the pod.
                   properties:
@@ -3307,14 +3312,9 @@ spec:
                   type: object
                 type: array
             type: object
-          status:
-            description: TemplateStatus defines the observed state of Template
-            type: object
         type: object
     served: true
     storage: true
-    subresources:
-      status: {}
 status:
   acceptedNames:
     kind: ""
@@ -3664,8 +3664,18 @@ spec:
                         type: string
                     type: object
                 type: object
+              userdataSelector:
+                description: A configuration for selecting pre-existing PVCs to use as the $HOME directory for sessions. This configuration takes precedence over `userdataSpec`.
+                properties:
+                  matchLabel:
+                    description: MatchLabel is a label **key** to use to select a PVC for the user. The value will in the selector will be the name of the user launching the session. Use this if your usernames may not always be DNS compliant.
+                    type: string
+                  matchName:
+                    description: MatchName is a pattern to match for the name of the PVC. The string ${USERNAME} will be replaced in the pattern with the actual username when searching for the volume. Note, this will only work if usernames are DNS compliant.
+                    type: string
+                type: object
               userdataSpec:
-                description: The configuration for user volumes. **NOTE:** Even though the controller will try to force the reclaim policy on created volumes to `Retain`, you may want to set it explicitly on your storage-class controller as an extra safeguard.
+                description: "The configuration for user $HOME volumes to be managed by kVDI. \n **NOTE:** Even though the controller will try to force the reclaim policy on created volumes to `Retain`, you may want to set it explicitly on your storage-class controller as an extra safeguard."
                 properties:
                   accessModes:
                     description: 'AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
@@ -4180,7 +4190,7 @@ spec:
         - --leader-elect
         command:
         - /manager
-        image: ghcr.io/tinyzimmer/kvdi:manager-v0.3.0
+        image: ghcr.io/tinyzimmer/kvdi:manager-v0.3.1
         livenessProbe:
           httpGet:
             path: /healthz

deploy/charts/index.yaml

@@ -1,9 +1,19 @@
 apiVersion: v1
 entries:
   kvdi:
+  - apiVersion: v2
+    appVersion: v0.3.1
+    created: "2021-02-27T18:00:39.7319758+02:00"
+    description: A Kubernetes-Native Virtual Desktop Infrastructure
+    digest: 118ce0338cc036de90c81a01572a91f622093b131321c3f75e92b24d8aeed164
+    name: kvdi
+    type: application
+    urls:
+    - kvdi-v0.3.1.tgz
+    version: v0.3.1
   - apiVersion: v2
     appVersion: v0.3.0
-    created: "2021-02-26T12:00:07.5225496+02:00"
+    created: "2021-02-27T18:00:39.730376+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: 4b0620db91f21777ab9389574e95aa4a3ab812be7382727ddd94c7e81a3e7de7
     name: kvdi
@@ -13,7 +23,7 @@ entries:
     version: v0.3.0
   - apiVersion: v2
     appVersion: v0.2.2
-    created: "2021-02-26T12:00:07.5211082+02:00"
+    created: "2021-02-27T18:00:39.7274889+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: 426e46b70297154030266abf2d832838c0d00c58a0b3390e78281400cea961fa
     name: kvdi
@@ -23,7 +33,7 @@ entries:
     version: v0.2.2
   - apiVersion: v2
     appVersion: v0.2.1
-    created: "2021-02-26T12:00:07.5189186+02:00"
+    created: "2021-02-27T18:00:39.725236+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: 29af60d73698d30af6253b7d8317904a66f4de6378a16ac287d3c5905035be65
     name: kvdi
@@ -33,7 +43,7 @@ entries:
     version: v0.2.1
   - apiVersion: v2
     appVersion: v0.2.0
-    created: "2021-02-26T12:00:07.5165255+02:00"
+    created: "2021-02-27T18:00:39.7237753+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: f50123e34bc62e2954da3ff2ae747f7d82c250cef5c53cf25d9dd163b542ef77
     name: kvdi
@@ -43,7 +53,7 @@ entries:
     version: v0.2.0
   - apiVersion: v2
     appVersion: v0.1.4
-    created: "2021-02-26T12:00:07.5151287+02:00"
+    created: "2021-02-27T18:00:39.7223624+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: 4dd6ffd2bb17689d042782056e7f90bb8bb1ad403a9dc4a9de340329f4d70322
     name: kvdi
@@ -53,7 +63,7 @@ entries:
     version: v0.1.4
   - apiVersion: v2
     appVersion: v0.1.3
-    created: "2021-02-26T12:00:07.5134941+02:00"
+    created: "2021-02-27T18:00:39.7201961+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: f2b9302e26762c49ed0ad53835b2c190e6c7d0722c8497f46f1c2080fd5b0576
     name: kvdi
@@ -63,7 +73,7 @@ entries:
     version: v0.1.3
   - apiVersion: v2
     appVersion: v0.1.2
-    created: "2021-02-26T12:00:07.5126139+02:00"
+    created: "2021-02-27T18:00:39.7192527+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: 369e83caa627379ba04bf79471da18e0ebca85ec527fc13729eb7bb733f502ef
     name: kvdi
@@ -73,7 +83,7 @@ entries:
     version: v0.1.2
   - apiVersion: v2
     appVersion: v0.1.1
-    created: "2021-02-26T12:00:07.5117496+02:00"
+    created: "2021-02-27T18:00:39.7182964+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: 13667a42c4be002e2980ca0625bb4a7399b171ee73a1f0fe1a3c4de7bdc377ba
     name: kvdi
@@ -83,12 +93,12 @@ entries:
     version: v0.1.1
   - apiVersion: v2
     appVersion: v0.1.0
-    created: "2021-02-26T12:00:07.5096974+02:00"
+    created: "2021-02-27T18:00:39.7172789+02:00"
     description: A Kubernetes-Native Virtual Desktop Infrastructure
     digest: 75b553c4fea1303767743944a8e470f6d56784b85f8a0698edc5e786fc3c05ac
     name: kvdi
     type: application
     urls:
     - kvdi-v0.1.0.tgz
     version: v0.1.0
-generated: "2021-02-26T12:00:07.5084579+02:00"
+generated: "2021-02-27T18:00:39.714637+02:00"

deploy/charts/kvdi-v0.3.1.tgz

@@ -488,11 +488,30 @@ spec:
                         type: string
                     type: object
                 type: object
+              userdataSelector:
+                description: A configuration for selecting pre-existing PVCs to use
+                  as the $HOME directory for sessions. This configuration takes precedence
+                  over `userdataSpec`.
+                properties:
+                  matchLabel:
+                    description: MatchLabel is a label **key** to use to select a
+                      PVC for the user. The value will in the selector will be the
+                      name of the user launching the session. Use this if your usernames
+                      may not always be DNS compliant.
+                    type: string
+                  matchName:
+                    description: MatchName is a pattern to match for the name of the
+                      PVC. The string ${USERNAME} will be replaced in the pattern
+                      with the actual username when searching for the volume. Note,
+                      this will only work if usernames are DNS compliant.
+                    type: string
+                type: object
               userdataSpec:
-                description: The configuration for user volumes. **NOTE:** Even though
-                  the controller will try to force the reclaim policy on created volumes
-                  to `Retain`, you may want to set it explicitly on your storage-class
-                  controller as an extra safeguard.
+                description: "The configuration for user $HOME volumes to be managed
+                  by kVDI. \n **NOTE:** Even though the controller will try to force
+                  the reclaim policy on created volumes to `Retain`, you may want
+                  to set it explicitly on your storage-class controller as an extra
+                  safeguard."
                 properties:
                   accessModes:
                     description: 'AccessModes contains the desired access modes the

deploy/charts/kvdi/crds/app.kvdi.io_vdiclusters.yaml

@@ -542,7 +542,7 @@ spec:
                 type: object
               volumes:
                 description: Additional volumes to attach to pods booted from this
-                  template. To mount them there must be cooresponding `volumeMounts`
+                  template. To mount them there must be corresponding `volumeMounts`
                   or `volumeDevices` specified.
                 items:
                   description: Volume represents a named volume in a pod that may
@@ -1974,14 +1974,9 @@ spec:
                   type: object
                 type: array
             type: object
-          status:
-            description: TemplateStatus defines the observed state of Template
-            type: object
         type: object
     served: true
     storage: true
-    subresources:
-      status: {}
 status:
   acceptedNames:
     kind: ""