rancher
/
cluster-api-provider-rke2
mirror of https://github.com/rancher/cluster-api-provider-rke2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add ADR explaining removal of kubebuilder defaults 

Signed-off-by: Alexandr Demicev <alexandr.demicev@suse.com>
This commit is contained in:
Alexandr Demicev 2024-05-21 13:35:21 +02:00
parent 3f6e61830b
commit 32a9943b84
No known key found for this signature in database
GPG Key ID: D179B8D78CB2D9B7
2 changed files with 53 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/adr/0001-separate-CP-and-worker-versions.md
View File

@ -6,7 +6,7 @@
# 1. Separate Control Plane and Worker Versions
- Status: proposed
- Status: accepted
- Date: 2024-05-20
- Authors: @Danil-Grigorev
- Deciders: @alexander-demicev @furkatgofurov7 @salasberryfin @mjura @yiannistri

52
docs/adr/0002-deprecate-kubebuilder-defaults.md Normal file
View File

@ -0,0 +1,52 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [Deprecate kubebuilder defaults](#deprecate-kubebuilder-defaults)
- [Context](#context)
- [Decision](#decision)
- [Consequences](#consequences)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# Deprecate kubebuilder defaults
<!-- A short and clear title which is prefixed with the ADR number -->
<!-- TODO: remove the following disable link checker comment before committing your ADR -->
<!-- markdown-link-check-disable-next-line -->
- Status: accepted
- Date: 2024-05-21
- Authors: @alexander-demicev
- Deciders: @Danil-Grigorev @furkatgofurov7 @salasberryfin @mjura @yiannistri
## Context
<!-- What is the context of the decision and what's the motivation -->
Enforcing default values for fields in CRD definitions can cause problem with the GitOps approach. It can lead to a situation where defined resources in Git repository differs from the actual state of applied resources in the cluster. This can lead to unexpected behavior like state drift, unless is manually handled.
## Decision
<!-- What is the decision that has been made -->
Kubebuilder defaulting annotations were [deprecated in CAPRKE2 API](https://github.com/rancher-sandbox/cluster-api-provider-rke2/commit/86025754c0993e6e0d549110cc7f38687ac420e3). As a result of this deprecation
CRD definitions don't include default values for some fields.
## Consequences
<!-- Whats the result or impact of this decision. Does anything need to change and are new GitHub issues created as a result -->
Users have to specify the following fields manually when creating RKE2ControlPlane resources:
- `spec.rolloutStrategy`:
```yaml
rolloutStrategy:
type: "RollingUpdate"
rollingUpdate:
maxSurge: 1 # can be 0
```
- `spec.registrationMethod`:
```yaml
registrationMethod:
type: "control-plane-endpoint" # other supported values are "internal-only-ips", "external-only-ips", "address", "internal-first"
```
`"control-plane-endpoint"` is the recommended value for `registrationMethod` field as other can cause issue with scaling the cluster and should be used with caution.