Files
help365/platform/embedded-to-external-database-enterprise-backupper.html
koziavin 00717a92fb
All checks were successful
Deploy Static Site / deploy (push) Successful in 6m6s
update
2025-05-29 16:42:45 +04:00

243 lines
21 KiB
HTML
Raw Permalink 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>Data migration from embedded to external databases in BRIX Enterprise: customized utility</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="You can migrate data from databases within a Kubernetes cluster to external storages using:" />
<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-enterprise.html">BRIX On-Premises Enterprise</a> / Data migration from embedded to external databases in BRIX Enterprise: customized utility</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Data migration from embedded to external databases in BRIX Enterprise: customized utility</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. -->
<p class="p_Normal">You can migrate data from databases within a Kubernetes cluster to external storages using:</p>
<ul style="list-style-type:disc">
<li class="p_Normal">External tools. Read more in the <a href="embedded-to-external-database-enterprise.html" class="topiclink">Data migration from embedded to external databases in BRIX Enterprise</a> article.</li><li class="p_Normal"><span style="font-weight: bold;">Elma365-Backupper</span> utility.</li></ul>
<p class="p_Normal">The main steps of data migration using <span style="font-weight: bold;">Elma365-Backupper</span> utility:</p>
<ol style="list-style-type:decimal">
<li value="1" class="p_Normal"><a href="embedded-to-external-database-enterprise-backupper.html#backup" class="topiclink">Back up databases</a>.</li><li value="2" class="p_Normal"><a href="embedded-to-external-database-enterprise-backupper.html#update-parameters" class="topiclink">Update BRIX application parameters</a>.</li><li value="3" class="p_Normal"><a href="embedded-to-external-database-enterprise-backupper.html#restore" class="topiclink">Restore databases</a>.</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p class="p_Normal">After migrating databases to external storages, <a href="activate_on_premise.html" class="topiclink">system reactivation</a> is required.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;внимание</span></p>
<h2 class="p_Heading2"><a id="backup" class="hmanchor"></a><span class="f_Heading2">Step 1: Back up databases</span></h2>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Install the <span style="font-weight: bold;">Elma365-Backupper</span> utility and set up its configuration. Read more about it in the <a href="database-backup-and-recovery.html#install-elma365-backupper" class="topiclink">Back up and recover databases</a> article.</li><li value="2" class="p_Normal">Back up the BRIX application databases:</li></ol>
<p class="p_CodeExample" style="white-space: normal; page-break-inside: avoid;"><span class="f_CodeExample">elma365-backupper backup &lt;&lt;db-type&gt;&gt;</span></p>
<p class="p_Normal">Where <code><b>&lt;&lt;db-type&gt;&gt;</b></code> is the name of the database that you want to back up. Value options:</p>
<ul style="list-style-type:disc">
<li class="p_Normal"><code><b>mongo</b></code> specifies MongoDB.</li><li class="p_Normal"><code><b>postgres</b></code> specifies PostgreSQL.</li><li class="p_Normal"><code><b>s3</b></code> specifies S3 storage.</li><li class="p_Normal"><code><b>all</b></code> specifies all databases (MongoDB, PostgreSQL, S3).</li></ul>
<h2 class="p_Heading2"><a id="update-parameters" class="hmanchor"></a><span class="f_Heading2">Step 2: Update BRIX application parameters</span></h2>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Since the <span style="font-weight: bold;">Elma365-Backupper</span> utility gets the database path settings from the <code><b>values-elma365.yaml</b></code> configuration file, <a href="change-settings-enterprise.html#connection-kb" class="topiclink">specify the values of external storages in this file</a>.</li><li value="2" class="p_Normal">Update the BRIX application parameters using the <code><b>values-elma365.yaml</b></code> configuration file.</li></ol>
<p class="p_Normal"><a class="dropdown-toggle" style="font-style: normal; font-weight: normal; color: #000000; background-color: transparent; text-decoration: none;" href="javascript:HMToggle('toggle','TOGGLE0186A1')">Updating parameters via the Internet</a></p>
<div id="TOGGLE0186A1" class="dropdown-toggle-body" style="text-align: left; text-indent: 0; line-height: 1.80; padding: 0 0 0 0; margin: 0 0 0 0;"><table style="border:none; border-spacing:0;">
<tr>
<td style="vertical-align:top; padding:0; border:none"><ol style="list-style-type:decimal">
<li value="1" class="p_Normal">Identify the version of the chart from which the BRIX application was installed or updated:</li></ol>
<p class="p_CodeExample" style="white-space: normal; page-break-inside: avoid;"><span class="f_CodeExample">helm show chart elma365/elma365</span></p>
<p class="p_Normal">&nbsp;<br />
Example of how to execute the command:</p>
<p class="p_Normal"><img alt="embedded-to-external-database-enterprise-1" width="417" height="141" style="margin:0;width:417px;height:141px;border:none" src="embedded-to-external-database-enterprise-1.png"/></p>
<p class="p_Normal">The chart version will be specified in the <code><b>version</b></code> string. Save this value for the next step.</p>
<ol style="list-style-type:decimal" start="2">
<li value="2" class="p_Normal">Update the BRIX application parameters using the <code><b>values-elma365.yaml</b></code> configuration file. To do this, use the following command, specifying the installed chart version for the <code><b>--version</b></code> key instead of <code><b>&lt;elma365-chart-version&gt;</b></code>:</li></ol>
<p class="p_CodeExample" style="white-space: normal; page-break-inside: avoid;"><span class="f_CodeExample">helm upgrade --install elma365 elma365/elma365 -f values-elma365.yaml --version &lt;elma365-chart-version&gt; --timeout=30m --wait [-n namespace]</span></p>
<p class="p_Normal">&nbsp;</p>
</td>
</tr>
</table>
</div>
<p class="p_Normal"><a class="dropdown-toggle" style="font-style: normal; font-weight: normal; color: #000000; background-color: transparent; text-decoration: none;" href="javascript:HMToggle('toggle','TOGGLE0186A2')">Updating parameters without the Internet connection</a></p>
<div id="TOGGLE0186A2" class="dropdown-toggle-body" style="text-align: left; text-indent: 0; line-height: 1.80; padding: 0 0 0 0; margin: 0 0 0 0;"><table style="border:none; border-spacing:0;">
<tr>
<td style="vertical-align:top; padding:0; border:none"><p class="p_Normal">&nbsp;<br />
Go to the folder with the downloaded BRIX chart and run the command:</p>
<p class="p_CodeExample" style="white-space: normal; page-break-inside: avoid;"><span class="f_CodeExample">helm upgrade --install elma365 ./elma365 -f values-elma365.yaml --timeout=30m --wait [-n namespace]</span></p>
<p class="p_Normal">&nbsp;<br />
The parameter upgrade takes 10-30 minutes. Wait for it to complete.</p>
<p class="p_Normal">&nbsp;</p>
</td>
</tr>
</table>
</div>
<h2 class="p_Heading2"><a id="restore" class="hmanchor"></a><span class="f_Heading2">Step 3: Restore databases</span></h2>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Restoring from backup should be done to empty databases and S3 storage. So clean them with the <code><b>--cleanup-databases</b></code> key.</li><li value="2" class="p_Normal">Restore the databases from the last backup:</li></ol>
<p class="p_CodeExample" style="white-space: normal; page-break-inside: avoid;"><span class="f_CodeExample">elma365-backupper restore &lt;&lt;db-type&gt;&gt;</span></p>
<p class="p_Normal">Where <code><b>&lt;&lt;db-type&gt;&gt;</b></code> is the name of the database for which you want to get a list of backups. Value options:</p>
<ul style="list-style-type:disc">
<li class="p_Normal"><code><b>mongo</b></code> specifies MongoDB.</li><li class="p_Normal"><code><b>postgres</b></code> specifies PostgreSQL.</li><li class="p_Normal"><code><b>s3</b></code> specifies S3 storage.</li><li class="p_Normal"><code><b>all</b></code> specifies all databases (MongoDB, PostgreSQL, S3).</li></ul>
<ol style="list-style-type:upper-roman" start="3">
<li value="3" class="p_Normal"><a href="activate_on_premise.html" class="topiclink">Reactivate the system</a>.</li></ol>
<p class="p_Normal">&nbsp;</p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="embedded-to-external-database-enterprise.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">embedded-to-external-database-enterprise.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="enable-portable-services.html">
<span class="bottom-nav__link">enable-portable-services.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>
<script type="text/javascript">
HMInitToggle('TOGGLE0186A1','hm.type','dropdown','hm.state','0');
HMInitToggle('TOGGLE0186A2','hm.type','dropdown','hm.state','0');
</script>
</body>
</html>