blob: ebd886316818d17a5a73d6408238d153ac55a3a0 [file] [log] [blame]
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-about/configuration">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.2.0">
<title data-rh="true">Recommended Configuration | Apache Linkis</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://linkis.apache.org/docs/1.6.0/about/configuration"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Recommended Configuration | Apache Linkis"><meta data-rh="true" name="description" content="1. Recommended configuration of hardware and software environment"><meta data-rh="true" property="og:description" content="1. Recommended configuration of hardware and software environment"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://linkis.apache.org/docs/1.6.0/about/configuration"><link data-rh="true" rel="alternate" href="https://linkis.apache.org/docs/1.6.0/about/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://linkis.apache.org/zh-CN/docs/1.6.0/about/configuration" hreflang="zh-CN"><link data-rh="true" rel="alternate" href="https://linkis.apache.org/docs/1.6.0/about/configuration" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://AE29KQB3IA-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache Linkis RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache Linkis Atom Feed">
<link rel="alternate" type="application/json" href="/blog/feed.json" title="Apache Linkis JSON Feed">
<link rel="search" type="application/opensearchdescription+xml" title="Apache Linkis" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.fee819ac.css">
<link rel="preload" href="/assets/js/runtime~main.36b81271.js" as="script">
<link rel="preload" href="/assets/js/main.f09c65a0.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.png" alt="Apache Linkis Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.png" alt="Apache Linkis Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache Linkis</b></a><a class="navbar__item navbar__link" href="/download/main">Download</a><a class="navbar__item navbar__link" href="/community/how-to-subscribe">Community</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/user">Users</a><a href="https://docs.qq.com/doc/DUkdTTGhVSlZ0VXVt" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">FAQ</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Doc</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/latest/about/introduction">1.5.0</a></li><li><a class="dropdown__link" href="/docs/1.4.0/about/introduction">1.4.0</a></li><li><a class="dropdown__link" href="/docs/1.3.2/about/introduction">1.3.2</a></li><li><a class="dropdown__link" href="/docs/1.6.0/about/introduction">Next(1.6.0)</a></li><li><a class="dropdown__link" href="/versions">All Version</a></li></ul></div><a href="https://github.com/apache/linkis" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub"></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/docs/1.6.0/about/configuration" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/zh-CN/docs/1.6.0/about/configuration" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh-CN">简体中文</a></li></ul></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/1.6.0/about/introduction">About Linkis</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/about/introduction">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/1.6.0/about/configuration">Recommended Configuration</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/about/glossary">Glossary</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/quick/live-demo">Quick Experience</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/deployment/deploy-quick">Deployment</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/user-guide/how-to-use">User Guide</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/engine-usage/overview">Engine Usage</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/auth/ldap">Security Authentication</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/api/overview">API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/architecture/overview">Architecture</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/development/directory-structure">Development</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/tuning-and-troubleshooting/overview">Tuning And Troubleshooting</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/upgrade/upgrade-from-0.X-to-1.0-guide">Upgrade Guide</a></div></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is unreleased documentation for <!-- -->Apache Linkis<!-- --> <b>Next(1.6.0)</b> version.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/latest/about/configuration">latest version</a></b> (<!-- -->1.5.0<!-- -->).</div></div><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">About Linkis</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Recommended Configuration</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Next(1.6.0)</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Recommended Configuration</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1-recommended-configuration-of-hardware-and-software-environment">1. Recommended configuration of hardware and software environment<a class="hash-link" href="#1-recommended-configuration-of-hardware-and-software-environment" title="Direct link to heading"></a></h2><p>Linkis builds a layer of computing middleware between the upper application and the underlying engine. As an open source distributed computing middleware, it can be well deployed and run on Intel architecture servers and mainstream virtualization environments, and supports mainstream Linux operating system environments</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="11-linux-operating-system-version-requirements">1.1. Linux operating system version requirements<a class="hash-link" href="#11-linux-operating-system-version-requirements" title="Direct link to heading"></a></h3><table><thead><tr><th>OS</th><th>Version</th></tr></thead><tbody><tr><td>Red Hat Enterprise Linux</td><td>7.0 and above</td></tr><tr><td>CentOS</td><td>7.0 and above</td></tr><tr><td>Oracle Enterprise Linux</td><td>7.0 and above</td></tr><tr><td>Ubuntu LTS</td><td>16.04 and above</td></tr></tbody></table><blockquote><p><strong>Note:</strong> The above Linux operating systems can run on physical servers and mainstream virtualization environments such as VMware, KVM, and XEN</p></blockquote><h3 class="anchor anchorWithStickyNavbar_LWe7" id="12-server-recommended-configuration">1.2. Server recommended configuration<a class="hash-link" href="#12-server-recommended-configuration" title="Direct link to heading"></a></h3><p>Linkis supports 64-bit general-purpose hardware server platforms running on the Intel x86-64 architecture. The following recommendations are made for the server hardware configuration of the production environment:</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="production-environment">Production Environment<a class="hash-link" href="#production-environment" title="Direct link to heading"></a></h4><table><thead><tr><th><strong>CPU</strong></th><th><strong>Memory</strong></th><th><strong>Disk type</strong></th><th><strong>Network</strong></th><th><strong>Number of instances</strong></th></tr></thead><tbody><tr><td>16 cores +</td><td>32GB +</td><td>SAS</td><td>Gigabit network card</td><td>1+</td></tr></tbody></table><blockquote><p><strong>Note:</strong></p><ul><li>The above recommended configuration is the minimum configuration for deploying Linkis, and a higher configuration is strongly recommended for production environments</li><li>The hard disk size configuration is recommended to be 50GB+, and the system disk and data disk are separated</li></ul></blockquote><h3 class="anchor anchorWithStickyNavbar_LWe7" id="13-software-requirements">1.3. Software requirements<a class="hash-link" href="#13-software-requirements" title="Direct link to heading"></a></h3><p>Linkis binary packages are compiled based on the following software versions:</p><table><thead><tr><th>Component</th><th>Version</th><th>Description</th></tr></thead><tbody><tr><td>Hadoop</td><td>3.3.4</td><td></td></tr><tr><td>Hive</td><td>3.1.3</td><td></td></tr><tr><td>Spark</td><td>3.2.1</td><td></td></tr><tr><td>Flink</td><td>1.12.2</td><td></td></tr><tr><td>openLooKeng</td><td>1.5.0</td><td></td></tr><tr><td>Sqoop</td><td>1.4.6</td><td></td></tr><tr><td>ElasticSearch</td><td>7.6.2</td><td></td></tr><tr><td>Presto</td><td>0.234</td><td></td></tr><tr><td>Python</td><td>Python2</td><td></td></tr></tbody></table><blockquote><p><strong>Note:</strong>
If the locally installed component version is inconsistent with the above, you need to modify the corresponding component version and compile the binary package yourself for installation.</p></blockquote><h3 class="anchor anchorWithStickyNavbar_LWe7" id="14-client-web-browser-requirements">1.4. Client web browser requirements<a class="hash-link" href="#14-client-web-browser-requirements" title="Direct link to heading"></a></h3><p>Linkis recommends Chrome version 73 for front-end access</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="2-common-scenarios">2. Common scenarios<a class="hash-link" href="#2-common-scenarios" title="Direct link to heading"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="21-open-test-mode">2.1 Open test mode<a class="hash-link" href="#21-open-test-mode" title="Direct link to heading"></a></h3><p>The development process requires a password-free interface, which can be replaced or appended to <code>linkis.properties</code></p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.test.mode</td><td>false</td><td>Whether to enable debugging mode, if set to true, all microservices support password-free login, and all EngineConn open remote debugging ports</td></tr><tr><td>wds.linkis.test.user</td><td>hadoop</td><td>When wds.linkis.test.mode=true, the default login user for password-free login</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/test-mode-ab84afe3444112b960a11dc9c04d24b1.png" width="806" height="339" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="22-login-user-settings">2.2 Login user settings<a class="hash-link" href="#22-login-user-settings" title="Direct link to heading"></a></h3><p>Apache Linkis uses configuration files to manage admin users by default, and this configuration can be replaced or appended to <code>linkis-mg-gateway.properties</code>. For multi-user access LDAP implementation.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.admin.user</td><td>hadoop</td><td>admin username</td></tr><tr><td>wds.linkis.admin.password</td><td>123456</td><td>Admin user password</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/login-user-058dbc811831c9c5a3d647032f4b77a0.png" width="1421" height="583" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="23-ldap-settings">2.3 LDAP Settings<a class="hash-link" href="#23-ldap-settings" title="Direct link to heading"></a></h3><p>Apache Linkis can access LDAP through parameters to achieve multi-user management, and this configuration can be replaced or added in <code>linkis-mg-gateway.properties</code>.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.ldap.proxy.url</td><td>None</td><td>LDAP URL address</td></tr><tr><td>wds.linkis.ldap.proxy.baseDN</td><td>None</td><td>LDAP baseDN address</td></tr><tr><td>wds.linkis.ldap.proxy.userNameFormat</td><td>None</td><td></td></tr></tbody></table><p><img loading="lazy" src="/assets/images/ldap-d8623897124ad621c0013d7e35c3bc22.png" width="1404" height="586" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="24-turn-off-resource-checking">2.4 Turn off resource checking<a class="hash-link" href="#24-turn-off-resource-checking" title="Direct link to heading"></a></h3><p>Apache Linkis sometimes debugs exceptions when submitting tasks, such as: insufficient resources; you can replace or append this configuration in <code>linkis-cg-linkismanager.properties</code>.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.manager.rm.request.enable</td><td>true</td><td>resource check</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/resource-enable-548b1bfdb4f8e206c4ddbd4485f65a73.png" width="1305" height="547" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="25-enable-engine-debugging">2.5 Enable engine debugging<a class="hash-link" href="#25-enable-engine-debugging" title="Direct link to heading"></a></h3><p>Apache Linkis EC can enable debugging mode, and this configuration can be replaced or added in <code>linkis-cg-linkismanager.properties</code>.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.engineconn.debug.enable</td><td>true</td><td>Whether to enable engine debugging</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/engine-debug-d6d34a5e0ff4318bee1c2ec6145d2aad.png" width="1220" height="544" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="26-hive-metadata-configuration">2.6 Hive metadata configuration<a class="hash-link" href="#26-hive-metadata-configuration" title="Direct link to heading"></a></h3><p>The public-service service of Apache Linkis needs to read hive metadata; this configuration can be replaced or appended in <code>linkis-ps-publicservice.properties</code>.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>hive.meta.url</td><td>None</td><td>The URL of the HiveMetaStore database.</td></tr><tr><td>hive.meta.user</td><td>none</td><td>user of the HiveMetaStore database</td></tr><tr><td>hive.meta.password</td><td>None</td><td>password for the HiveMetaStore database</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/hive-meta-d9866b2a627ba0e9323b902bce2c5c94.png" width="1183" height="779" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="27-linkis-database-configuration">2.7 Linkis database configuration<a class="hash-link" href="#27-linkis-database-configuration" title="Direct link to heading"></a></h3><p>Apache Linkis access uses Mysql as data storage by default, you can replace or append this configuration in <code>linkis.properties</code>.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.server.mybatis.datasource.url</td><td>None</td><td>Database connection string, for example: jdbc:mysql://127.0.0.1:3306/dss?characterEncoding=UTF-8</td></tr><tr><td>wds.linkis.server.mybatis.datasource.username</td><td>None</td><td>Database user name, for example: root</td></tr><tr><td>wds.linkis.server.mybatis.datasource.password</td><td>None</td><td>Database password, for example: root</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/linkis-db-c9e5a90db880655bc6169b28fbc5822c.png" width="831" height="536" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="28-linkis-session-cache-configuration">2.8 Linkis Session cache configuration<a class="hash-link" href="#28-linkis-session-cache-configuration" title="Direct link to heading"></a></h3><p>Apache Linkis supports using redis for session sharing; this configuration can be replaced or appended in <code>linkis.properties</code>.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>linkis.session.redis.cache.enabled</td><td>None</td><td>Whether to enable</td></tr><tr><td>linkis.session.redis.host</td><td>127.0.0.1</td><td>hostname</td></tr><tr><td>linkis.session.redis.port</td><td>6379</td><td>Port, eg</td></tr><tr><td>linkis.session.redis.password</td><td>None</td><td>password</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/redis-93c88ca8d619cc6b131b5b77d31097c3.png" width="753" height="403" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="29-linkis-module-development-configuration">2.9 Linkis module development configuration<a class="hash-link" href="#29-linkis-module-development-configuration" title="Direct link to heading"></a></h3><p>When developing Apache Linkis, you can use this parameter to customize the database, Rest interface, and entity objects of the loading module; you can modify it in <code>linkis-ps-publicservice.properties</code>, and use commas to separate multiple modules.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.server.restful.scan.packages</td><td>None</td><td>restful scan packages, for example: org.apache.linkis.basedatamanager.server.restful</td></tr><tr><td>wds.linkis.server.mybatis.mapperLocations</td><td>None</td><td>Mybatis mapper file path, for example: classpath<em>:org/apache/linkis/basedatamanager/server/dao/mapper/</em>.xml</td></tr><tr><td>wds.linkis.server.mybatis.typeAliasesPackage</td><td>None</td><td>Entity alias scanning package, for example: org.apache.linkis.basedatamanager.server.domain</td></tr><tr><td>wds.linkis.server.mybatis.BasePackage</td><td>None</td><td>Database dao layer scan, for example: org.apache.linkis.basedatamanager.server.dao</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/deverlop-conf-09543dc2b1c9e5b57ffbc9f87a402873.png" width="843" height="590" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="210-linkis-module-development-configuration">2.10 Linkis module development configuration<a class="hash-link" href="#210-linkis-module-development-configuration" title="Direct link to heading"></a></h3><p>This parameter can be used to customize the route of loading modules during Apache Linkis development; it can be modified in <code>linkis.properties</code>, and commas are used to separate multiple modules.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.gateway.conf.publicservice.list</td><td>cs,contextservice,data-source-manager,metadataQuery,metadatamanager,query,jobhistory,application,configuration,filesystem,udf,variable,microservice,errorcode,bml,datasource,basedata -manager</td><td>publicservice services support routing modules</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/list-conf-63213b57ab66a41758c14cdb731a9731.png" width="1205" height="461" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="211-linkis-file-system-and-material-storage-path">2.11 Linkis file system and material storage path<a class="hash-link" href="#211-linkis-file-system-and-material-storage-path" title="Direct link to heading"></a></h3><p>This parameter can be used to customize the route of loading modules during Apache Linkis development; it can be modified in <code>linkis.properties</code>, and commas are used to separate multiple modules.</p><table><thead><tr><th>parameter name</th><th>default value</th><th>description</th></tr></thead><tbody><tr><td>wds.linkis.filesystem.root.path</td><td>file:///tmp/linkis/</td><td>Local user directory, a folder named after the user name needs to be created under this directory</td></tr><tr><td>wds.linkis.filesystem.hdfs.root.path</td><td>hdfs:///tmp/</td><td>HDFS user directory</td></tr><tr><td>wds.linkis.bml.is.hdfs</td><td>true</td><td>Whether to enable hdfs</td></tr><tr><td>wds.linkis.bml.hdfs.prefix</td><td>/apps-data</td><td>hdfs path</td></tr><tr><td>wds.linkis.bml.local.prefix</td><td>/apps-data</td><td>local path</td></tr></tbody></table><p><img loading="lazy" src="/assets/images/fs-conf-4dd57caa5f812496174bda5b25d6f36b.png" width="540" height="344" class="img_ev3q"></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/linkis-website/edit/dev/docs/about/configuration.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.6.0/about/introduction"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.6.0/about/glossary"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Glossary</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#1-recommended-configuration-of-hardware-and-software-environment" class="table-of-contents__link toc-highlight">1. Recommended configuration of hardware and software environment</a><ul><li><a href="#11-linux-operating-system-version-requirements" class="table-of-contents__link toc-highlight">1.1. Linux operating system version requirements</a></li><li><a href="#12-server-recommended-configuration" class="table-of-contents__link toc-highlight">1.2. Server recommended configuration</a></li><li><a href="#13-software-requirements" class="table-of-contents__link toc-highlight">1.3. Software requirements</a></li><li><a href="#14-client-web-browser-requirements" class="table-of-contents__link toc-highlight">1.4. Client web browser requirements</a></li></ul></li><li><a href="#2-common-scenarios" class="table-of-contents__link toc-highlight">2. Common scenarios</a><ul><li><a href="#21-open-test-mode" class="table-of-contents__link toc-highlight">2.1 Open test mode</a></li><li><a href="#22-login-user-settings" class="table-of-contents__link toc-highlight">2.2 Login user settings</a></li><li><a href="#23-ldap-settings" class="table-of-contents__link toc-highlight">2.3 LDAP Settings</a></li><li><a href="#24-turn-off-resource-checking" class="table-of-contents__link toc-highlight">2.4 Turn off resource checking</a></li><li><a href="#25-enable-engine-debugging" class="table-of-contents__link toc-highlight">2.5 Enable engine debugging</a></li><li><a href="#26-hive-metadata-configuration" class="table-of-contents__link toc-highlight">2.6 Hive metadata configuration</a></li><li><a href="#27-linkis-database-configuration" class="table-of-contents__link toc-highlight">2.7 Linkis database configuration</a></li><li><a href="#28-linkis-session-cache-configuration" class="table-of-contents__link toc-highlight">2.8 Linkis Session cache configuration</a></li><li><a href="#29-linkis-module-development-configuration" class="table-of-contents__link toc-highlight">2.9 Linkis module development configuration</a></li><li><a href="#210-linkis-module-development-configuration" class="table-of-contents__link toc-highlight">2.10 Linkis module development configuration</a></li><li><a href="#211-linkis-file-system-and-material-storage-path" class="table-of-contents__link toc-highlight">2.11 Linkis file system and material storage path</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Linkis</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/latest/about/introduction">Document</a></li><li class="footer__item"><a class="footer__link-item" href="/faq/main">FAQ</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/releases" target="_blank" rel="noopener noreferrer" class="footer__link-item">Releases</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/apache/linkis" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">Issue Tracker</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/pulls" target="_blank" rel="noopener noreferrer" class="footer__link-item">Pull Requests</a></li></ul></div><div class="col footer__col"><div class="footer__title">Subscribe Mailing List</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/community/how-to-subscribe">How to Subscribe</a></li><li class="footer__item"><a href="mailto:dev-subscribe@linkis.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item">Subscribe Mail</a></li><li class="footer__item"><a href="https://lists.apache.org/list.html?dev@linkis.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item">Mail Archive</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><div><img style="height:50px" alt="Apache Software Foundation" src="/img/incubator-logo.svg"><p style="color: #999999; padding: 0 20px 30px;font-weight:400;text-align:left">Apache Linkis is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p><p></p>
<p style="padding: 0 20px 30px;color: #999999;font-weight: 400;"> Copyright © 2024 The Apache Software Foundation. Licensed under the Apache License, Version 2.0. Apache Linkis, Apache Incubator, Apache, the Apache feather logo, the Apache Linkis logo and the Apache Incubator project logo are trademarks of The Apache Software Foundation.</p>
<div></div></div></div></div></div></footer></div>
<script src="/assets/js/runtime~main.36b81271.js"></script>
<script src="/assets/js/main.f09c65a0.js"></script>
</body>
</html>