Skip to content

Commit

Permalink
Add upgrade guide (#1542)
Browse files Browse the repository at this point in the history
* Add the upgrade guide doc
  • Loading branch information
spring1843 authored Mar 18, 2022
1 parent 8c415c8 commit 640573f
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions website/content/en/preview/upgrade-guide/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: "Upgrade Guide"
linkTitle: "Upgrade Guide"
weight: 10
---

# Compatible Dependents

To make upgrading easier we aim to minimize introduction of breaking changes with the followings:

1. Provisioner API
2. Helm Chart

When we introduce a breaking change, we do so only in as described in this document.

## What We Keep Compatible

2. The application itself
3. The documentation of the application

## When Do We Break Compatibility?

According to [Semantic Versioning 2.0.0](https://semver.org/) which Karpenter follows in our release versions, while in
major version zero (v0.y.z) [anything may change at any time](https://semver.org/#spec-item-4). However, to further
protect our customers during this phase we will only introduce breaking changes in minor releases (releases that
increment y in x.y.z). Note this does not mean every minor upgrade has a breaking change as we will also increment the
minor version when we release a new feature.

The users should therefore check to see if there is breaking change, every time they are upgrading to a new minor
version.

## How Do We Break Incompatibility?

When there is a breaking change we will:

* Increment the minor version when in major version 0
* Add a permanent separate file named `migrating_to_vx.y.z.md` to our website (linked at the bottom of this page)
clearly explaining the breaking change and what needs to be done on the customer side to ensure a safe upgrade
* Add the sentence “This is a breaking change, please refer to `migrating_to_x.y.z.md` for upgrade instructions” to the
top of the release notes and in all our announcements

## How Do We Find Incompatibilities

Besides the peer review process for all changes to the code base we also do the followings in order to find
incompatibilities:
* (To be implemented) Automated tests to see if installing, uninstalling, upgrading from an older version and downgrading
to an older version to check the compatibility of the application
* (To be implemented) Turn the commands in our
documentation into scripts that we can automatically run to find incompatibilities between the application and
documentation

## Nightly Builds

(To be implemented) Every night we will build and release everything that has been checked into the source code. This
allows us to detect problems including breaking changes and potential drifts in our external dependencies sooner than we
otherwise would. It also allows some of advanced users who have their own nightly builds to test the upcoming changes
before they are released.

## Release Candidates

(To be implemented) We are considering having release candidates when we are in major version 1. By adopting this
practice we allow our users who are early adopters to test out new releases before they are available to the wider
community thereby providing us with early feedback which would result in more stable releases.

## Security Patches

While we are in major version 0 we will not release security patches to older versions, rather we provide the patches in
the latest versions. When at major version 1 we will have an EOL (end of life) policy where we provide security patches
for a subset of older versions and deprecate the others.

# Released Upgrade Notes

There are no published upgrade notes yet.

0 comments on commit 640573f

Please sign in to comment.