flytekitplugins-awsemrserverless 1.16.26__tar.gz

flytekitplugins_awsemrserverless-1.16.26/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: flytekitplugins-awsemrserverless
+Version: 1.16.26
+Summary: Flytekit AWS EMR Serverless Plugin: run Spark and Hive jobs from Flyte tasks
+Author: flyteorg
+Author-email: admin@flyte.org
+License: apache2
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: flytekit>=1.14.6
+Requires-Dist: aioboto3>=12.3.0
+Requires-Dist: boto3>=1.28.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Flytekit AWS EMR Serverless Plugin
+
+A Flyte connector for [AWS EMR Serverless](https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/emr-serverless.html) that submits Spark and Hive jobs to an EMR Serverless application and tracks them through to completion.
+
+## Features
+
+- **Pythonic Spark mode**: write a Flyte `@task` whose body is regular PySpark; the plugin packages the user code, uploads it to S3, and runs it on EMR Serverless. No long-lived cluster to manage.
+- **Script Spark mode**: point at an existing `main.py` (or JAR) already in S3 and submit it directly.
+- **Hive mode**: submit a Hive query (inline or from S3) against an EMR Serverless application configured for Hive.
+- Async connector lifecycle (`create` / `get` / `delete`) so the connector pod stays light and many jobs can be tracked concurrently.
+- Honours Flyte task retries, timeouts, and cancellation, and surfaces EMR Serverless logs through the Flyte UI when log URIs are available.
+
+## Installation
+
+```bash
+pip install flytekitplugins-awsemrserverless
+```
+
+The connector is registered automatically with `flytekit` via the plugin entry point. Deploy it on a [`flyteconnector`](https://github.com/flyteorg/flyte/tree/master/charts/flyteconnector) pod that has this package installed and an IAM identity allowed to call EMR Serverless `StartJobRun` / `GetJobRun` / `CancelJobRun` and to read/write the script-staging S3 prefix.
+
+## Usage
+
+### Pythonic Spark task
+
+```python
+from flytekit import task, workflow
+from flytekitplugins.awsemrserverless import EMRServerless, EMRServerlessSparkJobDriver
+
+
+@task(
+    task_config=EMRServerless(
+        application_id="00fhabc12345",
+        execution_role_arn="arn:aws:iam::123456789012:role/EMRServerlessRole",
+        region="us-east-1",
+        job_driver=EMRServerlessSparkJobDriver(
+            spark_submit_parameters="--conf spark.executor.cores=2 --conf spark.executor.memory=4g",
+        ),
+    ),
+)
+def spark_count() -> int:
+    from pyspark.sql import SparkSession
+
+    spark = SparkSession.builder.getOrCreate()
+    return spark.range(1_000_000).count()
+
+
+@workflow
+def wf() -> int:
+    return spark_count()
+```
+
+The plugin serializes the task body, uploads it to S3, and EMR Serverless runs it inside the worker image you have associated with the application.
+
+### Script Spark task
+
+```python
+@task(
+    task_config=EMRServerless(
+        application_id="00fhabc12345",
+        execution_role_arn="arn:aws:iam::123456789012:role/EMRServerlessRole",
+        region="us-east-1",
+        job_driver=EMRServerlessSparkJobDriver(
+            entry_point="s3://my-bucket/scripts/main.py",
+            entry_point_arguments=["--date", "2025-01-01"],
+            spark_submit_parameters="--conf spark.executor.memory=4g",
+        ),
+    ),
+)
+def submit_script():
+    ...
+```
+
+### Hive task
+
+```python
+from flytekitplugins.awsemrserverless import EMRServerless, EMRServerlessHiveJobDriver
+
+
+@task(
+    task_config=EMRServerless(
+        application_id="00fhabc12345",
+        execution_role_arn="arn:aws:iam::123456789012:role/EMRServerlessRole",
+        region="us-east-1",
+        job_driver=EMRServerlessHiveJobDriver(
+            query="SELECT COUNT(*) FROM my_table",
+        ),
+    ),
+)
+def hive_query():
+    ...
+```
+
+## Worker image
+
+For Pythonic Spark tasks the worker image must contain `flytekit` and this plugin so the executor can rehydrate the task object on the EMR Serverless side. Script Spark and Hive jobs do not require flytekit on the worker.
+
+A reference `Dockerfile` is shipped alongside this plugin; it builds on the public EMR Serverless Spark base image and installs the matching `flytekit` and `flytekitplugins-awsemrserverless` versions:
+
+```bash
+docker build \
+  --build-arg VERSION=<flytekit-version> \
+  -t <registry>/emr-serverless-flytekit:<tag> \
+  plugins/flytekit-aws-emr-serverless
+```
+
+Override the base with `--build-arg EMR_BASE_IMAGE=...` to track a different EMR release.
+
+## IAM
+
+The connector pod's IAM principal needs:
+
+- `emr-serverless:StartJobRun`, `emr-serverless:GetJobRun`, `emr-serverless:CancelJobRun` on the target application
+- `s3:GetObject` / `s3:PutObject` on the script-staging prefix (Pythonic mode)
+- `iam:PassRole` for the EMR Serverless execution role
+
+The execution role attached to the EMR Serverless application is the role the workers run as and needs whatever data-access permissions your jobs require.
+
+## Discussion
+
+Tracking issue: [flyteorg/flyte#7286](https://github.com/flyteorg/flyte/issues/7286).

flytekitplugins_awsemrserverless-1.16.26/README.md

@@ -0,0 +1,120 @@
+# Flytekit AWS EMR Serverless Plugin
+
+A Flyte connector for [AWS EMR Serverless](https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/emr-serverless.html) that submits Spark and Hive jobs to an EMR Serverless application and tracks them through to completion.
+
+## Features
+
+- **Pythonic Spark mode**: write a Flyte `@task` whose body is regular PySpark; the plugin packages the user code, uploads it to S3, and runs it on EMR Serverless. No long-lived cluster to manage.
+- **Script Spark mode**: point at an existing `main.py` (or JAR) already in S3 and submit it directly.
+- **Hive mode**: submit a Hive query (inline or from S3) against an EMR Serverless application configured for Hive.
+- Async connector lifecycle (`create` / `get` / `delete`) so the connector pod stays light and many jobs can be tracked concurrently.
+- Honours Flyte task retries, timeouts, and cancellation, and surfaces EMR Serverless logs through the Flyte UI when log URIs are available.
+
+## Installation
+
+```bash
+pip install flytekitplugins-awsemrserverless
+```
+
+The connector is registered automatically with `flytekit` via the plugin entry point. Deploy it on a [`flyteconnector`](https://github.com/flyteorg/flyte/tree/master/charts/flyteconnector) pod that has this package installed and an IAM identity allowed to call EMR Serverless `StartJobRun` / `GetJobRun` / `CancelJobRun` and to read/write the script-staging S3 prefix.
+
+## Usage
+
+### Pythonic Spark task
+
+```python
+from flytekit import task, workflow
+from flytekitplugins.awsemrserverless import EMRServerless, EMRServerlessSparkJobDriver
+
+
+@task(
+    task_config=EMRServerless(
+        application_id="00fhabc12345",
+        execution_role_arn="arn:aws:iam::123456789012:role/EMRServerlessRole",
+        region="us-east-1",
+        job_driver=EMRServerlessSparkJobDriver(
+            spark_submit_parameters="--conf spark.executor.cores=2 --conf spark.executor.memory=4g",
+        ),
+    ),
+)
+def spark_count() -> int:
+    from pyspark.sql import SparkSession
+
+    spark = SparkSession.builder.getOrCreate()
+    return spark.range(1_000_000).count()
+
+
+@workflow
+def wf() -> int:
+    return spark_count()
+```
+
+The plugin serializes the task body, uploads it to S3, and EMR Serverless runs it inside the worker image you have associated with the application.
+
+### Script Spark task
+
+```python
+@task(
+    task_config=EMRServerless(
+        application_id="00fhabc12345",
+        execution_role_arn="arn:aws:iam::123456789012:role/EMRServerlessRole",
+        region="us-east-1",
+        job_driver=EMRServerlessSparkJobDriver(
+            entry_point="s3://my-bucket/scripts/main.py",
+            entry_point_arguments=["--date", "2025-01-01"],
+            spark_submit_parameters="--conf spark.executor.memory=4g",
+        ),
+    ),
+)
+def submit_script():
+    ...
+```
+
+### Hive task
+
+```python
+from flytekitplugins.awsemrserverless import EMRServerless, EMRServerlessHiveJobDriver
+
+
+@task(
+    task_config=EMRServerless(
+        application_id="00fhabc12345",
+        execution_role_arn="arn:aws:iam::123456789012:role/EMRServerlessRole",
+        region="us-east-1",
+        job_driver=EMRServerlessHiveJobDriver(
+            query="SELECT COUNT(*) FROM my_table",
+        ),
+    ),
+)
+def hive_query():
+    ...
+```
+
+## Worker image
+
+For Pythonic Spark tasks the worker image must contain `flytekit` and this plugin so the executor can rehydrate the task object on the EMR Serverless side. Script Spark and Hive jobs do not require flytekit on the worker.
+
+A reference `Dockerfile` is shipped alongside this plugin; it builds on the public EMR Serverless Spark base image and installs the matching `flytekit` and `flytekitplugins-awsemrserverless` versions:
+
+```bash
+docker build \
+  --build-arg VERSION=<flytekit-version> \
+  -t <registry>/emr-serverless-flytekit:<tag> \
+  plugins/flytekit-aws-emr-serverless
+```
+
+Override the base with `--build-arg EMR_BASE_IMAGE=...` to track a different EMR release.
+
+## IAM
+
+The connector pod's IAM principal needs:
+
+- `emr-serverless:StartJobRun`, `emr-serverless:GetJobRun`, `emr-serverless:CancelJobRun` on the target application
+- `s3:GetObject` / `s3:PutObject` on the script-staging prefix (Pythonic mode)
+- `iam:PassRole` for the EMR Serverless execution role
+
+The execution role attached to the EMR Serverless application is the role the workers run as and needs whatever data-access permissions your jobs require.
+
+## Discussion
+
+Tracking issue: [flyteorg/flyte#7286](https://github.com/flyteorg/flyte/issues/7286).

flytekitplugins_awsemrserverless-1.16.26/flytekitplugins/awsemrserverless/__init__.py

@@ -0,0 +1,29 @@
+"""
+.. currentmodule:: flytekitplugins.awsemrserverless
+
+This plugin enables running Spark and Hive jobs on AWS EMR Serverless from
+Flyte workflows.  It exposes an async connector that handles the EMR
+Serverless job lifecycle (submit, poll, cancel) and a task config type.
+
+.. autosummary::
+   :template: custom.rst
+   :toctree: generated/
+
+   EMRServerless
+   EMRServerlessSparkJobDriver
+   EMRServerlessHiveJobDriver
+   EMRServerlessTask
+   EMRServerlessConnector
+   EMRServerlessJobMetadata
+"""
+
+from flytekitplugins.awsemrserverless.connector import (
+    EMRServerlessConnector,
+    EMRServerlessJobMetadata,
+)
+from flytekitplugins.awsemrserverless.task import (
+    EMRServerless,
+    EMRServerlessHiveJobDriver,
+    EMRServerlessSparkJobDriver,
+    EMRServerlessTask,
+)

flytekitplugins_awsemrserverless-1.16.26/flytekitplugins/awsemrserverless/_entrypoint.py

@@ -0,0 +1,203 @@
+"""
+EMR Serverless Pythonic-mode entrypoint script.
+
+This file is the canonical source of the bootstrap script that EMR
+Serverless workers execute as ``sparkSubmit.entryPoint`` for Pythonic
+tasks (i.e. tasks that do not provide an explicit ``spark_job_driver``).
+
+How it is delivered to EMR
+--------------------------
+
+The connector pod:
+
+1. reads this file from its own ``site-packages`` install;
+2. computes ``hashlib.sha256(content)[:12]`` and uploads (idempotently)
+   to ``s3://<bucket>/flyte/emr-serverless/entrypoint-<hash>.py``;
+3. passes that S3 URI as ``StartJobRun.jobDriver.sparkSubmit.entryPoint``.
+
+EMR Serverless then downloads this script onto the Spark driver and
+runs it with ``spark-submit``.  ``sys.argv[1:]`` carries the actual
+``pyflyte-fast-execute`` (or ``pyflyte-execute``) invocation that
+should run inside the worker, plus the fast-registration distribution
+arguments.
+
+Why a custom entrypoint at all
+------------------------------
+
+EMR Serverless's API requires ``sparkSubmit.entryPoint`` to be a
+single Python file URI -- there is no "container as entrypoint"
+escape hatch (cf. SageMaker / Batch / ECS, which run the container
+itself).  We need a thin shim that:
+
+* downloads the fast-registration tarball from Flyte's blob store,
+* invokes ``pyflyte-fast-execute`` with the right resolver arguments,
+* converts Flytekit's "exit-0-on-user-error" semantics into a non-zero
+  exit so EMR reports ``FAILED`` instead of ``SUCCESS``.
+
+This file deliberately has only ``flytekit`` as a runtime dependency
+(specifically ``flytekit.tools.fast_registration.download_distribution``)
+because it runs *inside the EMR worker*, not the connector pod.
+
+Editing this file
+-----------------
+
+Treat this file as part of the connector's *runtime contract* with
+EMR workers, not as plugin internals:
+
+* changes here propagate to every Pythonic-mode job on the next
+  connector deploy via the content hash in the S3 key;
+* the corresponding unit tests live in ``tests/test_entrypoint.py``
+  and exercise this module both as imported Python and as the
+  spawned subprocess EMR sees;
+* upstream alignment: this is the EMR analogue of
+  ``flytetools/flytekitplugins/databricks/entrypoint.py`` --
+  same shape, different transport (S3 instead of GitHub).
+"""
+
+import os
+import signal
+import subprocess
+import sys
+
+from flytekit.tools.fast_registration import download_distribution
+
+
+def _run_subprocess(cmd, env=None):
+    """Run ``cmd`` and forward SIGTERM, returning ``(returncode, stderr_text)``.
+
+    stdout streams through to the parent (Spark driver stdout); stderr is
+    captured so the caller can inspect it for Flytekit's user-error banner.
+    """
+    p = subprocess.Popen(cmd, env=env, stderr=subprocess.PIPE, stdout=None)
+    signal.signal(signal.SIGTERM, lambda s, f: p.send_signal(s))
+    _, stderr_bytes = p.communicate()
+    stderr_text = stderr_bytes.decode("utf-8", errors="replace") if stderr_bytes else ""
+    if stderr_text:
+        sys.stderr.write(stderr_text)
+    return p.returncode, stderr_text
+
+
+def _exit_with_code(rc, stderr_text=""):
+    """Translate Flytekit subprocess exit semantics into EMR-correct exits.
+
+    Flytekit's ``pyflyte-execute`` catches user exceptions, writes the
+    error to the Flyte output blob, and exits ``0`` -- by design for
+    K8s-based agents where FlytePropeller reads the output.
+
+    In EMR Serverless the connector only polls EMR job state
+    (``SUCCESS`` / ``FAILED``) and cannot read the output blobs.  If
+    ``pyflyte-execute`` exits ``0`` but the user function failed, EMR
+    reports ``SUCCESS`` and the connector wrongly reports ``SUCCEEDED``.
+
+    Detect this by scanning stderr for Flytekit's error banner.  When
+    found, force a non-zero exit so Spark fails the driver and EMR
+    reports ``FAILED``.
+    """
+    if rc == 0 and "User Error Captured by Flyte" in stderr_text:
+        print(
+            "[flyte-entrypoint] pyflyte-execute exited 0 but stderr contains "
+            "a user error -- forcing non-zero exit so EMR reports FAILED",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+    if rc != 0:
+        print(f"[flyte-entrypoint] Task process exited with code {rc}", file=sys.stderr)
+    sys.exit(rc)
+
+
+def _parse_fast_execute_args(args):
+    """Split a ``pyflyte-fast-execute ...`` argv into its three pieces.
+
+    Returns ``(additional_distribution, dest_dir, task_cmd_start)``
+    where ``task_cmd_start`` is the index in ``args`` where the
+    underlying ``pyflyte-execute ...`` command begins.
+
+    Recognises the two-arg flag forms emitted by Flytekit:
+      ``--additional-distribution <s3://...>``
+      ``--dest-dir <path>``
+    and the optional ``--`` separator before the inner command.
+    """
+    additional_distribution = None
+    dest_dir = None
+    task_cmd_start = 0
+
+    i = 1
+    while i < len(args):
+        if args[i] == "--additional-distribution" and i + 1 < len(args):
+            additional_distribution = args[i + 1]
+            i += 2
+        elif args[i] == "--dest-dir" and i + 1 < len(args):
+            dest_dir = args[i + 1]
+            i += 2
+        elif args[i] == "--":
+            task_cmd_start = i + 1
+            break
+        else:
+            task_cmd_start = i
+            break
+
+    return additional_distribution, dest_dir, task_cmd_start
+
+
+def _build_resolver_command(task_execute_cmd, additional_distribution, dest_dir):
+    """Inject the fast-registration distribution args before ``--resolver``.
+
+    ``pyflyte-execute`` resolves task callables via a resolver plugin
+    (default ``flytekit.core.python_auto_container.default_task_resolver``).
+    For fast-registered code, the resolver needs to know where the
+    extracted source tree lives, which we inject as
+    ``--dynamic-addl-distro`` / ``--dynamic-dest-dir`` immediately
+    before ``--resolver``.
+    """
+    cmd = []
+    for arg in task_execute_cmd:
+        if arg == "--resolver":
+            cmd.extend(
+                [
+                    "--dynamic-addl-distro",
+                    additional_distribution or "",
+                    "--dynamic-dest-dir",
+                    dest_dir or "",
+                ]
+            )
+        cmd.append(arg)
+    return cmd
+
+
+def main():
+    args = sys.argv[1:]
+    if not args:
+        print("Usage: entrypoint.py pyflyte-fast-execute|pyflyte-execute ...", file=sys.stderr)
+        sys.exit(1)
+
+    if args[0] == "pyflyte-fast-execute":
+        additional_distribution, dest_dir, task_cmd_start = _parse_fast_execute_args(args)
+        task_execute_cmd = list(args[task_cmd_start:])
+
+        if additional_distribution:
+            if not dest_dir:
+                dest_dir = os.getcwd()
+            download_distribution(additional_distribution, dest_dir)
+
+        cmd = _build_resolver_command(task_execute_cmd, additional_distribution, dest_dir)
+
+        env = os.environ.copy()
+        if dest_dir:
+            resolved = os.path.realpath(os.path.expanduser(dest_dir))
+            env["PYTHONPATH"] = resolved + os.pathsep + env.get("PYTHONPATH", "")
+        rc, stderr_text = _run_subprocess(cmd, env)
+        _exit_with_code(rc, stderr_text)
+
+    elif args[0] == "pyflyte-execute":
+        env = os.environ.copy()
+        env.setdefault("PYTHONPATH", os.getcwd())
+        rc, stderr_text = _run_subprocess(args, env)
+        _exit_with_code(rc, stderr_text)
+
+    else:
+        print(f"Unrecognized command: {args}", file=sys.stderr)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()