You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "vincbeck (via GitHub)" <gi...@apache.org> on 2024/02/13 22:36:16 UTC
[PR] Create CLI commands for AWS auth manager to create AWS Identity Center related resources [airflow]
vincbeck opened a new pull request, #37407:
URL: https://github.com/apache/airflow/pull/37407
<!--
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/
-->
<!-- 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] Create CLI commands for AWS auth manager to create AWS Identity Center related resources [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck merged PR #37407:
URL: https://github.com/apache/airflow/pull/37407
--
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] Create CLI commands for AWS auth manager to create AWS Identity Center related resources [airflow]
Posted by "Lee-W (via GitHub)" <gi...@apache.org>.
Lee-W commented on code in PR #37407:
URL: https://github.com/apache/airflow/pull/37407#discussion_r1489024920
##########
airflow/providers/amazon/aws/auth_manager/cli/idc_commands.py:
##########
@@ -0,0 +1,148 @@
+# 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.
+"""User sub-commands."""
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING
+
+import boto3
+from botocore.exceptions import ClientError
+
+from airflow.configuration import conf
+from airflow.exceptions import AirflowOptionalProviderFeatureException
+from airflow.providers.amazon.aws.auth_manager.constants import CONF_REGION_NAME_KEY, CONF_SECTION_NAME
+from airflow.utils import cli as cli_utils
+
+try:
+ from airflow.utils.providers_configuration_loader import providers_configuration_loaded
+except ImportError:
+ raise AirflowOptionalProviderFeatureException(
+ "Failed to import avp_commands. This feature is only available in Airflow "
+ "version >= 2.8.0 where Auth Managers are introduced."
+ )
+
+if TYPE_CHECKING:
+ from botocore.client import BaseClient
+
+log = logging.getLogger(__name__)
+
+
+@cli_utils.action_cli
+@providers_configuration_loaded
+def init_idc(args):
+ """Initialize AWS IAM Identity Center resources."""
+ client = _get_client()
+
+ # Create the instance if needed
+ instance_arn = _create_instance(client, args)
+
+ # Create the application if needed
+ _create_application(client, instance_arn, args)
+
+ if not args.dry_run:
+ print("AWS IAM Identity Center resources created successfully.")
+
+
+def _get_client():
+ """Return AWS IAM Identity Center client."""
+ region_name = conf.get(CONF_SECTION_NAME, CONF_REGION_NAME_KEY)
+ return boto3.client("sso-admin", region_name=region_name)
+
+
+def _create_instance(client: BaseClient, args) -> str | None:
+ """Create if needed AWS IAM Identity Center instance."""
+ instances = client.list_instances()
+
+ if args.verbose:
+ log.debug("Instances found: %s", instances)
+
+ if len(instances["Instances"]) > 0:
+ print(
+ f"There is already an instance configured in AWS IAM Identity Center: '{instances['Instances'][0]['InstanceArn']}'. "
+ f"No need to create a new one."
+ )
+ return instances["Instances"][0]["InstanceArn"]
+ else:
+ print("No instance configured in AWS IAM Identity Center, creating one.")
+ if args.dry_run:
+ print("Dry run, not creating the instance.")
+ return None
+
+ response = client.create_instance(Name=args.instance_name)
+ if args.verbose:
+ log.debug("Response from create_instance: %s", response)
+
+ print(f"Instance created: '{response['InstanceArn']}'")
+
+ return response["InstanceArn"]
+
+
+def _create_application(client: BaseClient, instance_arn: str | None, args) -> str | None:
+ """Create if needed AWS IAM identity Center application."""
+ paginator = client.get_paginator("list_applications")
+ pages = paginator.paginate(InstanceArn=instance_arn or "")
+ applications = [application for page in pages for application in page["Applications"]]
+ existing_applications = [
+ application for application in applications if application["Name"] == args.application_name
+ ]
+
+ if args.verbose:
+ log.debug("Applications found: %s", applications)
+ log.debug("Existing applications found: %s", existing_applications)
+
+ if len(existing_applications) > 0:
+ print(
+ f"There is already an application named '{args.application_name}' in AWS IAM Identity Center: '{existing_applications[0]['ApplicationArn']}'. "
+ f"Using this application."
Review Comment:
```suggestion
"Using this application."
```
##########
airflow/providers/amazon/aws/auth_manager/cli/idc_commands.py:
##########
@@ -0,0 +1,148 @@
+# 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.
+"""User sub-commands."""
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING
+
+import boto3
+from botocore.exceptions import ClientError
+
+from airflow.configuration import conf
+from airflow.exceptions import AirflowOptionalProviderFeatureException
+from airflow.providers.amazon.aws.auth_manager.constants import CONF_REGION_NAME_KEY, CONF_SECTION_NAME
+from airflow.utils import cli as cli_utils
+
+try:
+ from airflow.utils.providers_configuration_loader import providers_configuration_loaded
+except ImportError:
+ raise AirflowOptionalProviderFeatureException(
+ "Failed to import avp_commands. This feature is only available in Airflow "
+ "version >= 2.8.0 where Auth Managers are introduced."
+ )
+
+if TYPE_CHECKING:
+ from botocore.client import BaseClient
+
+log = logging.getLogger(__name__)
+
+
+@cli_utils.action_cli
+@providers_configuration_loaded
+def init_idc(args):
+ """Initialize AWS IAM Identity Center resources."""
+ client = _get_client()
+
+ # Create the instance if needed
+ instance_arn = _create_instance(client, args)
+
+ # Create the application if needed
+ _create_application(client, instance_arn, args)
+
+ if not args.dry_run:
+ print("AWS IAM Identity Center resources created successfully.")
+
+
+def _get_client():
+ """Return AWS IAM Identity Center client."""
+ region_name = conf.get(CONF_SECTION_NAME, CONF_REGION_NAME_KEY)
+ return boto3.client("sso-admin", region_name=region_name)
+
+
+def _create_instance(client: BaseClient, args) -> str | None:
+ """Create if needed AWS IAM Identity Center instance."""
+ instances = client.list_instances()
+
+ if args.verbose:
+ log.debug("Instances found: %s", instances)
+
+ if len(instances["Instances"]) > 0:
+ print(
+ f"There is already an instance configured in AWS IAM Identity Center: '{instances['Instances'][0]['InstanceArn']}'. "
+ f"No need to create a new one."
Review Comment:
```suggestion
"No need to create a new one."
```
--
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