Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 2.44 KB

deprecation.md

File metadata and controls

43 lines (33 loc) · 2.44 KB
Raw

Deprecation Policy

In order for any software to be reliable enough for production use, it needs to have a stable API. This means that users would have a high confidence that the way they use Kubevirt would not become obsolete, or at least would give the proper time to prepare if it does.

This document aims to specify a process for several aspects of deprecation revolving Kubevirt. This is intended to be a "live document" which updates and refines itself over time.

Process

Feature Gates

Introduction

A feature gate should be introduced for every new feature, capability, configuration or any other change that is not yet stable and can jeopardize the cluster.

A feature gate serves as:

  • A way to warn the user about a possible danger that could be caused by an unstable logic.
  • A way for the users to explicitly state that they would like to take the risk and enable the feature.
  • A way for the user to explicitly confirm that some feature / HW is available on the cluster.

Over time the new features would stabilize and graduate their API versions (i.e. from alpha, to beta to stable). When that happens, and therefore the risk of jeopardizing the user decreases significantly, the feature should be enabled by default and the feature gate should be deprecated (see section below).

Deprecation

A feature gate should be deprecated for one of the following reasons:

  • When a feature stabilizes and there is no need to guard it by a feature gate.
  • When a feature (that's guarded with a feature gate) did not show as useful, therefore is deprecated.

In order to deprecate a feature gate the following conditions must be met:

  • All the features that used to be guarded by it need to be enabled by default.
    • The above point means that all of the features that were guarded by this feature gate would be enabled without the need to enable this feature gate. In other words, the feature gate needs to turn into a no-op.
  • When the feature gate is enabled (by creating / updating Kubevit CR), a warning should be presented to the user. The best fit to trigger the warning is probably our validating webhooks.
  • A mail should be sent to kubevirt-dev mailing list ([email protected]) to inform about the deprecation.

After the above deprecation process, the feature gate should remain as a no-op with a warning popping up.

Discussion

An ongoing discussion takes part in the following issue: kubevirt#7745