What's Changed

Missing attribute bugfix + extra standard derives on core::conversion structs.

Added

• Add missing derives on conversion types by @sbernauer in #1759

Fixed

• Emit #[schemars(crate)] attribute by @Techassi in #1764

Full Changelog: 1.0.0...1.1.0

A Major Version

It's been a long time coming, but time has come to draw the line in the sand. No alphas, no betas. Hope it finds you all well. Thanks to everyone who has contributed over the years.

This is a somewhat symbolic gesture, because semver-breaking changes are still hard to avoid with a large set of sub-1.0 dependencies we need to bump, as well as managing the large api surface of Kubernetes.

Therefore, the plan is to align our breaking changes and major bumps with Kubernetes versions / k8s-openapi versions for now, and this should allow our other releases to stream in. See #1688 for more information.

Kubernetes v1_33 support via k8s-openapi 0.25

Please upgrade k8s-openapi along with kube to avoid conflicts.

New minimum versions: MSRV 1.82.0, MK8SV: 1.30*

KubeSchema

The CELSchema alternate derive for JsonSchema has been renamed to KubeSchema to indicate the increased functionality.

In addition to being able to inject CEL rules for validations, it can now also inject x-kubernetes properties such as merge-strategy via #1750, handle #[validate] attributes #1749, and pass validation rules as string literals #1754 :

#[derive(CustomResource, Serialize, Deserialize, Debug, PartialEq, Clone, KubeSchema)]
#[kube(...properties)
struct DocumentSpec {
    /// New merge strategy support
    #[x_kube(merge_strategy = ListMerge::Set)]
    x_kubernetes_set: Vec<String>,

    /// CEL Validation now lives on x_kube and supports literal Rules:
    #[x_kube(validation = "!has(self.variantOne) || self.variantOne.int > 22")]
    complex_enum: ComplexEnum,
}

See kube.rs docs on validation for more info. Huge thanks to @Danil-Grigorev.

What's Changed

Added

• feat(deps): enable hyper-util/tracing feature flag by @cratelyn in #1734
• Permit literal string validation for CEL expressions by @Danil-Grigorev in #1754

Changed

• Support additional x-kubernetes-* schema extensions by @Danil-Grigorev in #1750
• Bump k8s-openapi to 0.25.0 by @clux in #1756

Removed

• Remove deprecated watcher::Event into_iter_* methods by @clux in #1738

Fixed

• docs: Adjust #[kube(scale(...)] doc example by @Techassi in #1733
• Add suffix to generated struct by CELSchema by @Danil-Grigorev in #1747
• Allow schemars validate attribute in CELSchema by @Danil-Grigorev in #1749
• fix: resolve conflict with schemars preserve_order feature by @HoKim98 in #1758

New Contributors

• @cratelyn made their first contribution in #1734
• @JanBerktold made their first contribution in #1752

Full Changelog: 0.99.0...1.0.0

Highlights

Dependency Cleanups

• backoff (unmaintained) replaced with backon in #1653
  • No change if you are using default_backoff natively, or through Controller.
  • Parameters configurable via ExponentialBackoff from backon::ExponentialBuilder into WatchStreamExt::backoff
• json-patch bumped and uses re-exported jsonptr for less version clashes #1718
• rand dependency no longer explicit as only rng is under ws feature via tungstenite's client::generate_key #1691
• ring (still maintained) now optional for rustls-tls feature (for alternate aws-lc-rs) #1717

Features

• Support for the v5.channel.k8s.io streaming ws protocol to allow closing streams properly (kubernetes.io blog) #1693
• CustomResource derive; typed attributes for #[kube(scale)] and #[kube(deprecated)] in #1656 + #1697
• Client::with_valid_until to handle short lived local client certs #1707
• New common conditions that can be awaited #1710

What's Changed

Added

• Add typed scale argument to derive macro by @Techassi in #1656
• Add deprecated argument to derive macro by @Techassi in #1697
• Add Api::get_metadata_opt_with by @sebsoto in #1708
• Add common wait conditions for Deployments, LoadBalancer Services, and Ingress by @detjensrobert in #1710
• Add Client::with_valid_until for client cert expiry by @goenning in #1707
• kube-runtime: make ExponentialBackoff public by @gdeleon2 in #1716

Changed

• Replace backoff with backon by @flavio in #1653
• Bump rand to 0.9 by @clux in #1686
• Remove rand dependency in favor of tungstenite fn by @clux in #1691
• Exec can return stdout data even after stdin is closed. by @esw-amzn in #1693
• Bump json-patch to 4 use bundled jsonptr to 0.7 by @clux in #1718
• Allow removing hyper-rustls/ring feature by @eliad-wiz in #1717

Fixed

• kube-runtime: fix exponential backoff max times by @eliad-wiz in #1713
• CustomResource derive; allow status attribute to take a path by @clux in #1704

New Contributors

• @esw-amzn made their first contribution in #1693
• @sebsoto made their first contribution in #1708
• @zhanluxianshen made their first contribution in #1709
• @detjensrobert made their first contribution in #1710
• @gdeleon2 made their first contribution in #1716

Full Changelog: 0.98.0...0.99.0

Highlights

• Kubernetes v1_32 support via k8s-openapi 0.24
  • Please upgrade k8s-openapi along with kube to avoid conflicts.
  • New minimum versions: MSRV 1.81.0, MK8SV: 1.28
• kube-derive additions:
  • A CELSchema derive macro wrapper around JsonSchema for injecting cel validations into the schema #1649
  • Allow overriding served and storage booleans for multiple versions of CustomResource derives: #1644
• kube-runtime event Recorder now aggregates repeat events #1655 (some breaking changes, see controller-rs#116)
• kube-client UTF-16 edge case handling for windows #1654

What's Changed

