Skip to content

Commit 00f33f4

Browse files
committed
Update docs and bundle for v0.3.6 release
1 parent c911719 commit 00f33f4

40 files changed

+157
-59
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,4 +407,4 @@ check-release:
407407
echo "You must specify a VERSION for release" ; exit 1 ; \
408408
fi
409409

410-
prep-release: check-release generate manifests api-docs kvdictl-docs
410+
prep-release: check-release generate manifests api-docs kvdictl-docs bundle

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ _Except as I've continued to work on this, I've noticed this is really just a fr
88

99
---
1010

11-
**ATTENTION:** The `helm` chart repository has been relocated (since the repo has been relocated). To update your repository you can do the following:
11+
**ATTENTION:** The `helm` chart repository has been moved to a [separate repo](https://github.com/kvdi/helm-charts) to tidy things up here more. To update your repository you can do the following:
1212

1313
```sh
14-
helm repo remove tinyzimmer
15-
helm repo add kvdi https://kvdi.github.io/kvdi/deploy/charts
14+
helm repo remove kvdi
15+
helm repo add kvdi https://kvdi.github.io/helm-charts/charts
1616
helm repo update
1717

1818
helm install kvdi kvdi/kvdi # yes, that's a lot of kvdi
@@ -67,6 +67,7 @@ I wrote up a [`CONTRIBUTING`](CONTRIBUTING.md) doc just outlining some of the st
6767

6868
- "App Profiles" - I have a POC implementation on `main` but it is still pretty buggy
6969
- DOSBox/Game profiles could be cool...same as "App Profiles"
70+
- ARM64 support. Should be easy, but the build files will need some shuffling.
7071
- UI could use a serious makeover from someone who actually knows what they are doing
7172

7273
## Requirements
@@ -103,7 +104,7 @@ For more complete installation instructions see the `helm` chart docs [here](dep
103104
The [API Reference](doc/appv1.md) can also be used for details on `kVDI` app-level configurations.
104105

105106
```bash
106-
helm repo add kvdi https://kvdi.github.io/kvdi/deploy/charts # Add the kvdi repo
107+
helm repo add kvdi https://kvdi.github.io/helm-charts/charts # Add the kvdi charts repo
107108
helm repo update # Sync your repositories
108109

109110
# Install kVDI
@@ -126,7 +127,7 @@ You can then create a [VDICluster](doc/appv1.md#VDIClusterSpec) object manually
126127
To install the manifest:
127128

128129
```bash
129-
export KVDI_VERSION=v0.3.1
130+
export KVDI_VERSION=v0.3.6
130131

131132
kubectl apply -f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/deploy/bundle.yaml --validate=false
132133
```
@@ -141,7 +142,7 @@ They can be found in the [config](config/) directory in this repository.
141142
Most of the time you can just run a regular helm upgrade to update your deployment manifests to the latest images.
142143

143144
```bash
144-
helm upgrade kvdi kvdi/kvdi --version v0.3.2
145+
helm upgrade kvdi kvdi/kvdi --version v0.3.6
145146
```
146147

147148
However, sometimes there may be changes to the CRDs, though I will always do my best to make sure they are backwards compatible.
@@ -151,20 +152,20 @@ You can get around this by applying the CRDs for the version you are upgrading t
151152
For example:
152153

153154
```bash
154-
export KVDI_VERSION=v0.3.2
155+
export KVDI_VERSION=v0.3.6
155156

156157
kubectl apply \
157-
-f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/deploy/charts/kvdi/crds/app.kvdi.io_vdiclusters.yaml \
158-
-f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/deploy/charts/kvdi/crds/desktops.kvdi.io_sessions.yaml \
159-
-f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/deploy/charts/kvdi/crds/desktops.kvdi.io_templates.yaml \
160-
-f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/deploy/charts/kvdi/crds/rbac.kvdi.io_vdiroles.yaml
158+
-f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/config/crd/bases/app.kvdi.io_vdiclusters.yaml \
159+
-f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/config/crd/bases/desktops.kvdi.io_sessions.yaml \
160+
-f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/config/crd/bases/crds/desktops.kvdi.io_templates.yaml \
161+
-f https://raw.githubusercontent.com/kvdi/kvdi/${KVDI_VERSION}/config/crd/bases/crds/rbac.kvdi.io_vdiroles.yaml
161162
```
162163

163164
When there is a change to one or more CRDs, it will be mentioned in the notes for that release.
164165

165166
## Building and Running Locally
166167

167-
The `Makefiles` contain helpers for testing the full solution locally using `kind`. Run `make help` to see all the available options.
168+
The `Makefile` contains helpers for testing the full solution locally using `k3d`. Run `make help` to see all the available options.
168169

169170
_If you choose to pull the images from the registry instead of building and loading first - you probably want to set `VERSION=latest` (or a previous version) in your environment also.
170171
The `Makefile` is usually pointed at the next version to be released and published images may not exist yet_.

deploy/bundle.yaml

Lines changed: 77 additions & 7 deletions
Large diffs are not rendered by default.

doc/appv1.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Types
2020
- [ServiceMonitorConfig](#ServiceMonitorConfig)
2121
- [TLSConfig](#TLSConfig)
2222
- [UserdataSelector](#UserdataSelector)
23+
- [UserdataSpec](#UserdataSpec)
2324
- [VDICluster](#VDICluster)
2425
- [VDIClusterSpec](#VDIClusterSpec)
2526
- [VaultConfig](#VaultConfig)
@@ -501,6 +502,32 @@ yourself.
501502
</tbody>
502503
</table>
503504

505+
### UserdataSpec
506+
507+
(*Appears on:* [VDIClusterSpec](#VDIClusterSpec))
508+
509+
UserdataSpec is an inline of the corev1 PersistentVolumeClaimSpec. It
510+
contains additional fields for controlling how kvdi works with volumes.
511+
512+
<table>
513+
<thead>
514+
<tr class="header">
515+
<th>Field</th>
516+
<th>Description</th>
517+
</tr>
518+
</thead>
519+
<tbody>
520+
<tr class="odd">
521+
<td><code>PersistentVolumeClaimSpec</code> <em><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#persistentvolumeclaimspec-v1-core">Kubernetes core/v1.PersistentVolumeClaimSpec</a></em></td>
522+
<td><p>(Members of <code>PersistentVolumeClaimSpec</code> are embedded into this type.)</p></td>
523+
</tr>
524+
<tr class="even">
525+
<td><code>retainPVCs</code> <em>bool</em></td>
526+
<td><p>RetainPVCs tells the desktop controller to leave PVCs in-tact after they are allocated for a user. The default behavior is to free the volume from the PVC after each desktop session so it can be used across other namespaces. Note that if you set this value to <code>true</code> users will only be able to launch sessions in a single namespace (unless the PVC is manually removed).</p></td>
527+
</tr>
528+
</tbody>
529+
</table>
530+
504531
### VDICluster
505532

506533
VDICluster is the Schema for the vdiclusters API
@@ -541,7 +568,7 @@ VDICluster is the Schema for the vdiclusters API
541568
<td><p>Pull secrets to use when pulling container images</p></td>
542569
</tr>
543570
<tr class="odd">
544-
<td><code>userdataSpec</code> <em><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#persistentvolumeclaimspec-v1-core">Kubernetes core/v1.PersistentVolumeClaimSpec</a></em></td>
571+
<td><code>userdataSpec</code> <em><a href="#UserdataSpec">UserdataSpec</a></em></td>
545572
<td><p>The configuration for user $HOME volumes to be managed by kVDI.</p>
546573
<p><strong>NOTE:</strong> Even though the controller will try to force the reclaim policy on created volumes to <code>Retain</code>, you may want to set it explicitly on your storage-class controller as an extra safeguard.</p></td>
547574
</tr>
@@ -606,7 +633,7 @@ VDIClusterSpec defines the desired state of VDICluster
606633
<td><p>Pull secrets to use when pulling container images</p></td>
607634
</tr>
608635
<tr class="odd">
609-
<td><code>userdataSpec</code> <em><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#persistentvolumeclaimspec-v1-core">Kubernetes core/v1.PersistentVolumeClaimSpec</a></em></td>
636+
<td><code>userdataSpec</code> <em><a href="#UserdataSpec">UserdataSpec</a></em></td>
610637
<td><p>The configuration for user $HOME volumes to be managed by kVDI.</p>
611638
<p><strong>NOTE:</strong> Even though the controller will try to force the reclaim policy on created volumes to <code>Retain</code>, you may want to set it explicitly on your storage-class controller as an extra safeguard.</p></td>
612639
</tr>
@@ -681,4 +708,4 @@ server.
681708

682709
------------------------------------------------------------------------
683710

684-
*Generated with `gen-crd-api-reference-docs` on git commit `c4e330a`.*
711+
*Generated with `gen-crd-api-reference-docs` on git commit `c911719`.*

doc/desktopsv1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,4 +430,4 @@ TemplateSpec defines the desired state of Template
430430

431431
------------------------------------------------------------------------
432432

433-
*Generated with `gen-crd-api-reference-docs` on git commit `c4e330a`.*
433+
*Generated with `gen-crd-api-reference-docs` on git commit `c911719`.*

doc/kvdictl/kvdictl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ Complete documentation for kvdi is available at https://github.com/kvdi/kvdi
6464
* [kvdictl users](kvdictl_users.md) - Users commands
6565
* [kvdictl version](kvdictl_version.md) - Retrieve kVDI version information
6666

67-
###### Auto generated by spf13/cobra on 14-Aug-2021
67+
###### Auto generated by spf13/cobra on 24-Oct-2021

doc/kvdictl/kvdictl_completion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ kvdictl completion [bash|zsh|fish|powershell]
6161

6262
* [kvdictl](kvdictl.md) -
6363

64-
###### Auto generated by spf13/cobra on 14-Aug-2021
64+
###### Auto generated by spf13/cobra on 24-Oct-2021

doc/kvdictl/kvdictl_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Configuration commands
2626
* [kvdictl config client](kvdictl_config_client.md) - Client configuration commands
2727
* [kvdictl config server](kvdictl_config_server.md) - Retrieve server configurations
2828

29-
###### Auto generated by spf13/cobra on 14-Aug-2021
29+
###### Auto generated by spf13/cobra on 24-Oct-2021

doc/kvdictl/kvdictl_config_client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Client configuration commands
2626
* [kvdictl config client get](kvdictl_config_client_get.md) - Retrieve client configurations
2727
* [kvdictl config client set](kvdictl_config_client_set.md) - Set client configurations
2828

29-
###### Auto generated by spf13/cobra on 14-Aug-2021
29+
###### Auto generated by spf13/cobra on 24-Oct-2021

doc/kvdictl/kvdictl_config_client_get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ kvdictl config client get <PATH> [flags]
2828

2929
* [kvdictl config client](kvdictl_config_client.md) - Client configuration commands
3030

31-
###### Auto generated by spf13/cobra on 14-Aug-2021
31+
###### Auto generated by spf13/cobra on 24-Oct-2021

0 commit comments

Comments
 (0)