docs: add breaking changes page for cross-namespace default change#37
docs: add breaking changes page for cross-namespace default change#37kprahulraj wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: kprahulraj The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
79e2e8f to
2347a20
Compare
|
This should be added along with the feature to support enable cross namespace |
jlbutler
left a comment
jlbutler
left a comment
There was a problem hiding this comment.
looks good, left a few comments / followups
| ## Documenting Breaking Changes | ||
|
|
||
| If your PR introduces a breaking change (e.g., changing a default value, removing a flag, altering reconciliation behavior), you must update the [Breaking Changes](/docs/breaking-changes) page. | ||
|
|
There was a problem hiding this comment.
can we open an issue to make a corresponding guidance change in the ack-dev skill?
There was a problem hiding this comment.
|
|
||
| # Breaking Changes | ||
|
|
||
| This page tracks upcoming breaking changes to ACK controller defaults and behavior. Review this page before upgrading your controllers. |
There was a problem hiding this comment.
upcoming only, or does this page also track previously communicated and shipped breaking changes?
There was a problem hiding this comment.
Good point - this should track both upcoming and previously shipped breaking changes. Do you have a list of previous breaking changes that I can add here? I'll update the wording once we have those documented
There was a problem hiding this comment.
aws-controllers-k8s/community#2586 describes the deprecation of AdoptedResource in favor of adoption by annotation which is a previous breaking change that we've made.
…amespace default change - Add Breaking Changes page at top-level sidebar (same level as Overview, Getting Started) - Add Documenting Breaking Changes guideline to Contributing section - Add New badge to Breaking Changes and Contributing - Remove New badge from EKS Capabilities, Granular IAM Roles, Using ACK with kro
2347a20 to
4a3ec5a
Compare
|
|
||
| ```yaml | ||
| # values.yaml | ||
| enableCrossNamespace: true |
There was a problem hiding this comment.
We should also add an entry for this new Helm chart value on this page.
https://aws-controllers-k8s.github.io/docs/guides/helm-values
…ces (#46) ## Description of changes Builds on #37 (cross-namespace default change). Adds user-facing documentation for the `enableCrossNamespace` Helm value / `--enable-cross-namespace` controller flag introduced in [runtime#239](aws-controllers-k8s/runtime#239) and [code-generator#699](aws-controllers-k8s/code-generator#699). ### Changes - **`guides/helm-values.md`**: Add a `Cross-Namespace References` section documenting the `enableCrossNamespace` value (type, default, description, and deprecation warning). - **`concepts.md`** (Field References): Add a warning noting that resource and secret references can target another namespace, gated by `enableCrossNamespace`, with links to Breaking Changes and the Helm value reference. - **`guides/field-export.md`** (Security Considerations): Correct the previous "same namespace only" statement to reflect the current cross-namespace default and the upcoming change, with cross-links. These cover all three behaviors gated by the flag: resource references (`*Ref`), secret references (`SecretKeyReference`), and `FieldExport` targets. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
|
merged in another PR #46 |
|
@sapphirew: Closed this PR. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
4 participants
Description of changes:
add breaking changes page for cross-namespace default change
Newtag to contributing and breaking changesThis will be requirement when we add the feature to support enable cross namespace
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.