Files
help365/platform/elma365-standard-administering.html
2025-05-27 21:32:35 +04:00

323 lines
25 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>Administering BRIX Standard</title>
<meta name="generator" content="Help+Manual" />
<meta name="keywords" content="" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Update certificates for Kubernetes cluster During the update of BRIX Standard, automatic updating of Kubernetes cluster certificates is performed. You can also manually..." />
<meta name="picture" content="" />
<meta property="og:type" content="website" />
<meta property="og:title" content="Full documentation for BRIX365 platform. Low-code developer guide. User guide. Admin guide. Developer guide." />
<meta property="og:url" content="https://brix365.com/en/help" />
<meta property="og:image" content="" />
<link rel="icon" href="favicon.png" type="image/png" />
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />
<link rel="stylesheet" href="./jquery-ui.min.css" />
<link rel="stylesheet" href="default.css" />
<link rel="stylesheet" href="./search-yandex.css" />
<link rel="stylesheet" href="./article.css" />
<link rel="stylesheet" href="./glossary.css" />
<link rel="stylesheet" href="./theme.css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="helpman_settings.js"></script>
<script type="text/javascript" src="helpman_topicinit.js"></script>
<script type="text/javascript" src="highlight.js"></script>
<script type="text/javascript">
$(document).ready(function(){highlight();});
</script>
</head>
<body>
<script>!function(e,t,c,n,r,a,m){e.ym=e.ym||function(){(e.ym.a=e.ym.a||[]).push(arguments)},e.ym.l=1*new Date;for(var s=0;s<document.scripts.length;s++)if(document.scripts[s].src===n)return;a=t.createElement(c),m=t.getElementsByTagName(c)[0],a.async=1,a.src=n,m.parentNode.insertBefore(a,m)}(window,document,"script","https://mc.yandex.ru/metrika/tag.js"),ym(83179930,"init",{clickmap:!0,trackLinks:!0,accurateTrackBounce:!0,webvisor:!0})</script><noscript><div><img alt=""src=https://mc.yandex.ru/watch/83179930 style=position:absolute;left:-9999px></div></noscript>
<header class="header elma-365">
<div class="container">
<a class="header__logo" href="https://brix365.com/en/help">
<img src="./logo-en.svg" alt="header logo">
</a>
<!-- <div class="hero__search-form" id="search-panel">
<form class="search-form" onsubmit="ym(83180416,'reachGoal','poisk')">
<label class="search-form__label">
<span id="reset-search" class="search__icon"></span>
<input class="search-form__input" type="text">
</label>
<input class="search-form__submit" type="submit" value="Submit">
</form>
</div> -->
<div class="hero__search-form" id="search-panel"> <form class="search-form"> <label class="search-form__label"> <span id="reset-search" class="search__icon"></span> <input class="search-form__input" type="text"> </label> <input class="search-form__submit" type="submit" value="Submit"> </form> </div>
<div class="hero__search">
<a href="#" id="search-icon" class="hero__search-icon">
<img src="search-icon-white.svg" alt="search string">
</a>
<a href="#" id="side-menu-icon" class="hero__side-icon">
<img src="side_menu.svg" alt="side menu">
</a>
</div>
<div class="header__navi">
<ul class="header__list"><li><span class="solution-select"><span class="solution-select__selected"></span><svg width="7" height="4" viewBox="0 0 7 4" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L3.5 3.5L6 1" stroke="white" stroke-linecap="round" stroke-linejoin="round"/></svg><ul class="solution-select__list"><li><a class="project-link" href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a class="project-link" href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a class="project-link" href="https://brix365.com/en/help/crm/crm_overview.html">CRM</a></li><li><a class="project-link" href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a class="project-link" href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li><li><a class="project-link" href="https://brix365.com/en/help/business_solutions/-elma365-store.html">Business Solutions</a></li></ul></span></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li><li><a href="https://tssdk.brix365.com/" target="_blank">SDK</a></li></ul>
</div>
</div>
</header>
<main class="main container">
<aside class="sidebar" id="sidebar">
<div class="sidebar__header">
<a class="header__logo" href="https://brix365.com/en/help">
<img src="./logo-light-en.svg">
</a>
<span class="sidebar__close elma-365-close" id="close"></span>
</div>
<div class="sidebar__wrapper" id="side-menu">
</div>
</aside>
<article class="article" id="article">
<div class="article-inner">
<div class="content">
<header class="article__header">
<div class="article__bread" style="display:flex; gap:10px;">
<span id="subcategory" class="search-res__item-category search-res__item-category_subcategory subcategory article__badge"></span>
<div class="topic__breadcrumbs">
<p><a href="elma365-on-premises.html">BRIX On-Premises</a> &gt; <a href="elma365-on-premises-standard.html">BRIX On-Premises Standard</a> / Administering BRIX Standard</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Administering BRIX Standard</span></h1>
</div>
</header>
<section class="article__content">
<div class="scroll-top-inner">
<a href="#h1-article" class="scroll-top"></a>
</div>
<!-- Placeholder for topic body. -->
<h2 class="p_Heading2"><span class="f_Heading2">Update certificates for Kubernetes cluster</span></h2>
<p class="p_Normal">During the update of BRIX Standard, automatic updating of Kubernetes cluster certificates is performed. You can also manually initiate the update by executing the installation command with the <code><b>--renew-certs-k8s</b></code> key.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--renew-certs-k8s</span></p>
<h2 class="p_Heading2"><span class="f_Heading2">Reinstall BRIX Standard</span></h2>
<p class="p_Normal">To reinstall BRIX, run the installation script with the <code><b>--reset</b></code> key.</p>
<p class="p_Normal"><span style="font-weight: bold;">For online installation</span>:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--reset</span></p>
<p class="p_Normal"><span style="font-weight: bold;">For offline installation without internet access</span>:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--offline&nbsp;--reset</span></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p class="p_Normal">When running the script, all data stored in BRIX Standard (KinD) will be deleted.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;внимание</span></p>
<h2 class="p_Heading2"><span class="f_Heading2">Clean the node for subsequent installation of BRIX Standard</span></h2>
<p class="p_Normal">To clean the host node for subsequent installation of BRIX Standard (KinD), run the installation script with the <code><b>--delete</b></code> key:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--delete</span></p>
<h2 class="p_Heading2"><a id="troubleshooting" class="hmanchor"></a><span class="f_Heading2">Diagnostics and troubleshooting</span></h2>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Collect diagnostic information.</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p class="p_Normal">For accurate collection of network status diagnostic information, the script requires the <code><b>net-tools</b></code> utility.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;внимание</span></p>
<p class="p_Normal">To collect diagnostic information about the system status, run the installation script <code><b>elma365-installer-docker.sh</b></code> with the <code><b>--diag</b></code> key:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--diag</span></p>
<p class="p_Normal">After starting, the installation script will determine the version of the installed BRIX Standard (KinD) and offer a method to save diagnostics.</p>
<p class="p_Normal">To continue with the diagnostics collection, enter one of the options:</p>
<p class="p_Normal"><code><b>[S]</b></code>. Collect and upload diagnostic information to the BRIX server.</p>
<p class="p_Normal">The installation script will return a link to download the diagnostic information. Example link: <code><b>https://nc.elma365.tech/iuq1fg.txt</b></code>.</p>
<p class="p_Normal"><code><b>[F]</b></code>. Collect and save to a file on a local disk.</p>
<p class="p_Normal">The installation script will provide a path to the file with diagnostic information, for example, <code><b>/root/elma365-2023.2.15/elma365-diagnostic-20230410-142556</b></code>.</p>
<p class="p_Normal">The installation script will then collect the diagnostic information.</p>
<ol style="list-style-type:upper-roman" start="2">
<li value="2" class="p_Normal">Generate logs and check service status.</li></ol>
<p class="p_Normal">To get logs from application services, run the command:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">docker&nbsp;exec&nbsp;elma365&nbsp;kubectl&nbsp;logs&nbsp;-l&nbsp;tier=elma365&nbsp;--all-containers&nbsp;&gt;&nbsp;logs.txt</span></p>
<p class="p_Normal">To view logs from a specific service, replace <code><b>[name]</b></code> with the desired service:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;примера</span></p>
<p class="p_Normal">Example:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">docker&nbsp;exec&nbsp;elma365&nbsp;kubectl&nbsp;logs&nbsp;-l&nbsp;app=main</span></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;примера</span></p>
<p class="p_Normal">To view logs in real-time, add the <code><b>-f</b></code> option.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;примера</span></p>
<p class="p_Normal">Example:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">docker&nbsp;exec&nbsp;elma365&nbsp;kubectl&nbsp;logs&nbsp;-l&nbsp;app=main&nbsp;-f</span></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;примера</span></p>
<p class="p_Normal">To check the status of services, run the command:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">docker&nbsp;exec&nbsp;elma365&nbsp;kubectl&nbsp;get&nbsp;pod</span></p>
<p class="p_Normal">The result will be displayed in a table format with a list of services. Services should be in the <span style="font-weight: bold;">Running</span> status, and tasks should be in the <span style="font-weight: bold;">Completed</span> status.</p>
<h2 class="p_Heading2"><span class="f_Heading2">List of available commands for elma365-installer-docker.sh</span></h2>
<p class="p_Normal">To view the list of all available commands, run the installation script with the key <code><b>--help</b></code>:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--help</span></p>
<p class="p_Normal"><span style="font-weight: bold;">Доступные команды</span>:</p>
<div style="text-align: left; text-indent: 0; line-height: 1.80; padding: 0 0 0 0; margin: 0 0 0 0;"><table style="background-color:#ffffff; border:none; border-spacing:0;">
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--new-config</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Create a new installation configuration file: <code><b>config-elma365.txt</b></code></p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--diag</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Collect diagnostic information</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; height:3px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--install</span></p>
</td>
<td style="vertical-align:top; width:885px; height:3px; padding:1px; border:none"><p class="p_Normal">Installing BRIX</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--offline</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Offline installation of BRIX</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; height:19px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--upgrade</span></p>
</td>
<td style="vertical-align:top; width:885px; height:19px; padding:1px; border:none"><p class="p_Normal">Update BRIX</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; height:19px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--stop</span></p>
</td>
<td style="vertical-align:top; width:885px; height:19px; padding:1px; border:none"><p class="p_Normal">Stop BRIX application</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; height:19px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--start</span></p>
</td>
<td style="vertical-align:top; width:885px; height:19px; padding:1px; border:none"><p class="p_Normal">Start BRIX application</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--dump</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Database backup to <code><b>/backup/ELMA365</b></code> folder with version and timestamp</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--restore</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Restore the database backup from the archive</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--reset</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Reinstall BRIX (all data will be deleted)</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p style="line-height: 1.20;"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--delete</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Delete BRIX (all data will be deleted)</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p class="p_Normal"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--reconfigure</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Reconfigure the BRIX application</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p class="p_Normal"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--reload-cert</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Renew HTTPS certificates for the BRIX application</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p class="p_Normal"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--renew-certs-k8s</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Renew the certificates for the Kubernetes cluster</p>
</td>
</tr>
<tr>
<td style="vertical-align:top; width:163px; padding:1px; border:none"><p class="p_Normal"><span style="font-size: 13px; font-family: 'Courier New',Courier,monospace; font-weight: bold;">--debug</span></p>
</td>
<td style="vertical-align:top; width:885px; padding:1px; border:none"><p class="p_Normal">Enable the installation debugging mode</p>
</td>
</tr>
</table>
</div>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="embedded-to-external-database-standard.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">embedded-to-external-database-standard.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="migration-to-another-server.html">
<span class="bottom-nav__link">migration-to-another-server.html</span> <span
class="bottom-nav__arrow bottom-nav__arrow--next"></span>
</a>
</div>
<!-- добавляет на страницу строку блок Была ли статья полезной? -->
<div class="feedback" id="feedback"><div class="feedback-help"><span><b>Was this helpful?</b></span><form action="" method="POST" class="feedback-form" id="feedback-form"><div class="feedback__popup feedback__popup-response" id="feedback__popup_thx" style="display: none;">Thanks for your feedback!</div><div class="feedback__popup" id="feedback__popup_why" style="display: none;"><div class="feedback__popup-header">Please specify why:</div><input type="radio" name="category" id="bad_recommendation" value="bad_recommendation"><label for="bad_recommendation">Recommendations did not help me</label><input type="radio" name="category" id="difficult_text" value="difficult_text"><label for="difficult_text">Article is hard to understand</label><input type="radio" name="category" id="no_answer" value="no_answer"><label for="no_answer">Didn`t answer my question</label><input type="radio" name="category" id="bad_header" value="bad_header"><label for="bad_header">Content does not match the topic</label><input type="radio" name="category" id="other_reason" value="other_reason"><label for="other_reason">Other</label></div><div class="feedback__popup" id="feedback__popup-other" style="display: none;"><div class="feedback__popup-header">How we can improve it?</div><textarea class="feedback__textarea" name="other" id=""></textarea><input type="submit" class="feedback__other-btn" value="Submit"></div><div class="feedback-form__btn-group"><input type="radio" name="useful" id="feedback__useful_yes" value="true"><label for="feedback__useful_yes"><img src="like.svg" class="small-img" alt="like"><spanclass="feedback-form__btn-group_yes-btn">Yes</spanclass="feedback-form__btn-group_yes-btn"></label><input type="radio" name="useful" id="feedback__useful_no" value="false"><label for="feedback__useful_no"><img src="dislike.svg" class="small-img" alt="dislike"><spanclass="feedback-form__btn-group_no-btn">No</spanclass="feedback-form__btn-group_no-btn"></label></div><select name="category"><option disabled="">Please specify why</option><option value="bad_recommendation" selected="">Recommendations did not help me</option><option value="difficult_text">Article is hard to understand</option><option value="no_answer">Didn`t answer my question</option><option value="bad_header">Content does not match the topic</option><option value="other_reason">Other</option></select><input type="submit"></form></div><div class="found_typo"><p style="margin: 0px; margin-top: 16px !important;"><span><b>Found a typo?</b></span> Select it and press <i>Ctrl+Enter</i> to send us feedback</p></div></div>
</section>
</div>
<aside class="article__sidebar" style="display:none">
<input type="checkbox" />
<div class="article__arrow"></div>
<div class="table-of-contents elma365-right" id="toc2Content">
<h3 class="h3-toc">In this topic</h3>
<nav id="toc2"></nav>
</div>
</aside>
</div>
</article>
</main>
<footer class="footer">
<div class="footer-container">
<div class="footer-mobile">
<ul class="footer-mobile__list"><li><a href="https://brix365.com/en/" target="_blank">BRIX</a></li><li><a href="https://tssdk.brix365.com/en/latest/" target="_blank">SDK</a></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li></ul><ul class="footer-mobile__list"><li><a href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li></ul>
</div>
<div class="footer-wrap">
<div><span class="mobile-question-popup">Send feedback</span><form method="POST" action class="question__popup question-xs" id="question__popup"><div class="question-wrap"><span class="close"></span><span class="title">Ask a question</span><label for="help_question" style="display: none;"></label><textarea name="help_question" id="help_question"></textarea><input type="submit" value="Send"></div></form><div class="hidden fade-in question-success-xs">Sent</div></div>
<div class="footer-flex-b">
<span class="footer-copy">&copy; 2025 BRIX</span>
<ul class="footer-list">
<li class="footer-item">
<a href="#" class="arrow-top" style="display: block;"></a>
</li>
</ul>
</div>
</div>
</div>
</footer>
<iframe name="hmnavigation" style="display:none!important"></iframe>
<script src="./jquery-ui.js"></script>
<!--script src="//cdn.jsdelivr.net/npm/featherlight@1.7.14/release/featherlight.min.js" type="text/javascript" charset="utf-8"></script-->
<script src="./jquery.tocify.min.js"></script>
<script src="./TypoReporter.min.js"></script>
<script src="./google-search.js"></script>
<script src="./main.js"></script>
</body>
</html>