blob: 5e392dd18ddc55aec5131563470a674b82488d19 [file] [log] [blame]
Search.setIndex({"docnames": ["_api/airflow/providers/apache/flink/hooks/index", "_api/airflow/providers/apache/flink/index", "_api/airflow/providers/apache/flink/operators/flink_kubernetes/index", "_api/airflow/providers/apache/flink/operators/index", "_api/airflow/providers/apache/flink/sensors/flink_kubernetes/index", "_api/airflow/providers/apache/flink/sensors/index", "commits", "index", "installing-providers-from-sources", "operators"], "filenames": ["_api/airflow/providers/apache/flink/hooks/index.rst", "_api/airflow/providers/apache/flink/index.rst", "_api/airflow/providers/apache/flink/operators/flink_kubernetes/index.rst", "_api/airflow/providers/apache/flink/operators/index.rst", "_api/airflow/providers/apache/flink/sensors/flink_kubernetes/index.rst", "_api/airflow/providers/apache/flink/sensors/index.rst", "commits.rst", "index.rst", "installing-providers-from-sources.rst", "operators.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.apache.flink.hooks</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.apache.flink</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.apache.flink.operators.flink_kubernetes</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.apache.flink.operators</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.apache.flink.sensors.flink_kubernetes</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.apache.flink.sensors</span></code>", "Package apache-airflow-providers-apache-flink", "<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-apache-flink</span></code>", "Installing from sources", "Apache Flink Operators"], "terms": {"1": [0, 1, 2, 3, 4, 5, 8, 9], "0": [0, 1, 2, 3, 4, 5, 8, 9], "2": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "7": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "dev0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "an": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "experiment": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "featur": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "hook": [1, 2], "oper": [1, 4, 6, 7], "flink_kubernet": [1, 3, 5], "sensor": 1, "__version__": [1, 6], "sourc": [1, 2, 4, 7], "flinkkubernetesoper": 2, "application_fil": 2, "namespac": [2, 4], "none": [2, 4, 8], "kubernetes_conn_id": [2, 4], "kubernetes_default": [2, 4], "api_group": [2, 4], "org": [2, 4, 8], "api_vers": [2, 4], "v1beta1": [2, 4], "in_clust": 2, "cluster_context": 2, "config_fil": 2, "plural": [2, 4], "flinkdeploy": [2, 4], "kwarg": [2, 4], "base": [2, 4], "model": 2, "baseoper": 2, "creat": [2, 8], "object": [2, 4], "kubernet": [2, 4, 6, 7, 9], "cluster": [2, 4, 9], "For": [2, 4, 6, 7, 8, 9], "more": [2, 4, 6], "inform": [2, 6, 9], "how": [2, 8], "us": [2, 6, 7, 8], "take": [2, 9], "look": [2, 4, 9], "guid": [2, 8], "detail": [2, 4, 6, 7, 8], "about": [2, 4, 8], "deploy": [2, 4], "have": [2, 4], "refer": [2, 4], "http": [2, 4, 8], "nightli": [2, 4], "doc": [2, 4, 6], "main": [2, 4, 8], "custom": [2, 4], "resourc": [2, 4], "paramet": [2, 4, 9], "str": [2, 4], "defin": [2, 4], "custom_resource_definit": 2, "either": 2, "path": 2, "yaml": 2, "file": [2, 8], "json": 2, "string": 2, "put": 2, "The": [2, 4, 7, 8], "connect": [2, 4], "id": [2, 8], "api": [2, 4, 7], "group": [2, 4], "version": [2, 4, 6, 7, 8], "bool": [2, 4], "run": [2, 8], "client": 2, "configur": 2, "context": [2, 4], "point": 2, "ignor": 2, "when": [2, 7], "true": 2, "If": [2, 8], "current": 2, "config": 2, "templat": 2, "specifi": [2, 7], "default": 2, "valu": 2, "kube": 2, "template_field": [2, 4], "sequenc": [2, 4], "template_ext": 2, "yml": 2, "ui_color": 2, "f4a460": 2, "execut": 2, "method": 2, "deriv": [2, 4], "same": 2, "dictionari": 2, "render": 2, "jinja": 2, "get_template_context": 2, "flinkkubernetessensor": 4, "application_nam": 4, "attach_log": 4, "fals": 4, "basesensoroper": 4, "check": [4, 6, 8], "applic": [4, 9], "name": 4, "where": 4, "resid": 4, "determin": 4, "whether": 4, "log": 4, "driver": 4, "pod": 4, "should": [4, 8], "append": 4, "failure_st": 4, "miss": 4, "error": [4, 6], "success_st": 4, "readi": 4, "poke": 4, "function": 4, "while": 4, "overrid": 4, "commit": 6, "list": [6, 7], "chang": 6, "high": 6, "level": 6, "changelog": 6, "see": [6, 7], "includ": 6, "latest": 6, "2023": 6, "05": 6, "18": 6, "subject": 6, "abea189022": 6, "31393": 6, "f5aed58d9f": 6, "fix": 6, "circular": 6, "import": [6, 8], "caus": 6, "31379": 6, "d9ff55cf6d": 6, "16": 6, "prepar": 6, "mai": 6, "wave": 6, "31252": 6, "eef5bc7f16": 6, "03": 6, "add": 6, "full": 6, "autom": 6, "min": 6, "30994": 6, "a7eb32a5b2": 6, "04": 6, "30": 6, "bump": [6, 7], "minimum": [6, 7], "30917": [6, 7], "d23a3bbed8": 6, "mechan": 6, "suspend": 6, "30422": 6, "fcd3c0149f": 6, "29878": 6, "68412e1664": 6, "02": 6, "23": 6, "make": [6, 7], "cncf": [6, 7], "requir": 6, "29710": [6, 7], "9aa873ad69": 6, "22": 6, "precis": 6, "option": 6, "depend": 6, "from": [6, 7, 9], "29707": 6, "2022": 6, "12": [6, 8], "21": 6, "681835a67c": 6, "k8": 6, "28512": 6, "python": [7, 8], "exampl": [7, 8], "dag": 7, "pypi": 7, "repositori": 7, "releas": 7, "all": 7, "class": 7, "ar": [7, 8], "you": [7, 8], "can": [7, 8], "top": [7, 8], "exist": 7, "below": [7, 8], "support": 7, "via": [7, 8], "pip": [7, 8], "4": 7, "cryptographi": 7, "5": 7, "those": [7, 8], "might": 7, "need": 7, "order": 7, "them": 7, "extra": 7, "verifi": 7, "checksum": [7, 8], "signatur": [7, 8], "site": 7, "sdist": [7, 8], "asc": [7, 8], "sha512": [7, 8], "wheel": 7, "onli": 7, "avail": [7, 8], "explain": 7, "polici": 7, "initi": 7, "page": 8, "describ": 8, "download": 8, "apach": 8, "airflow": 8, "provid": 8, "flink": 8, "offici": 8, "also": 8, "most": 8, "choos": 8, "differ": 8, "select": 8, "drop": 8, "down": 8, "left": 8, "whl": 8, "want": 8, "origin": 8, "softwar": 8, "foundat": 8, "code": 8, "link": 8, "abov": 8, "contain": 8, "build": 8, "pgp": 8, "kei": 8, "It": 8, "essenti": 8, "sha": 8, "gpg": 8, "pleas": 8, "well": 8, "relev": 8, "distribut": 8, "recommend": 8, "get": 8, "directori": 8, "mirror": 8, "pgpk": 8, "ka": 8, "To": 8, "binari": 8, "follow": 8, "pgpv": 8, "tar": 8, "gz": 8, "made": 8, "sat": 8, "11": 8, "sep": 8, "49": 8, "54": 8, "2021": 8, "bst": 8, "rsa": 8, "cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f": 8, "issuer": 8, "kaxilnaik": 8, "good": 8, "kaxil": 8, "naik": 8, "unknown": 8, "aka": 8, "gmail": 8, "com": 8, "warn": 8, "": 8, "user": 8, "certifi": 8, "trust": 8, "There": 8, "indic": 8, "belong": 8, "owner": 8, "primari": 8, "fingerprint": 8, "cde1": 8, "5c6e": 8, "4d3a": 8, "8ec4": 8, "ecf4": 8, "ba4b": 8, "6674": 8, "e08a": 8, "d7de": 8, "406f": 8, "correct": 8, "do": 8, "worri": 8, "certif": 8, "manag": 8, "self": 8, "sign": 8, "why": 8, "By": 8, "server": 8, "previou": 8, "step": 8, "know": 8, "valid": 8, "alreadi": 8, "sum": 8, "shasum": 8, "512": 8, "diff": 8, "match": 8, "one": 8, "local": 8, "script": 8, "bin": 8, "bash": 8, "package_vers": 8, "package_nam": 8, "provider_download_dir": 8, "mktemp": 8, "d": 8, "dep": 8, "dest": 8, "curl": 8, "apache_airflow_providers_apache_flink": 8, "py3": 8, "ani": 8, "l": 8, "o": 8, "echo": 8, "la": 8, "onc": 8, "instruct": 8, "chapter": 8, "remov": 8, "temporari": 8, "folder": 8, "launch": 9, "definit": 9, "further": 9, "document": 9, "pull": 9, "imag": 9, "privat": 9, "registri": 9}, "objects": {"airflow.providers.apache": [[1, 0, 0, "-", "flink"]], "airflow.providers.apache.flink": [[1, 1, 1, "", "__version__"], [0, 0, 0, "-", "hooks"], [3, 0, 0, "-", "operators"], [5, 0, 0, "-", "sensors"]], "airflow.providers.apache.flink.operators": [[2, 0, 0, "-", "flink_kubernetes"]], "airflow.providers.apache.flink.operators.flink_kubernetes": [[2, 2, 1, "", "FlinkKubernetesOperator"]], "airflow.providers.apache.flink.operators.flink_kubernetes.FlinkKubernetesOperator": [[2, 3, 1, "", "client"], [2, 3, 1, "", "execute"], [2, 3, 1, "", "hook"], [2, 4, 1, "", "template_ext"], [2, 4, 1, "", "template_fields"], [2, 4, 1, "", "ui_color"]], "airflow.providers.apache.flink.sensors": [[4, 0, 0, "-", "flink_kubernetes"]], "airflow.providers.apache.flink.sensors.flink_kubernetes": [[4, 2, 1, "", "FlinkKubernetesSensor"]], "airflow.providers.apache.flink.sensors.flink_kubernetes.FlinkKubernetesSensor": [[4, 4, 1, "", "FAILURE_STATES"], [4, 4, 1, "", "SUCCESS_STATES"], [4, 3, 1, "", "poke"], [4, 4, 1, "", "template_fields"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:method", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"]}, "titleterms": {"airflow": [0, 1, 2, 3, 4, 5, 6, 7], "provid": [0, 1, 2, 3, 4, 5, 6, 7], "apach": [0, 1, 2, 3, 4, 5, 6, 7, 9], "flink": [0, 1, 2, 3, 4, 5, 6, 7, 9], "hook": 0, "subpackag": 1, "packag": [1, 6, 7, 8], "content": [1, 2, 4, 7], "oper": [2, 3, 9], "flink_kubernet": [2, 4], "modul": [2, 4], "class": [2, 4], "submodul": [3, 5], "sensor": [4, 5], "1": [6, 7], "0": [6, 7], "guid": 7, "refer": [7, 9], "resourc": 7, "commit": 7, "instal": [7, 8], "requir": 7, "cross": 7, "depend": 7, "download": 7, "offici": 7, "changelog": 7, "misc": 7, "bug": 7, "fix": 7, "from": 8, "sourc": 8, "releas": 8, "integr": 8, "verifi": 8, "pypi": 8, "flinkkubernetesoper": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"airflow.providers.apache.flink.hooks": [[0, "module-airflow.providers.apache.flink.hooks"]], "airflow.providers.apache.flink": [[1, "module-airflow.providers.apache.flink"]], "Subpackages": [[1, "subpackages"]], "Package Contents": [[1, "package-contents"]], "airflow.providers.apache.flink.operators.flink_kubernetes": [[2, "module-airflow.providers.apache.flink.operators.flink_kubernetes"]], "Module Contents": [[2, "module-contents"], [4, "module-contents"]], "Classes": [[2, "classes"], [4, "classes"]], "airflow.providers.apache.flink.operators": [[3, "module-airflow.providers.apache.flink.operators"]], "Submodules": [[3, "submodules"], [5, "submodules"]], "airflow.providers.apache.flink.sensors.flink_kubernetes": [[4, "module-airflow.providers.apache.flink.sensors.flink_kubernetes"]], "airflow.providers.apache.flink.sensors": [[5, "module-airflow.providers.apache.flink.sensors"]], "Package apache-airflow-providers-apache-flink": [[6, "package-apache-airflow-providers-apache-flink"], [7, "package-apache-airflow-providers-apache-flink"]], "1.1.0": [[6, "id1"], [7, "id1"]], "1.0.1": [[6, "id2"], [7, "id2"]], "1.0.0": [[6, "id3"], [7, "id3"]], "apache-airflow-providers-apache-flink": [[7, "apache-airflow-providers-apache-flink"]], "Content": [[7, "content"]], "Guides": [[7, null]], "References": [[7, null]], "Resources": [[7, null]], "Commits": [[7, null]], "Provider package": [[7, "provider-package"]], "Installation": [[7, "installation"]], "Requirements": [[7, "requirements"]], "Cross provider package dependencies": [[7, "cross-provider-package-dependencies"]], "Downloading official packages": [[7, "downloading-official-packages"]], "Changelog": [[7, "changelog"]], "Misc": [[7, "misc"]], "Bug Fixes": [[7, "bug-fixes"]], "Installing from sources": [[8, "installing-from-sources"]], "Released packages": [[8, "released-packages"]], "Release integrity": [[8, "release-integrity"]], "Verifying PyPI releases": [[8, "verifying-pypi-releases"]], "Apache Flink Operators": [[9, "apache-flink-operators"]], "FlinkKubernetesOperator": [[9, "flinkkubernetesoperator"]], "Reference": [[9, "reference"]]}, "indexentries": {"airflow.providers.apache.flink.hooks": [[0, "module-airflow.providers.apache.flink.hooks"]], "module": [[0, "module-airflow.providers.apache.flink.hooks"], [1, "module-airflow.providers.apache.flink"], [2, "module-airflow.providers.apache.flink.operators.flink_kubernetes"], [3, "module-airflow.providers.apache.flink.operators"], [4, "module-airflow.providers.apache.flink.sensors.flink_kubernetes"], [5, "module-airflow.providers.apache.flink.sensors"]], "__version__ (in module airflow.providers.apache.flink)": [[1, "airflow.providers.apache.flink.__version__"]], "airflow.providers.apache.flink": [[1, "module-airflow.providers.apache.flink"]], "flinkkubernetesoperator (class in airflow.providers.apache.flink.operators.flink_kubernetes)": [[2, "airflow.providers.apache.flink.operators.flink_kubernetes.FlinkKubernetesOperator"]], "airflow.providers.apache.flink.operators.flink_kubernetes": [[2, "module-airflow.providers.apache.flink.operators.flink_kubernetes"]], "client() (airflow.providers.apache.flink.operators.flink_kubernetes.flinkkubernetesoperator method)": [[2, "airflow.providers.apache.flink.operators.flink_kubernetes.FlinkKubernetesOperator.client"]], "execute() (airflow.providers.apache.flink.operators.flink_kubernetes.flinkkubernetesoperator method)": [[2, "airflow.providers.apache.flink.operators.flink_kubernetes.FlinkKubernetesOperator.execute"]], "hook() (airflow.providers.apache.flink.operators.flink_kubernetes.flinkkubernetesoperator method)": [[2, "airflow.providers.apache.flink.operators.flink_kubernetes.FlinkKubernetesOperator.hook"]], "template_ext (airflow.providers.apache.flink.operators.flink_kubernetes.flinkkubernetesoperator attribute)": [[2, "airflow.providers.apache.flink.operators.flink_kubernetes.FlinkKubernetesOperator.template_ext"]], "template_fields (airflow.providers.apache.flink.operators.flink_kubernetes.flinkkubernetesoperator attribute)": [[2, "airflow.providers.apache.flink.operators.flink_kubernetes.FlinkKubernetesOperator.template_fields"]], "ui_color (airflow.providers.apache.flink.operators.flink_kubernetes.flinkkubernetesoperator attribute)": [[2, "airflow.providers.apache.flink.operators.flink_kubernetes.FlinkKubernetesOperator.ui_color"]], "airflow.providers.apache.flink.operators": [[3, "module-airflow.providers.apache.flink.operators"]], "failure_states (airflow.providers.apache.flink.sensors.flink_kubernetes.flinkkubernetessensor attribute)": [[4, "airflow.providers.apache.flink.sensors.flink_kubernetes.FlinkKubernetesSensor.FAILURE_STATES"]], "flinkkubernetessensor (class in airflow.providers.apache.flink.sensors.flink_kubernetes)": [[4, "airflow.providers.apache.flink.sensors.flink_kubernetes.FlinkKubernetesSensor"]], "success_states (airflow.providers.apache.flink.sensors.flink_kubernetes.flinkkubernetessensor attribute)": [[4, "airflow.providers.apache.flink.sensors.flink_kubernetes.FlinkKubernetesSensor.SUCCESS_STATES"]], "airflow.providers.apache.flink.sensors.flink_kubernetes": [[4, "module-airflow.providers.apache.flink.sensors.flink_kubernetes"]], "poke() (airflow.providers.apache.flink.sensors.flink_kubernetes.flinkkubernetessensor method)": [[4, "airflow.providers.apache.flink.sensors.flink_kubernetes.FlinkKubernetesSensor.poke"]], "template_fields (airflow.providers.apache.flink.sensors.flink_kubernetes.flinkkubernetessensor attribute)": [[4, "airflow.providers.apache.flink.sensors.flink_kubernetes.FlinkKubernetesSensor.template_fields"]], "airflow.providers.apache.flink.sensors": [[5, "module-airflow.providers.apache.flink.sensors"]]}})