Merge pull request #1476 from tjkirch/1.15-deprecation

Document the deprecation of the aws-k8s-1.15 variant

README.md

@@ -50,7 +50,6 @@ For example, an `x86_64` build of the `aws-k8s-1.19` variant will produce an ima
 
 The following variants support EKS, as described above:
 
-- `aws-k8s-1.15`
 - `aws-k8s-1.16`
 - `aws-k8s-1.17`
 - `aws-k8s-1.18`
@@ -60,6 +59,9 @@ We also have a variant designed to work with ECS, currently in preview:
 
 - `aws-ecs-1`
 
+The `aws-k8s-1.15` variant is deprecated and will no longer be supported in Bottlerocket releases.
+We recommend users replace `aws-k8s-1.15` nodes with the [latest variant compatible with their cluster](variants/).
+
 ## Architectures
 
 Our supported architectures include `x86_64` and `aarch64` (written as `arm64` in some contexts).

sources/models/README.md

@@ -22,7 +22,7 @@ Entries are sorted by filename, and later entries take precedence.
 
 The `#[model]` attribute on Settings and its sub-structs reduces duplication and adds some required metadata; see [its docs](model-derive/) for details.
 
-### aws-k8s-1.15: Kubernetes 1.15
+### aws-k8s-1.15: Kubernetes 1.15 (deprecated)
 
 * [Model](src/aws-k8s-1.15/mod.rs)
 * [Default settings](src/aws-k8s-1.15/defaults.d/)

sources/models/src/lib.rs

@@ -19,7 +19,7 @@ Entries are sorted by filename, and later entries take precedence.
 
 The `#[model]` attribute on Settings and its sub-structs reduces duplication and adds some required metadata; see [its docs](model-derive/) for details.
 
-## aws-k8s-1.15: Kubernetes 1.15
+## aws-k8s-1.15: Kubernetes 1.15 (deprecated)
 
 * [Model](src/aws-k8s-1.15/mod.rs)
 * [Default settings](src/aws-k8s-1.15/defaults.d/)

variants/README.md

@@ -24,13 +24,6 @@ Information about API settings for variants can be found in the [models](../sour
 
 ## Variants
 
-### aws-k8s-1.15: Kubernetes 1.15 node
-
-The [aws-k8s-1.15](aws-k8s-1.15/Cargo.toml) variant includes the packages needed to run a Kubernetes node in AWS.
-It supports self-hosted clusters and clusters managed by [EKS](https://aws.amazon.com/eks/).
-
-This variant is compatible with Kubernetes 1.15, 1.16, and 1.17 clusters.
-
 ### aws-k8s-1.16: Kubernetes 1.16 node
 
 The [aws-k8s-1.16](aws-k8s-1.16/Cargo.toml) variant includes the packages needed to run a Kubernetes node in AWS.
@@ -76,6 +69,17 @@ The [vmware-dev](vmware-dev/Cargo.toml) variant has useful packages for local de
 It includes tools for troubleshooting as well as Docker for running containers.
 User data will be read from a mounted CD-ROM, either from a file named "user-data" or from an OVF file.
 
+### Deprecated variants
+
+#### aws-k8s-1.15: Kubernetes 1.15 node
+
+The [aws-k8s-1.15](aws-k8s-1.15/Cargo.toml) variant includes the packages needed to run a Kubernetes node in AWS.
+It supports self-hosted clusters and clusters managed by [EKS](https://aws.amazon.com/eks/).
+
+This variant is compatible with Kubernetes 1.15, 1.16, and 1.17 clusters.
+
+Upstream support for Kubernetes 1.15 has ended and this variant will no longer be supported in Bottlerocket releases.
+
 ## Development
 
 Say we want to create `my-variant`, a custom build of Bottlerocket that runs `my-agent`.