blob: 7572208c181843c7ab31a659f7b24e2a4d6f30c5 [file] [log] [blame]
{"version":3,"sources":["/home/madhan/Apache/git/atlas/docs/target/src/documents/Hook/HookFalcon.md","/home/madhan/Apache/git/atlas/docs/target/theme/styles/styled-colors.js"],"names":["layoutProps","MDXContent","components","props","mdxType","parentName","wrapLines","language","style","theme","isMDXComponent","dark","hljs","color"],"mappings":"ykBAWMA,EAAc,GAIL,SAASC,EAAW,GAG/B,IAFFC,EAAU,EAAVA,WACGC,EAAK,iBAER,OAAO,cALS,UAKC,iBAAKH,EAAiBG,EAAK,CAAED,WAAYA,EAAYE,QAAQ,cAE5E,oBACE,GAAM,uBAAqB,uBAE7B,oBACE,GAAM,gBAAc,gBAEtB,+EACA,wBACE,oBAAIC,WAAW,MAAI,gBACjB,oBAAIA,WAAW,MACb,oBAAIA,WAAW,MAAI,iBACjB,oBAAIA,WAAW,MACb,oBAAIA,WAAW,MAAI,+BACnB,oBAAIA,WAAW,MAAI,8CAGvB,oBAAIA,WAAW,MAAI,cACjB,oBAAIA,WAAW,MACb,oBAAIA,WAAW,MAAI,wBACnB,oBAAIA,WAAW,MAAI,2DAGvB,oBAAIA,WAAW,MAAI,uBACjB,oBAAIA,WAAW,MACb,oBAAIA,WAAW,MAAI,wBACnB,oBAAIA,WAAW,MAAI,6CAGvB,oBAAIA,WAAW,MAAI,0BACjB,oBAAIA,WAAW,MACb,oBAAIA,WAAW,MAAI,wBACnB,oBAAIA,WAAW,MAAI,kCAGvB,oBAAIA,WAAW,MAAI,iBACjB,oBAAIA,WAAW,MACb,oBAAIA,WAAW,MAAI,wBACnB,oBAAIA,WAAW,MAAI,oFAM7B,yHACA,sMACA,wBACE,oBAAIA,WAAW,MAAI,2CAA6C,4BAAYA,WAAW,MAAI,kCAC3F,oBAAIA,WAAW,MAAI,2CAA6C,4BAAYA,WAAW,MAAI,mBAC3F,oBAAIA,WAAW,MAAI,2CAA6C,4BAAYA,WAAW,MAAI,+BAC3F,oBAAIA,WAAW,MAAI,2CAA6C,4BAAYA,WAAW,MAAI,gBAC3F,oBAAIA,WAAW,MAAI,2CAA6C,4BAAYA,WAAW,MAAI,iBAE7F,oBACE,GAAM,eAAa,eAErB,qNAEA,wBACE,oBAAIA,WAAW,MAAI,iFAAmF,4BAAYA,WAAW,MAAI,iBAA+B,uBAChK,oBAAIA,WAAW,MAAI,4DACnB,oBAAIA,WAAW,MAAI,kDACnB,oBAAIA,WAAW,MAAI,6FAAgG,4BAAYA,WAAW,MAAI,gBAA8B,gBAC5K,oBAAIA,WAAW,MAAI,qDAAuD,4BAAYA,WAAW,MAAI,gBAA8B,kBAAmB,4BAAYA,WAAW,MAAI,iBAA+B,uCAChN,oBAAIA,WAAW,MAAI,MAAQ,4BAAYA,WAAW,MAAI,iBAA+B,4DAEvF,cAAC,IAAiB,CAACC,WAAW,EAAMC,SAAS,OAAOC,MAAOC,IAAYL,QAAQ,qBAAmB,8EAGlG,sDAAmC,4BAAYC,WAAW,KAAG,gBAA8B,mFAC3F,wBACE,oBAAIA,WAAW,MAAI,gGACnB,oBAAIA,WAAW,MAAI,2FACnB,oBAAIA,WAAW,MAAI,uEACnB,oBAAIA,WAAW,MAAI,0EACnB,oBAAIA,WAAW,MAAI,0EACnB,oBAAIA,WAAW,MAAI,mFAErB,gCAAa,mBAAGA,WAAW,IACvB,KAAQ,mBAAiB,iBACH,4CAC1B,oBACE,GAAM,SAAO,SAEf,wBACE,oBAAIA,WAAW,MAAI,8LAGxB,sLAEDJ,EAAWS,gBAAiB,G,+DC9G5B,iFAqBAC,IAAKC,KAAKC,MAAQ,UACHF,MAAI","file":"static/js/documents-hook-hook-falcon.4e9a18ba.js","sourcesContent":["\nimport React from 'react'\nimport { mdx } from '@mdx-js/react'\n\n/* @jsxRuntime classic */\n/* @jsx mdx */\nimport themen from 'theme/styles/styled-colors';\nimport * as theme from 'react-syntax-highlighter/dist/esm/styles/hljs';\nimport SyntaxHighlighter from 'react-syntax-highlighter';\n\n\nconst layoutProps = {\n \n};\nconst MDXLayout = \"wrapper\"\nexport default function MDXContent({\n components,\n ...props\n}) {\n return <MDXLayout {...layoutProps} {...props} components={components} mdxType=\"MDXLayout\">\n\n <h1 {...{\n \"id\": \"falcon-atlas-bridge\"\n }}>{`Falcon Atlas Bridge`}</h1>\n <h2 {...{\n \"id\": \"falcon-model\"\n }}>{`Falcon Model`}</h2>\n <p>{`The default hive model includes the following types:`}</p>\n <ul>\n <li parentName=\"ul\">{`Entity types:`}\n <ul parentName=\"li\">\n <li parentName=\"ul\">{`falcon_cluster`}\n <ul parentName=\"li\">\n <li parentName=\"ul\">{`super-types: Infrastructure`}</li>\n <li parentName=\"ul\">{`attributes: timestamp, colo, owner, tags`}</li>\n </ul>\n </li>\n <li parentName=\"ul\">{`falcon_feed`}\n <ul parentName=\"li\">\n <li parentName=\"ul\">{`super-types: DataSet`}</li>\n <li parentName=\"ul\">{`attributes: timestamp, stored-in, owner, groups, tags`}</li>\n </ul>\n </li>\n <li parentName=\"ul\">{`falcon_feed_creation`}\n <ul parentName=\"li\">\n <li parentName=\"ul\">{`super-types: Process`}</li>\n <li parentName=\"ul\">{`attributes: timestamp, stored-in, owner`}</li>\n </ul>\n </li>\n <li parentName=\"ul\">{`falcon_feed_replication`}\n <ul parentName=\"li\">\n <li parentName=\"ul\">{`super-types: Process`}</li>\n <li parentName=\"ul\">{`attributes: timestamp, owner`}</li>\n </ul>\n </li>\n <li parentName=\"ul\">{`falcon_process`}\n <ul parentName=\"li\">\n <li parentName=\"ul\">{`super-types: Process`}</li>\n <li parentName=\"ul\">{`attributes: timestamp, runs-on, owner, tags, pipelines, workflow-properties`}</li>\n </ul>\n </li>\n </ul>\n </li>\n </ul>\n <p>{`One falcon_process entity is created for every cluster that the falcon process is defined for.`}</p>\n <p>{`The entities are created and de-duped using unique qualifiedName attribute. They provide namespace and can be used for querying/lineage as well. The unique attributes are:`}</p>\n <ul>\n <li parentName=\"ul\">{`falcon_process.qualifiedName - `}<inlineCode parentName=\"li\">{`<process name>@<cluster name>`}</inlineCode></li>\n <li parentName=\"ul\">{`falcon_cluster.qualifiedName - `}<inlineCode parentName=\"li\">{`<cluster name>`}</inlineCode></li>\n <li parentName=\"ul\">{`falcon_feed.qualifiedName - `}<inlineCode parentName=\"li\">{`<feed name>@<cluster name>`}</inlineCode></li>\n <li parentName=\"ul\">{`falcon_feed_creation.qualifiedName - `}<inlineCode parentName=\"li\">{`<feed name>`}</inlineCode></li>\n <li parentName=\"ul\">{`falcon_feed_replication.qualifiedName - `}<inlineCode parentName=\"li\">{`<feed name>`}</inlineCode></li>\n </ul>\n <h2 {...{\n \"id\": \"falcon-hook\"\n }}>{`Falcon Hook`}</h2>\n <p>{`Falcon supports listeners on falcon entity submission. This is used to add entities in Atlas using the model detailed above.\nFollow the instructions below to setup Atlas hook in Falcon:`}</p>\n <ul>\n <li parentName=\"ul\">{`Add 'org.apache.atlas.falcon.service.AtlasService' to application.services in `}<inlineCode parentName=\"li\">{`<falcon-conf>`}</inlineCode>{`/startup.properties`}</li>\n <li parentName=\"ul\">{`untar apache-atlas-\\${project.version}-falcon-hook.tar.gz`}</li>\n <li parentName=\"ul\">{`cd apache-atlas-falcon-hook-\\${project.version}`}</li>\n <li parentName=\"ul\">{`Copy entire contents of folder apache-atlas-falcon-hook-\\${project.version}/hook/falcon to `}<inlineCode parentName=\"li\">{`<atlas-home>`}</inlineCode>{`/hook/falcon`}</li>\n <li parentName=\"ul\">{`Link Atlas hook jars in Falcon classpath - 'ln -s `}<inlineCode parentName=\"li\">{`<atlas-home>`}</inlineCode>{`/hook/falcon/* `}<inlineCode parentName=\"li\">{`<falcon-home>`}</inlineCode>{`/server/webapp/falcon/WEB-INF/lib/'`}</li>\n <li parentName=\"ul\">{`In `}<inlineCode parentName=\"li\">{`<falcon_conf>`}</inlineCode>{`/falcon-env.sh, set an environment variable as follows:`}</li>\n </ul>\n <SyntaxHighlighter wrapLines={true} language=\"java\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {`export FALCON_SERVER_OPTS=\"<atlas_home>/hook/falcon/*:$FALCON_SERVER_OPTS\"`}\n </SyntaxHighlighter>\n <p>{`The following properties in `}<inlineCode parentName=\"p\">{`<atlas-conf>`}</inlineCode>{`/atlas-application.properties control the thread pool and notification details:`}</p>\n <ul>\n <li parentName=\"ul\">{`atlas.hook.falcon.synchronous - boolean, true to run the hook synchronously. default false`}</li>\n <li parentName=\"ul\">{`atlas.hook.falcon.numRetries - number of retries for notification failure. default 3`}</li>\n <li parentName=\"ul\">{`atlas.hook.falcon.minThreads - core number of threads. default 5`}</li>\n <li parentName=\"ul\">{`atlas.hook.falcon.maxThreads - maximum number of threads. default 5`}</li>\n <li parentName=\"ul\">{`atlas.hook.falcon.keepAliveTime - keep alive time in msecs. default 10`}</li>\n <li parentName=\"ul\">{`atlas.hook.falcon.queueSize - queue size for the threadpool. default 10000`}</li>\n </ul>\n <p>{`Refer `}<a parentName=\"p\" {...{\n \"href\": \"#/Configuration\"\n }}>{`Configuration`}</a>{` for notification related configurations`}</p>\n <h2 {...{\n \"id\": \"notes\"\n }}>{`NOTES`}</h2>\n <ul>\n <li parentName=\"ul\">{`In falcon cluster entity, cluster name used should be uniform across components like hive, falcon, sqoop etc. If used with ambari, ambari cluster name should be used for cluster entity`}</li>\n </ul>\n </MDXLayout>;\n}\n;\nMDXContent.isMDXComponent = true;","/**\n * Licensed to the Apache Software Foundation (ASF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The ASF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { dark } from \"react-syntax-highlighter/dist/esm/styles/hljs\";\n\n//dark[\"powershell\"][\"color\"] = \"#37bb9b\";\ndark.hljs.color = \"#37bb9b\";\nexport default dark;"],"sourceRoot":""}