Skip to content

add deprecation page #2587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add deprecation page #2587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/content/docs/community/deprecation-policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: "Deprecation Policy"
description: "ACK deprecation policy and current deprecations dashboard"
lead: "Understanding ACK's deprecation process and timeline"
draft: false
menu:
docs:
parent: "introduction"
weight: 15
toc: true
---

## Deprecation Policy

The AWS Controllers for Kubernetes (ACK) project follows a structured deprecation process to ensure users have adequate time to migrate to new features.

### Deprecation Timeline

ACK follows a structured 3-month deprecation process to ensure users have adequate time for migration:

| Phase | Duration | Description | Actions |
|-------|----------|-------------|---------|
| **Announcement** | Month 1 | Official deprecation announcement | • Public announcement via GitHub issue<br>• Documentation updated with deprecation notices<br>• Migration guidance provided<br> |
| **Deprecation** | Months 1-3 | Feature marked deprecated with warnings | • Feature turned off by default<br>• Alternative features promoted to higher stability<br>• Community migration support provided |
| **Removal** | End of Month 3 | Complete feature removal | • Feature completely removed from codebase<br>• CRDs and related resources deleted<br>• Alternative features reach production readiness<br>• Final migration deadline |

## Current Deprecations

{{% hint type="warning" title="Deprecation Notice" %}}
The following features are **deprecated** and will be **removed on October 31, 2024**:
{{% /hint %}}

| Feature | Status | Replacement |
|---------|---------|-------------|
| **FieldExport CRD** | Deprecated<br>**Removal: Oct 31, 2024** | [KRO (Kubernetes Resource Orchestrator)](https://kro.run/docs/overview/) |
| **AdoptedResource CRD** | Deprecated<br>**Removal: Oct 31, 2024** | [ResourceAdoption via annotations](../user-docs/features/#resourceadoption) |


### Feature Graduations

| Feature | Current Status | Next Milestone | Info |
|---------|---------------|----------------|---------|
| **ResourceAdoption** | Beta (July 2025) | **GA: October 2025** | **Replacement for AdoptedResource CRD**
| **ReadOnlyResources** | Beta (July 2025) | **GA: October 2025** | -


## Getting Help

If you need assistance with migration:

1. Check the [ACK Community Discussions](https://github.com/aws-controllers-k8s/community/discussions)
2. File an issue in the [ACK Community repository](https://github.com/aws-controllers-k8s/community/issues)

4 changes: 4 additions & 0 deletions docs/content/docs/user-docs/field-export.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ weight: 65
toc: true
---

{{% hint type="warning" title="Warning" %}}
FieldExport is deprecated and will be removed on October 31, 2024. The recommended alternative is [KRO (Kubernetes Resource Orchestrator)](https://kro.run/docs/overview/). Please migrate your FieldExport resources to KRO for continued functionality.
{{% /hint %}}

ACK controllers are intended to manage your AWS infrastructure using Kubernetes
custom resources. Their responsibilities end after managing the lifecycle of
your AWS resource and do not extend into binding to applications running in the
Expand Down