Skip to content

Commit 702dd69

Browse files
theunrepentantgeektheunrepentantgeek
authored
Move more ADRs to the completed section (#4955)
1 parent 32f622c commit 702dd69

File tree

1 file changed

+35
-30
lines changed

1 file changed

+35
-30
lines changed

‎docs/hugo/content/design/_index.md‎

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,15 @@ These ADRs reflect work that is being discussed, has been proposed, or is curren
2626

2727
### 2024
2828

29-
| Title | Description |
30-
| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
31-
| [**OperatorSpec Custom Properties**]({{< relref "ADR-2024-05-OperatorSpec-Custom-Properties" >}}) | Injecting additional properties into OperatorSpec for additional flexibility and extensibility of resources. |
32-
| [**RoleAssignments UUID Generation**]({{< relref "ADR-2024-04-RoleAssignment-UUID-Generation" >}}) | Allowing users more control over how the GUIDs used for naming RoleAssignments are generated. |
33-
| [**Upstream Deletion**]({{< relref "ADR-2024-02-Upstream-Deletion" >}}) | When might deletion of an upstream resource occur and how will ASO handle it. |
29+
| Title | Description |
30+
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
31+
| [**Upstream Deletion**]({{< relref "ADR-2024-02-Upstream-Deletion" >}}) | When might deletion of an upstream resource occur and how will ASO handle it. |
3432

3533
### 2023
3634

37-
| Title | Description |
38-
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
39-
| [**Adoption Policy**]({{< relref "ADR-2023-02-Adoption-Policy" >}}) | Understand the policy for adopting pre-existing Azure resources in Kubernetes through the Azure Service Operator, including the principles guiding resource adoption and the user's ability to control operator actions. |
40-
| [**Deprecation**]({{< relref "ADR-2023-04-Deprecation" >}}) | Understand the policy for handling Azure resource deprecation in Azure Service Operator, including the process for flagging deprecated resources, communicating changes, and removing unsupported resources. |
41-
| [**Patch Collections**]({{< relref "ADR-2023-04-Patch-Collections" >}}) | Address the issue of resource drift in Azure Service Operator due to Azure Resource Providers' PATCH-like behavior on PUT, and discuss potential solutions such as optional properties and explicit nulls to ensure the custom resource represents the complete desired state. |
35+
| Title | Description |
36+
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
37+
| [**Resource Deprecation**]({{< relref "ADR-2023-04-Deprecation" >}}) | Understand the policy for handling Azure resource deprecation in Azure Service Operator, including the process for flagging deprecated resources, communicating changes, and removing unsupported resources. |
4238

4339
### 2022
4440

@@ -48,28 +44,35 @@ These ADRs reflect work that is being discussed, has been proposed, or is curren
4844

4945
### Older
5046

51-
| Title | Description |
52-
| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
53-
| [**CrossPlane**]({{< relref "crossplane" >}}) | Discusses the intricacies of code generation for Crossplane, including static "special" properties, cross resource references, and the challenges associated with generating these references. |
54-
| [**Custom validation and defaulting**]({{< relref "annotations" >}}) | Delve into the proposal for custom validation and defaulting for code-generated resources, discussing the limitations of controller-runtime interfaces and suggesting a structure for autogenerated webhooks that allows for custom implementations. |
55-
| [**Improving the Reconciler interface**]({{< relref "reconcile-interface" >}}) | Explore a proposal for improving the Reconciler interface in controller-runtime, addressing issues of code duplication and potential bugs due to differences in checks for Create vs Delete operations. |
56-
| [**Type References and Ownership**]({{< relref "type-references-and-ownership" >}}) | type references and ownership in Azure Service Operator, discussing goals such as idiomatic expression of Azure resource relationships, automatic ownership, garbage collection, and interaction with non-Kubernetes managed Azure resources. |
47+
| Title | Description |
48+
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
49+
| [**CrossPlane**]({{< relref "crossplane" >}}) | Discusses the intricacies of code generation for Crossplane, including static "special" properties, cross resource references, and the challenges associated with generating these references. |
50+
| [**Improving the Reconciler interface**]({{< relref "reconcile-interface" >}}) | Explore a proposal for improving the Reconciler interface in controller-runtime, addressing issues of code duplication and potential bugs due to differences in checks for Create vs Delete operations. |
5751

5852
## Completed Changes
5953

6054
These ADRs reflect work that has been completed.
6155

56+
### 2024
57+
58+
| Title | Description |
59+
| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
60+
| [**OperatorSpec Custom Properties**]({{< relref "ADR-2024-05-OperatorSpec-Custom-Properties" >}}) | Injecting additional properties into OperatorSpec for additional flexibility and extensibility of resources. |
61+
| [**RoleAssignments UUID Generation**]({{< relref "ADR-2024-04-RoleAssignment-UUID-Generation" >}}) | Allowing users more control over how the GUIDs used for naming RoleAssignments are generated. |
62+
6263
### 2023
6364

64-
| Title | Description |
65-
| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
66-
| [**Conversion Augmentation**]({{< relref "ADR-2023-01-Conversion-Augmentation" >}}) | Learn about the need for conversion augmentation in Kubernetes resource versions, the role of code generation, and the strategies for augmenting these conversions with hand-written code to ensure backward and forward compatibility. |
67-
| [**Goal Seeking KeyVaults**]({{< relref "ADR-2023-07-Goal-Seeking-KeyVaults" >}}) | Understand the challenges posed by Azure KeyVault's soft-delete feature in a goal-seeking system like Azure Service Operator, and the need for a solution that prevents resources from entering permanently degraded states without manual intervention. |
68-
| [**Helm Chart Size Limitations**]({{< relref "ADR-2023-02-Helm-Chart-Size-Limitations" >}}) | Address the Helm chart size limitations causing problems for Azure Service Operator, discussing the implications of Kubernetes secret size limits, the impact on chart installation, and potential workarounds such as splitting the Helm chart. |
69-
| [**Installing Only Selected CRDs**]({{< relref "ADR-2023-05-Installing-Only-Selected-CRDs" >}}) | Understand the need for selective CRD installation in Azure Service Operator to mitigate kube-apiserver memory usage, and the requirements for a seamless upgrade experience and default configuration that fits into minimal memory environments |
70-
| [**Package References**]({{< relref "ADR-2023-07-PackageReferences" >}}) | Consider the proposal for introducing a SubPackageReference in the Azure Service Operator code generator, discussing the implications for code that consumes PackageReference and the potential impact on namespace pollution and code organization. |
71-
| [**Post-Reconciliation Extensions**]({{< relref "ADR-2023-03-Post-Reconciliation-Extension" >}}) | Understand the introduction of the PostReconciliationChecker extension in Azure Service Operator to handle post-reconciliation operations, allowing for custom conditions to be set on resources based on the status received from Azure Resource Manager. |
72-
| [**Skipping Properties**]({{< relref "ADR-2023-09-Skipping-Properties" >}}) | A design to address the problems that occur when a property skips multiple resource versions and has a different shape when it returns. |
65+
| Title | Description |
66+
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
67+
| [**Adoption Policy**]({{< relref "ADR-2023-02-Adoption-Policy" >}}) | Understand the policy for adopting pre-existing Azure resources in Kubernetes through the Azure Service Operator, including the principles guiding resource adoption and the user's ability to control operator actions. |
68+
| [**Conversion Augmentation**]({{< relref "ADR-2023-01-Conversion-Augmentation" >}}) | Learn about the need for conversion augmentation in Kubernetes resource versions, the role of code generation, and the strategies for augmenting these conversions with hand-written code to ensure backward and forward compatibility. |
69+
| [**Goal Seeking KeyVaults**]({{< relref "ADR-2023-07-Goal-Seeking-KeyVaults" >}}) | Understand the challenges posed by Azure KeyVault's soft-delete feature in a goal-seeking system like Azure Service Operator, and the need for a solution that prevents resources from entering permanently degraded states without manual intervention. |
70+
| [**Helm Chart Size Limitations**]({{< relref "ADR-2023-02-Helm-Chart-Size-Limitations" >}}) | Address the Helm chart size limitations causing problems for Azure Service Operator, discussing the implications of Kubernetes secret size limits, the impact on chart installation, and potential workarounds such as splitting the Helm chart. |
71+
| [**Installing Only Selected CRDs**]({{< relref "ADR-2023-05-Installing-Only-Selected-CRDs" >}}) | Understand the need for selective CRD installation in Azure Service Operator to mitigate kube-apiserver memory usage, and the requirements for a seamless upgrade experience and default configuration that fits into minimal memory environments |
72+
| [**Package References**]({{< relref "ADR-2023-07-PackageReferences" >}}) | Consider the proposal for introducing a SubPackageReference in the Azure Service Operator code generator, discussing the implications for code that consumes PackageReference and the potential impact on namespace pollution and code organization. |
73+
| [**Patch Collections**]({{< relref "ADR-2023-04-Patch-Collections" >}}) | Address the issue of resource drift in Azure Service Operator due to Azure Resource Providers' PATCH-like behavior on PUT, and discuss potential solutions such as optional properties and explicit nulls to ensure the custom resource represents the complete desired state. |
74+
| [**Post-Reconciliation Extensions**]({{< relref "ADR-2023-03-Post-Reconciliation-Extension" >}}) | Understand the introduction of the PostReconciliationChecker extension in Azure Service Operator to handle post-reconciliation operations, allowing for custom conditions to be set on resources based on the status received from Azure Resource Manager. |
75+
| [**Skipping Properties**]({{< relref "ADR-2023-09-Skipping-Properties" >}}) | A design to address the problems that occur when a property skips multiple resource versions and has a different shape when it returns. |
7376

7477
### 2022
7578

@@ -101,11 +104,13 @@ These ADRs reflect work that has been completed.
101104

102105
### Earlier
103106

104-
| Title | Description |
105-
| ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
106-
| [**Clarifying Object Structure**]({{< relref "clarifying-object-structure" >}}) | Dive into the challenges of differentiating Azure-specific properties from operator-specific properties in the object structure of resources, with a focus on potential solutions for Status and upcoming properties like SecretConfiguration and Credentials. |
107-
| [**Managing dataplane secrets**]({{< relref "secrets" >}}) | Managing dataplane secrets in Azure Service Operator, including the drawbacks of auto-generating secrets and the implications for secret rollover, control, security, resource adoption, and GitOps compatibility. |
108-
| [**Reporting Resource Status**]({{< relref "resource-states" >}}) | A proposal for reporting resource status in Azure Service Operator, discussing the distinction between operator status and Azure resource state, and the current state and limitations of both handcrafted and auto-generated resources. |
107+
| Title | Description |
108+
| ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
109+
| [**Clarifying Object Structure**]({{< relref "clarifying-object-structure" >}}) | Dive into the challenges of differentiating Azure-specific properties from operator-specific properties in the object structure of resources, with a focus on potential solutions for Status and upcoming properties like SecretConfiguration and Credentials. |
110+
| [**Custom validation and defaulting**]({{< relref "annotations" >}}) | Delve into the proposal for custom validation and defaulting for code-generated resources, discussing the limitations of controller-runtime interfaces and suggesting a structure for autogenerated webhooks that allows for custom implementations. |
111+
| [**Managing dataplane secrets**]({{< relref "secrets" >}}) | Managing dataplane secrets in Azure Service Operator, including the drawbacks of auto-generating secrets and the implications for secret rollover, control, security, resource adoption, and GitOps compatibility. |
112+
| [**Reporting Resource Status**]({{< relref "resource-states" >}}) | A proposal for reporting resource status in Azure Service Operator, discussing the distinction between operator status and Azure resource state, and the current state and limitations of both handcrafted and auto-generated resources. |
113+
| [**Type References and Ownership**]({{< relref "type-references-and-ownership" >}}) | type references and ownership in Azure Service Operator, discussing goals such as idiomatic expression of Azure resource relationships, automatic ownership, garbage collection, and interaction with non-Kubernetes managed Azure resources. |
109114

110115
## Format
111116

0 commit comments

Comments
 (0)