You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "mewa (via GitHub)" <gi...@apache.org> on 2024/02/06 12:09:10 UTC

[PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

mewa opened a new pull request, #37197:
URL: https://github.com/apache/airflow/pull/37197

   Currently, when deploying multiple releases that share the same release name in **different** namespaces deployment is failing due to a naming clash of the cluster-scoped RBAC resources.
   
   This PR introduces changes that make sure that `ClusterRole`s and `ClusterRoleBinding`s are uniquely named according to both the release name, as well as the release namespace, thus solving the naming clash.
   
   ---
   
   Steps to reproduce current behavior:
   1. Create namespace `airflow-a`
   2. Install helm chart release named `airflow` into namespace `airflow-a` with `multiNamespaceMode: true`
   3. Create namespace `airflow-b`
   4. Install helm chart release named `airflow` into namespace `airflow-b` with `multiNamespaceMode: true`
   5. Installing the helm chart will fail due to a naming clash of the cluster-wide RBAC resources
   
   <!--
    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.
    -->
   
   <!--
   Thank you for contributing! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of an existing issue, reference it using one of the following:
   
   closes: #ISSUE
   related: #ISSUE
   
   How to write a good git commit message:
   http://chris.beams.io/posts/git-commit/
   -->
   
   ---
   
   Related: #31613 (closed, resubmitting with updated tests)
   
   <!-- Please keep an empty line above the dashes. -->
   ---
   **^ Add meaningful description above**
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
   In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
   


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "mewa (via GitHub)" <gi...@apache.org>.
mewa commented on PR #37197:
URL: https://github.com/apache/airflow/pull/37197#issuecomment-1938574780

   @amoghrajesh It already defaults to `false`
   
   https://github.com/apache/airflow/blob/4c3732850f5f1c640eefad7f1bc7dbc80c6b76f9/chart/values.yaml#L2389-L2391


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on code in PR #37197:
URL: https://github.com/apache/airflow/pull/37197#discussion_r1508171095


##########
helm_tests/airflow_aux/test_pod_launcher_role.py:
##########
@@ -49,3 +49,69 @@ def test_pod_launcher_role(self, executor, rbac, allow, expected_accounts):
                 assert f"release-name-airflow-{suffix}" == jmespath.search(f"subjects[{idx}].name", docs[0])
         else:
             assert [] == docs
+
+    @pytest.mark.parametrize(
+        "multiNamespaceMode, namespace, expectedRole, expectedRoleBinding",
+        [
+            (
+                True,
+                "namespace",
+                "release-name-namespace-pod-launcher-role",
+                "release-name-namespace-pod-launcher-rolebinding",
+            ),
+            (
+                True,
+                "other-ns",
+                "release-name-other-ns-pod-launcher-role",
+                "release-name-other-ns-pod-launcher-rolebinding",
+            ),
+            (False, "namespace", "release-name-pod-launcher-role", "release-name-pod-launcher-rolebinding"),
+        ],
+    )
+    def test_pod_launcher_rolebinding_multi_namespace(
+        self, multiNamespaceMode, namespace, expectedRole, expectedRoleBinding
+    ):
+        docs = render_chart(
+            namespace=namespace,
+            values={"webserver": {"allowPodLogReading": True}, "multiNamespaceMode": multiNamespaceMode},
+            show_only=["templates/rbac/pod-launcher-rolebinding.yaml"],
+        )
+
+        actualRoleBinding = jmespath.search("metadata.name", docs[0]) if docs else []

Review Comment:
   ```suggestion
           actualRoleBinding = jmespath.search("metadata.name", docs[0])
   ```
   
   Why an empty list? I don't think we need to really check docs first though. My 2c.



##########
chart/templates/rbac/pod-launcher-role.yaml:
##########
@@ -28,15 +28,20 @@ kind: ClusterRole
 kind: Role
 {{- end }}
 metadata:
-  name: {{ include "airflow.fullname" . }}-pod-launcher-role
   {{- if not .Values.multiNamespaceMode }}
+  name: {{ include "airflow.fullname" . }}-pod-launcher-role
   namespace: "{{ .Release.Namespace }}"
+  {{- else }}
+  name: {{ include "airflow.fullname" . }}-{{ .Release.Namespace }}-pod-launcher-role

Review Comment:
   Anyone have thoughts on namespace first?



-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #37197:
URL: https://github.com/apache/airflow/pull/37197#issuecomment-1998563371

   Ah... We already had a lot of eyes I see..


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on PR #37197:
URL: https://github.com/apache/airflow/pull/37197#issuecomment-1929422770

   Multinamespace is not yet fully supported. It should be added with https://github.com/apache/airflow/pull/35639


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham merged PR #37197:
URL: https://github.com/apache/airflow/pull/37197


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on PR #37197:
URL: https://github.com/apache/airflow/pull/37197#issuecomment-2012482024

   Thanks @mewa! Congrats on your first commit 🍺


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on PR #37197:
URL: https://github.com/apache/airflow/pull/37197#issuecomment-1945461877

   Static checks are failing


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "mewa (via GitHub)" <gi...@apache.org>.
mewa commented on code in PR #37197:
URL: https://github.com/apache/airflow/pull/37197#discussion_r1512890838


##########
helm_tests/airflow_aux/test_pod_launcher_role.py:
##########
@@ -49,3 +49,69 @@ def test_pod_launcher_role(self, executor, rbac, allow, expected_accounts):
                 assert f"release-name-airflow-{suffix}" == jmespath.search(f"subjects[{idx}].name", docs[0])
         else:
             assert [] == docs
+
+    @pytest.mark.parametrize(
+        "multiNamespaceMode, namespace, expectedRole, expectedRoleBinding",
+        [
+            (
+                True,
+                "namespace",
+                "release-name-namespace-pod-launcher-role",
+                "release-name-namespace-pod-launcher-rolebinding",
+            ),
+            (
+                True,
+                "other-ns",
+                "release-name-other-ns-pod-launcher-role",
+                "release-name-other-ns-pod-launcher-rolebinding",
+            ),
+            (False, "namespace", "release-name-pod-launcher-role", "release-name-pod-launcher-rolebinding"),
+        ],
+    )
+    def test_pod_launcher_rolebinding_multi_namespace(
+        self, multiNamespaceMode, namespace, expectedRole, expectedRoleBinding
+    ):
+        docs = render_chart(
+            namespace=namespace,
+            values={"webserver": {"allowPodLogReading": True}, "multiNamespaceMode": multiNamespaceMode},
+            show_only=["templates/rbac/pod-launcher-rolebinding.yaml"],
+        )
+
+        actualRoleBinding = jmespath.search("metadata.name", docs[0]) if docs else []

Review Comment:
   Good catch. I cleaned up unnecessary checks.



-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "mewa (via GitHub)" <gi...@apache.org>.
mewa commented on code in PR #37197:
URL: https://github.com/apache/airflow/pull/37197#discussion_r1512930492


##########
chart/templates/rbac/pod-launcher-role.yaml:
##########
@@ -28,15 +28,20 @@ kind: ClusterRole
 kind: Role
 {{- end }}
 metadata:
-  name: {{ include "airflow.fullname" . }}-pod-launcher-role
   {{- if not .Values.multiNamespaceMode }}
+  name: {{ include "airflow.fullname" . }}-pod-launcher-role
   namespace: "{{ .Release.Namespace }}"
+  {{- else }}
+  name: {{ include "airflow.fullname" . }}-{{ .Release.Namespace }}-pod-launcher-role

Review Comment:
   I don't have strong opinions on this. I feel like labels should be the default way to interact with objects anyway (especially past a point where this starts to matter). But I guess it does make sense to have it grouped by namespace, so let's just change it.



-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "mewa (via GitHub)" <gi...@apache.org>.
mewa commented on PR #37197:
URL: https://github.com/apache/airflow/pull/37197#issuecomment-1953821232

   I updated the newsfragment to satisfy the checks. I also moved it to significant type since it involves renaming of the resources.


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #37197:
URL: https://github.com/apache/airflow/pull/37197#issuecomment-2012472896

   Awesome work, congrats on your first merged pull request! You are invited to check our [Issue Tracker](https://github.com/apache/airflow/issues) for additional contributions.
   


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Chart: Fix cluster-wide RBAC naming clash when using multiple multiNamespace releases with the same name [airflow]

Posted by "mewa (via GitHub)" <gi...@apache.org>.
mewa commented on PR #37197:
URL: https://github.com/apache/airflow/pull/37197#issuecomment-1929462024

   > Multinamespace is not yet fully supported. It should be added with #35639
   
   I took a quick look at it and they seem to support different scenarios. I believe the above PR means to introduce fine-grained RBAC controls when using `multiNamespaceMode`, to have better control over security when deploying a single Airflow instance to run workloads across multiple namespaces.
   
   Whereas, this PR fixes the behaviour with the existing `multiNamespaceMode` where it's only possible to have a single such deployment per cluster. The scenario here is to have multiple Airflow instances (in different namespaces), each of which runs workloads across multiple namespaces.


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org