Added

• Add storage and served argument to derive macro by @Techassi in #1644
• Implement derive(CELSchema) macro for generating cel validation on CRDs by @Danil-Grigorev in #1649

Changed

• Add series implementation for runtime event recorder by @pando85 in #1655
• Bump k8s-openapi for Kubernetes v1_32 support and MSRV by @clux in #1671
• Update tokio-tungstenite requirement from 0.24.0 to 0.25.0 by @dependabot in #1666

Fixed

• Add support for UTF-16 encoded kubeconfig files by @goenning in #1654

New Contributors

• @Techassi made their first contribution in #1644
• @mgs255 made their first contribution in #1647
• @pando85 made their first contribution in #1655

Full Changelog: 0.97.0...0.98.0

Highlights

• CustomResource derive added features for crd yaml output:
  • selectable fields #1605 + #1610
  • annotations and labels #1631
• Configuration edge cases:
  • Avoid double installations of aws-lc-rs (rustls crypto) provider #1617
  • Kubeconfig fix for null user; #1608
  • Default runtime watcher backoff alignment with client-go #1603
• Feature use:
  • Client proxy feature-set misuse prevention #1626
  • Allow disabling gzip via Config #1627
• Depedency minors: thiserror, hashbrown, jsonptr, json-patch. Killed lazy_static / once_cell

What's Changed

Added

• Feature: Allow to pass selectableFields for CRD definition by @Danil-Grigorev in #1605
• add support for CRD annotations and labels in kube-derive by @verokarhu in #1631
• Feature: Add config setting to disable gzip compression #1627 by @markdingram in #1628

Changed

• upgrade to hashbrown 0.15.0 by @rorosen in #1599
• update jsonptr + json-patch by @aviramha in #1600

Fixed

• fix(kube-runtime): setup backoff with builder pattern by @tiagolobocastro in #1603
• allow null user in kubeconfig's context by @aviramha in #1608
• Gauge SelectableField by k8s 1.30 version by @Danil-Grigorev in #1610
• Add a compile_error if setting selectable fields on K8s < 1.30 by @clux in #1612
• conditionally install aws-lc-rs by @goenning in #1617
• Warn when trying to use an unsupported proxy protocol by @nightkr in #1626

New Contributors

• @bryantbiggs made their first contribution in #1629
• @verokarhu made their first contribution in #1631

Full Changelog: 0.96.0...0.97.0

Highlights

• Features: webpki-roots added #1323, and predicates no longer require unstable-runtime #1578
• Local auth: improve leniency/kubectl-alignment #1595, remove http proxy vars #1520
• Dependencies: upgrades to tower and secrecy, and derivative swapped for educe

What's Changed

Added

• rustls: optionally use WebPKI roots to avoid panicking on Android & iOS by @ewilken in #1323
• Stabilise runtime predicates by @clux in #1578
• Add ObjectRef::from as alias for ::from_obj by @nightkr in #1598

Changed

• Bump secrecy to 0.10 by @clux in #1588
• Upgrades tower to 0.5.1 by @markdingram in #1589
• runtime: rename references from Flatten to Decode by @clux in #1520

Removed

• remove using HTTP PROXY from environment variable by @aviramha in #1587

Fixed

• replace derivative dependency with educe by @rorosen in #1585
• change auth behavior to match upstream on unknown/empty user - use null auth by @aviramha in #1595

New Contributors

• @ewilken made their first contribution in #1323

Full Changelog: 0.95.0...0.96.0

Kubernetes v1_31 support via k8s-openapi 0.23

Please upgrade k8s-openapi along with kube to avoid conflicts.

New minimum versions: MSRV 1.77.2, MK8SV: 1.26

What's Changed

Changed

• Update tokio-tungstenite requirement from 0.23.0 to 0.24.0 by @dependabot in #1579
• Bump k8s-openapi to 0.23 for Kubernetes 1.31 support by @clux in #1581

Full Changelog: 0.94.2...0.95.0

What's Changed

Fixes a runtime regression in watch_object.

Fixed

• Ensure watch_object handles objects removed before init by @markdingram in #1577

New Contributors

• @markdingram made their first contribution in #1577

Full Changelog: 0.94.1...0.94.2

What's Changed

Convenience release. Adjusted a version bound to avoid possibility of running into version compatibility errors with hyper-rustls.

Fixed

• Update hyper-rustls minimum version by @divergentdave in #1575

New Contributors

• @divergentdave made their first contribution in #1575

Full Changelog: 0.94.0...0.94.1

Highlights

Support for rustls's aws-lc-rs is available under a new kube/aws-lc-rs feature. Via #1568 for #1562

Furthermore, there are features to help avoid dynamic typing:

1. Added a DeserializeGuard safety wrapper to lift deserialisation errors (to e.g. not break watchers). See the errorbound example and core module module. Wrapped type be used with e.g. Api::<DeserializeGuard<CaConfigMap>>. Via #1556
2. A derive macro for Resource; #[derive(Resource)] allows inheriting existing k8s-openapi resource implementations to avoid stepping down to the dynamic api. See the cert check example for usage. Via #1565

What's Changed

Added

• Add error boundary wrapper type by @nightkr in #1556
• Implement Error for error_boundary::InvalidObject by @nightkr in #1558
• Add finalizers predicate filter by @ivan-kiselev in #1560
• optional feature to use aws-lc-rs rustls feature by @mcluseau in #1568
• Add Resource derive macro by @Danil-Grigorev in #1565

Changed

• Make implicitly dependent feature explicitly depend on each other by @clux in #1551

New Contributors

• @ivan-kiselev made their first contribution in #1560
• @mcluseau made their first contribution in #1568
• @yerke made their first contribution in #1571

Full Changelog: 0.93.1...0.94.0