How deeply does Effective Platform Engineering cover deprecation?

Explains promotion, deprecation, two-cycle compatibility, removal, event detection, and deployment scanning.

Deprecation

As explained in Effective Platform Engineering

Deprecation is the formal designation that a feature or interface remains temporarily available but should no longer be adopted and may later be removed.

Deprecation formally marks a feature or interface as still usable but no longer recommended for adoption, with removal planned later. It preserves backward compatibility while giving platform users time to migrate. section 9.3

Kubernetes promotes APIs through lifecycle stages, marks older versions deprecated after promotion, and removes them after two release cycles. Platform teams can use that window to coordinate upgrades instead of absorbing a sudden outage. section 9.3

A practical deprecation response includes:

Publish an upgrade event when the platform changes. section 9.3
Inspect changed apiVersions and scan deployed services for outdated versions. section 9.3
Give owning teams a deadline before removal breaks their deployments. section 9.3

apiVersion: admissionregistration.k8s.io/v1alpha1
Kind: MutatingWebHook

apiVersion: apps/v1
Kind: Deployment

Compare a deprecated admissionregistration API version with a current apps API version in deployment manifests. section 9.3

How Effective Platform Engineering covers it

liveBook manning.com

Read Effective Platform Engineering on liveBook Get the book at manning.com

Also explained in

liveBook manning.com

Django in ActionDeprecation is the practice of announcing that an existing interface or field will be removed after a transition period.
liveBook manning.com

API Design PatternsDeprecated is the API version lifecycle state in which a former current version remains available under current-version change restrictions but is scheduled for removal.
liveBook manning.com

Learn Rust in a Month of LunchesThe deprecated attribute marks a Rust item as discouraged for use and causes the compiler to issue a warning when it is used.
liveBook manning.com

Automating API DeliveryThe deprecated stability level denotes an API version that is scheduled for removal.

Compare how 5 books explain deprecation →

Related concepts

commentconfigured by · A comment is text or markup designated by a format's syntax as an annotation or non-content rather than ordinary executable or data content.
deleted statecontrasts with · Deleted is the API version lifecycle state in which a version has been removed and is no longer accessible.
sunset strategycontrasts with · A sunset strategy is the planned discontinuation and shutdown of a software component, such as an API or subsystem, after its supported service period.
api lifecyclepart of · An API lifecycle is the sequence of stages through which an API is designed, developed, tested, deployed, operated, evolved, and retired.
warning messageproduces · A warning message is a nonfatal diagnostic or notification about a potentially problematic, risky, unusual, or undesirable condition that may require attention.

This explainer was generated by Manning's knowledge graph from the text of Effective Platform Engineering. The section links point to the parts of the book it draws on.