Releases: loft-sh/vcluster
v0.21.0-alpha.9
What's Changed
- fix: handle trailing slash in mount paths for hostpath mapper by @neogopher in #2169
- Improve vcluster platform reset error message by @FabianKramm in #2172
- test: Add tests for volumes and volumeMounts translation with hostpathmapper enabled by @neogopher in #2176
- fix: pv syncing by @FabianKramm in #2178
Full Changelog: v0.21.0-alpha.8...v0.21.0-alpha.9
v0.21.0-alpha.8
What's Changed
- Fix: reset password namespace & start chart name by @FabianKramm in #2132
- fix(cli): do not upgrade if latest stable is older(eg: beta) by @rohantmp in #2131
- fix: wrong namespace for vcluster by @FabianKramm in #2137
- [trivial] fix(cli): reword logs for clarity by @rohantmp in #2140
- fixed reference to old product name in cli by @facchettos in #2139
- fix(cli): improve UX around vcluster upgrade command by @rohantmp in #2136
- fix: init manifests fail if chart artifact name differs from chart name by @rohantmp in #2133
- add --all flag to vcluster platform add vcluster by @hidalgopl in #2113
- Consolidate create/switch/update context with --connect by @johannesfrey in #2112
- feat: coredns pod supports affinity and stain tolerance by @mayooot in #2107
- fixed an issue for generic sync that deleted referenced objects by @facchettos in #2150
- added clusterrole rule for eso and webhook by @facchettos in #2151
- Captures helm error before trying to call WaitForReadyLoftPod by @zerbitx in #2148
- add --ca-data flag to vcluster platform add cluster command to allow … by @hidalgopl in #2153
- Only uninstall if reset flag is true by @rmweir in #2154
- Changes fallback ns to vcluster-platform by @zerbitx in #2147
- fix(pro): Force StatefulSet for embedded etcd by @ThomasK33 in #2158
- revert adding --ca-data flag to vcluster platform add cluster by @hidalgopl in #2163
- fix: update platform add command to reference the platform instead of loft by @deniseschannon in #2155
New Contributors
Full Changelog: v0.21.0-alpha.7...v0.21.0-alpha.8
v0.20.1-beta.1
Full Changelog: v0.20.1-beta.0...v0.20.1-beta.1
v0.20.1-beta.0
What's Changed
- [v0.20] feat: Ignore updates to Rancher managed annotations (#2075) by @neogopher in #2076
- [BACKPORT V0.20] fix: add ingress host automatically to certificate by @FabianKramm in #2090
- [v0.20] Merge pull request #2110 from rohantmp/fixExternalDelete by @loft-bot in #2123
- [v0.20] Merge pull request #2126 from facchettos/fix-generic-sync by @loft-bot in #2127
- [v0.20] Merge pull request #2122 from rohantmp/fixBrowerLog by @loft-bot in #2128
- [v0.20] Merge pull request #2132 from FabianKramm/main by @loft-bot in #2134
- [BACKPORT v0.20] fix: wrong namespace for vcluster by @FabianKramm in #2138
- [v0.20] Merge pull request #2139 from facchettos/fix-generic-sync by @loft-bot in #2144
- [v0.20] Merge pull request #2140 from rohantmp/fixDelete by @loft-bot in #2143
- [v0.20] Merge pull request #2133 from rohantmp/fixHelm-4457 by @loft-bot in #2145
- [0.20] fix: create --connect fails because of improper config location, remove duplicate flags, drop duplicate functionality by @rohantmp in #2149
- [v0.20] fix(cli): do not upgrade if latest stable is older(eg: beta) by @deniseschannon in #2156
- [v0.20] Merge pull request #2154 from rmweir/only-uninstall-reset by @loft-bot in #2157
- [BACKPORT v0.20] Changes fallback ns to vcluster-platform by @FabianKramm in #2160
- [Backport-to-v0.20 set additional ca in platform add cluster by @hidalgopl in https://github.com//pull/2159
- [v0.20] Merge pull request #2148 from zerbitx/ENG-4585 by @loft-bot in #2162
- [v0.20] revert adding --ca-data flag to vcluster platform add cluster by @hidalgopl in #2161
- [v0.20] Merge pull request #2155 from deniseschannon/loft-ref by @loft-bot in #2166
Full Changelog: v0.20.0...v0.20.1-beta.0
v0.21.0-alpha.7
What's Changed
- sync values.schema.json only on the latest release by @hidalgopl in #2103
- added config for external secret integration by @facchettos in #2106
- Connect to vCluster Platform earlier by @rmweir in #2029
- build(deps): bump micromatch from 4.0.2 to 4.0.8 in /docs by @dependabot in #2099
- build(deps): bump anchore/sbom-action from 0.17.0 to 0.17.2 by @dependabot in #2101
- updated rbac template for eso integration by @facchettos in #2109
- Check if vcluster chart version supports k8s version by @rmweir in #2114
- fallback to checking if config is in correct format by @hidalgopl in #2111
- added options to sync the secret stores in eso integration by @facchettos in #2117
- Update kine by @rmweir in #2119
- add cluster secret store sync to helm chart for eso by @facchettos in #2118
- dynamically add config.Config.PlatformConfig to the generated schema by @hidalgopl in #2116
- fix: use proper config location by @rohantmp in #2115
- fix: external delete should check status field for service uid by @rohantmp in #2110
- [fix] : now prevents the generic syncer from continuously deleting objs by @facchettos in #2126
- fix: improve error logging around attempting to open browser by @rohantmp in #2122
- refactor: update instead of patch & more tests by @FabianKramm in #2129
- refactor: make sure mappings are always correct by @FabianKramm in #2130
Full Changelog: v0.21.0-alpha.6...v0.21.0-alpha.7
v0.21.0-alpha.6
What's Changed
- Test improvement & kindPath & apiVersionPath by @FabianKramm in #2087
- fix: add ingress host automatically to certificate by @FabianKramm in #2089
- fix: map default/kubernetes correctly by @FabianKramm in #2091
- refactor: allow empty path by @FabianKramm in #2093
Full Changelog: v0.21.0-alpha.5...v0.21.0-alpha.6
v0.21.0-alpha.5
What's Changed
- [enhancement] added hidden flag to override number of virtual cluster restriction by @facchettos in #2064
- refactor: remove auto syncing of node syncing for kind by @FabianKramm in #2066
- [feature] add describe command by @facchettos in #2055
- Add workflow to trigger doc PR in vcluster-docs by @zerbitx in #2070
- feat: Ignore updates to Rancher managed annotations by @neogopher in #2075
- fix: store watches & delete references by @FabianKramm in #2071
- refactor: importer adjustments by @FabianKramm in #2078
- test: add test rest mapper for unit testing by @FabianKramm in #2080
- feat: add dnsPolicy, dnsConfig config options for the controlPlane by @matskiv in #2082
- refactor: migrate from host by @FabianKramm in #2081
- refactor: add host name & namespace as annotations by @FabianKramm in #2083
- feat: add labels patch by @FabianKramm in #2084
Full Changelog: v0.21.0-alpha.4...v0.21.0-alpha.5
v0.19.8-beta.0
What's Changed
- Update README for EKS Helm Chart by @deniseschannon in #1976
- [Backport 0.19] Remove on release from lint workflow by @deniseschannon in #2020
- [v0.19] feat: Ignore updates to Rancher managed annotations (#2075) by @neogopher in #2077
Full Changelog: v0.19.7...v0.19.8-beta.0
v0.21.0-alpha.4
What's Changed
- Reject empty datasource if external database is enabled by @rmweir in #2058
- add --ca-cert flag to the vcluster platform add vcluster, so it can b… by @hidalgopl in #2046
- refactor: enable limitRange / resourceQuota in duo by @FabianKramm in #2061
Full Changelog: v0.21.0-alpha.3...v0.21.0-alpha.4
v0.20.0
Major Changes
Please read this section carefully as it may be breaking changes.
New config format: vcluster.yaml
This release introduces the new vcluster.yaml
file which centralizes all the configuration options for vCluster and serves as the Helm values at the same time. This new configuration features a completely revamped format designed to enhance the user experience:
- Validation: We provide a JSON schema for
vcluster.yaml
, which is used by vCluster CLI and vCluster Platform UI now validate configurations before creating or upgrading virtual clusters. This schema has also been published to SchemaStore, so that most IDEs will recognize thevcluster.yaml
file and provide autocomplete and validation directly in the IDE editor. - Consolidated configuration: All configurations are centralized in the
vcluster.yaml
file, eliminating confusion previously caused by the mix of CLI flags, annotations, environment variables, and Helm values. - Consistent grouping and naming: Fields in
vcluster.yaml
are logically grouped under topical categories, simplifying navigation and enhancing discoverability of related features. - Docs alignment: Our documentation now mirrors the structure of
vcluster.yaml
, making it easier to cross-reference settings within the file and corresponding sections in the docs.
Migrating to vcluster.yaml
In order to make it easy to convert your old values.yaml
(v0.19 and below) to the new vcluster.yaml
format, you can run the new vcluster convert config
command. For example, let's take these pre-v0.20 configuration values:
# values.yaml
sync:
ingresses:
enabled: true
nodes:
enabled: true
fake-nodes:
enabled: false
syncer:
replicas: 3
extraArgs:
- --tls-san=my-vcluster.example.com
Running vcluster convert config --distro k3s < /path/to/values.yaml
will generate the following vcluster.yaml
:
# vcluster.yaml
sync:
toHost:
ingresses:
enabled: true
fromHost:
ingressClasses:
enabled: true
nodes:
enabled: true
controlPlane:
distro:
k3s:
enabled: true
proxy:
extraSANs:
- my-vcluster.example.com
statefulSet:
highAvailability:
replicas: 3
scheduling:
podManagementPolicy: OrderedReady
For more details on upgrading from older versions to v0.20, please read our configuration conversion guide.
Unified Helm chart for simplified deployment
We consolidated the distro-specific vCluster Helm charts (vcluster (k3s), vcluster-k8s, vcluster-k0s, and vcluster-eks) into a single, unified chart. This change is designed to simplify management and upgrading of virtual clusters:
- Single source: No more juggling multiple charts. The
vcluster.yaml
serves as the single source for all configuration in a unified Helm chart for all distros. - Enhanced validation: We've introduced a JSON schema for the Helm values, ensuring that upgrades will only proceed if your configuration matches the expected format to reduce deployment errors.
- Customizable distributions: The new unified chart structure enables easier customization of Kubernetes distributions directly via the Helm chart values:
# vcluster.yaml
controlPlane:
distro:
k8s:
enabled: true
K8s distro now supports SQLite & external databases
So far, virtual clusters running the vanilla k8s distro only supported etcd as storage backend which made this distro comparatively harder to operate than k3s. With vCluster v0.20, we’re introducing two new backing store options for vanilla k8s besides etcd:
- SQLite offers a more lightweight solution for data storage without the overhead associated with more complex choices like etcd or external databases. It is the new default for virtual clusters running the vanilla k8s distro.
- External Databases allow users to use any MySQL or Postgres compatible databases as backing stores for virtual clusters running the vanilla k8s distro. This especially useful for users who plan to outsource the backing store operations to managed database offerings such as AWS RDS or Azure Database.
Note: Switching backing stores is currently not supported. In order to use this new backing store, you will need to deploy net new virtual clusters and migrate the data manually with backup and restore tooling such as Velero. Upgrading your configuration via vcluster convert config
will explicitly write the previously used data store into your configuration to make sure upgrading an existing virtual cluster does not require changing the backing store.
EKS distro has been discontinued
Previously, vCluster offered the option to use EKS as a distro to run vCluster. However, this lead many users to believe they had to use the EKS distro to run vCluster on an EKS host cluster, which is not correct because any vCluster distro is able to run on an EKS host cluster. Given that the EKS distro did not provide any benefits beyond the vanilla k8s distro and introduced unnecessary confusion and maintenance effort, we decided to discontinue this distro. If you want to deploy virtual clusters on an EKS host cluster, we recommend using the k8s distro for vCluster going forward. If you plan on upgrading a virtual cluster that used EKS as a distro, please carefully read and follow this upgrade guide in the docs.
Changes in defaults for vCluster
There are several changes in the default configuration of a vCluster that are important for any users upgrading to v0.20+ or deploying net new clusters.
Default distro changed from k3s to vanilla k8s
We changed the default distribution for the vCluster control plane from K3s to K8s. This is the least opinionated option, offering greater flexibility and compatibility:
- Flexibility: More customization and scalability options, catering to a broader range of deployment needs.
- Compatibility: In addition to embedded and external etcd, you can now use various storage backends including SQLite, Postgres, and MySQL. This addition addresses previous challenges with using K8s for smaller virtual clusters.
Upgrade Notes: Switching distributions is not supported, so in order to use this new default, you will need to deploy net new virtual clusters.
Default image vcluster-pro
We've updated the default image repository for vCluster to ghcr.io/loft-sh/vcluster-pro
. This change allows users to seamlessly test and adopt vCluster Pro features without having to switch images from OSS to Pro. The Pro features are integrated into the Pro image but remain inactive by default to ensure that your experience remains exactly the same as with the OSS image.
Upgrade Notes: When upgrading from previous versions, the image will automatically be updated to start to pull from the new repository. For users who prefer to continue using the open-source image, simply adjust your vcluster.yaml
configuration to set the repository to loft-sh/vcluster-oss
. See the docs for details.
New Default Scheduling of Control Plane Pod: Parallel
We’ve updated the scheduling rule of the control plane from OrderedReady
to Parallel
. Since vCluster typically runs as a StatefulSet, this setting cannot be changed after the virtual cluster been deployed.
Increased Resource Requests
We increased the default resource requests for vCluster including increasing:
- Ephemeral storage from 200Mi to 400Mi (to ensure that SQLite powered virtual clusters have enough space to store data without running out of storage space when they are used over a prolonged period of time)
- CPU from 3m to 20m
- Memory from 16Mi to 64Mi
These changes are minimal and won’t have any significant impact on the footprint of a virtual cluster.
Disabled Node Syncing for Kind Clusters
When deploying virtual clusters with vCluster CLI, there is no automatic enabling of syncing real nodes for Kind clusters anymore.
Upgrade Notes: If you want to continue to enable this syncing, then you will need to this configuration to your vcluster.yaml
:
sync:
fromHost:
nodes:
enabled: true
controlPlane:
service:
spec:
type: NodePort
Behavior Changes
CLI Updates
There have been significant CLI changes as the above changes have required refactoring how the CLI worked in some areas. Besides the above changes, we merged the overlapping commands found in loft
and vcluster pro
. The full summary of CLI changes can be found in our docs at the following sites:
- General List of CLI Changes - Listing out what’s new, what’s been renamed or dropped.
- Guide using
vcluster convert
to convertvalues.yaml
files for pre-v0.20 virtual clusters to the updatedvcluster.yaml
to be used in upgrading to a v0.20+ vCluster - Reference guide of
loft
CLI commands to newvcluster
commands
Ingress syncing behavior has changed
Prior to v0.20, when you enabled syncing Ingresses from the virtual to the host cluster, it would also automatically sync all IngressClasses from the host cluster. However, this required a cluster role which some vCluster users don’t have. We’ve now decoupled these syncing behaviors so you can individually enable syncing Ingresses as well as IngressClasse...