bugraoz93 commented on code in PR #65897: URL: https://github.com/apache/airflow/pull/65897#discussion_r3157549154
########## chart/kustomize-overlays/CONTRIBUTING.rst: ########## @@ -0,0 +1,156 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Contributing Kustomize Overlays +=============================== + +This document is the authoritative reference for adding, evolving, and +retiring overlays under ``chart/kustomize-overlays/``. + +Why this directory exists +------------------------- + +The Airflow Helm chart has historically carried components that are not +Airflow-native. They make the chart heavier than it needs to be and pull +maintenance toward things that already have external owners. Expressing +these components as Kustomize overlays keeps the chart focused on Airflow +itself while still giving users a working starting point for the rest. + +The chart never removes a component without a working overlay already in +place. Users always have a migration path before anything disappears. + +Criteria for chart vs Kustomize +------------------------------- + +A component **belongs in the chart** when all of the following are true: + +* It is required to run Airflow (scheduler, API server, dag-processor, + triggerer, workers). +* Removing it requires changes to Airflow's own configuration. +* It has no external owner. + +A component **belongs in Kustomize** when any of the following are true: + +* It can be expressed as a standalone Kubernetes resource without modifying + chart-rendered resources. +* It is environment-specific (authentication schemes, logging backends, + autoscaling controllers). +* It has an external owner (KEDA, Elasticsearch, any PostgreSQL distribution). +* It requires CRDs that the chart does not install. + +If a component qualifies for Kustomize but no overlay exists yet, it stays in +the chart until the overlay is in place and verified. + +Overlay structure +----------------- + +Each overlay directory must contain: + +* ``kustomization.yaml`` - the Kustomize entry point. +* The Kubernetes resources the overlay produces. +* ``STATUS`` - a small YAML document declaring the verification state. +* ``README.rst`` - usage instructions and a migration guide from the + equivalent chart-side configuration. + +STATUS file format +------------------ + +The ``STATUS`` file is a small YAML document with the following fields. Review Comment: Added Pydantic validation to the same structure validation script, which is self-contained and should already be easy to maintain. This may not be the same with the provider schema, but it should work. Please let me know if -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
