Files
help365/platform/version-update-enterprise.html
2025-05-27 21:32:35 +04:00

237 lines
23 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>Update version of BRIX Enterprise</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="To ensure data integrity when migrating with a version change of the BRIX edition, it is recommended to update each major version without skipping any. For instance, version..." />
<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> / Update version of BRIX Enterprise</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Update version of BRIX Enterprise</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">To ensure data integrity when migrating with a version change of the BRIX edition, it is recommended to update each <a href="version-support-elma365-on-premises.html#major" class="topiclink">major</a> version without skipping any. For instance, version 2025.<span style="font-weight: bold;">2</span>.1 can be updated to 2025.<span style="font-weight: bold;">3</span>.1.</p>
<p class="p_Normal">The BRIX Enterprise update process consists of the following stages:</p>
<ol style="list-style-type:decimal">
<li value="1" class="p_Normal"><a href="version-update-enterprise.html#definition-of-steps" class="topiclink">Determine the number of update steps</a>.</li><li value="2" class="p_Normal"><a href="version-update-enterprise.html#copying-config-file" class="topiclink">Copy the configuration file from the currently installed version</a>.</li><li value="3" class="p_Normal"><a href="version-update-enterprise.html#change-timeouts" class="topiclink">Change the preset timeout values for data migration (optional)</a>.</li><li value="4" class="p_Normal"><a href="version-update-enterprise.html#update-with-helm" class="topiclink">Update using Helm in the Kubernetes cluster for the BRIX application</a>.</li></ol>
<h2 class="p_Heading2"><a id="definition-of-steps" class="hmanchor"></a><span class="f_Heading2">Step 1: Determine the number of update steps</span></h2>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Determine the version of the installed chart with which the BRIX application was previously deployed or updated:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;show&nbsp;chart&nbsp;elma365/elma365</span></p>
<ol style="list-style-type:upper-roman" start="2">
<li value="2" class="p_Normal">Determine the version of the latest chart:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;repo&nbsp;add&nbsp;elma365&nbsp;https:</span><span class="f_CodeExample">//charts.elma365.tech</span><br />
<span class="f_CodeExample">helm&nbsp;repo&nbsp;update</span><br />
<span class="f_CodeExample">helm&nbsp;search&nbsp;repo&nbsp;elma365/elma365</span></p>
<ol style="list-style-type:upper-roman" start="3">
<li value="3" class="p_Normal" style="line-height: 1.20;">If you need to update your chart for more than one version, install each major version until you reach the latest chart.</li></ol>
<p class="p_Normal" style="line-height: 1.20;"><span style="font-weight: bold;">Important</span>: in each version, it is required to install the latest <a href="version-support-elma365-on-premises.html#minor" class="topiclink">minor</a> release.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;примера</span></p>
<p class="p_Normal">Examples</p>
<ol style="list-style-type:decimal">
<li value="1" class="p_Normal">Installed chart version 2025.<span style="font-weight: bold;">3</span>.2, current (latest) chart version 2025.<span style="font-weight: bold;">4</span>.1. The update is done in one step: directly to 2025.<span style="font-weight: bold;">4</span>.1.</li><li value="2" class="p_Normal">Installed chart version 2025.<span style="font-weight: bold;">1</span>.29, current (latest) chart version 2025.<span style="font-weight: bold;">4</span>.1. The update is done in three steps: 2025.<span style="font-weight: bold;">1</span>.29 &gt; 2025.<span style="font-weight: bold;">2</span>.16 &gt; 2025.<span style="font-weight: bold;">3</span>.2 &gt; 2025.<span style="font-weight: bold;">4</span>.1.</li><li value="3" class="p_Normal">Installed chart version 2024.<span style="font-weight: bold;">11</span>.46, current (latest) chart version 2025.<span style="font-weight: bold;">4</span>.1. The update is done in four steps: 2024.<span style="font-weight: bold;">11</span>.46 &gt; 2025.<span style="font-weight: bold;">1</span>.32 &gt; 2025.<span style="font-weight: bold;">2</span>.16 &gt; 2025.<span style="font-weight: bold;">3</span>.2 &gt; 2025.<span style="font-weight: bold;">4</span>.1.</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;примера</span></p>
<p class="p_Normal">Please note that your current version in an LTS version, you can update directly to the next LTS version according to the <a href="version-support-elma365-on-premises.html#lts_schedule" class="topiclink">release life cycle schedule</a>.</p>
<p class="p_Normal">To see the list of all BRIX versions, use the following command:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;repo&nbsp;add&nbsp;elma365&nbsp;https:</span><span class="f_CodeExample">//charts.elma365.tech</span><br />
<span class="f_CodeExample">helm&nbsp;repo&nbsp;update</span><br />
<span class="f_CodeExample">helm&nbsp;search&nbsp;repo&nbsp;elma365/elma365&nbsp;--versions</span></p>
<p class="p_Normal">You can also download a <span style="font-weight: bold;">.tar.gz</span> file with a specific BRIX version using the links provided in <a href="links-for-install-elma365.html#links-for-install-helm-offline" class="topiclink">Links for downloading BRIX distribution packages</a>.</p>
<h2 class="p_Heading2"><a id="copying-config-file" class="hmanchor"></a><span class="f_Heading2">Step 2: Copy the configuration file from the currently installed version</span></h2>
<p class="p_Normal">Copy the configuration file <code><b>values-elma365.yaml</b></code> to the current directory. Use this file saved at the installation stage or the last update.</p>
<p class="p_Normal">If the <code><b>values-elma365.yaml</b></code> file was lost, retrieve the parameters of the current BRIX installation and save them into this file by executing the command: </p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;get&nbsp;values&nbsp;elma365&nbsp;[-n&nbsp;namespace]&nbsp;&gt;&nbsp;values-elma365.yaml</span></p>
<p class="p_Normal">Note that from version 2023.4.30, the structure of the <code><b>values-elma365.yaml</b></code> configuration file has been updated.</p>
<p class="p_Normal">If you are updating from 2023.4.0-21 or earlier versions to 2023.4.30 or newer versions, you need to:</p>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Obtain the updated <code><b>values-elma365.yaml</b></code> configuration file by executing the command.</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;show&nbsp;values&nbsp;elma365/elma365&nbsp;&gt;&nbsp;values-elma365.yaml</span></p>
<ol style="list-style-type:upper-roman" start="2">
<li value="2" class="p_Normal">Manually transfer the application parameters from the old sample <code><b>values-elma365.yaml</b></code> configuration file (versions prior to 2023.4.30) to the new configuration file.</li></ol>
<h2 class="p_Heading2"><a id="change-timeouts" class="hmanchor"></a><span class="f_Heading2">Step 3: Change the preset timeout values for data migration (optional)</span></h2>
<p class="p_Normal">To ensure correct update, you specify the timeout for data migration in the commands. This time depends on the amount of information accumulated in the databases. Before starting the update:</p>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Estimate the amount of data.</li><li value="2" class="p_Normal">Open the <code><b>values-elma365.yaml</b></code> configuration file and change the preset parameters:</li></ol>
<ul style="list-style-type:disc">
<li class="p_Normal"><code><b>global.curlMigrationsMaxTime</b></code>. Default setting is <code><b>3000</b></code>. For example, increase the value to <code><b>18000</b></code>.</li><li class="p_Normal"><code><b>deploy.appconfig.migrateTimeout</b></code>. Default setting is <code><b>1h</b></code>. Uncomment the parameter and set a new value, for example, <code><b>3h</b></code>. The value of this parameter should be the same as the <code><b>--timeout</b></code> in the update command in step 4.</li></ul>
<ol style="list-style-type:upper-roman" start="3">
<li value="3" class="p_Normal">Proceed to the next step of the update.</li></ol>
<h2 class="p_Heading2"><a id="update-with-helm" class="hmanchor"></a><span class="f_Heading2">Step 4: Update using Helm in the Kubernetes cluster for the BRIX application</span></h2>
<p class="p_Normal">Execute the update of the BRIX application using the configuration file <code><b>values-elma365.yaml</b></code>. To do this:</p>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Sequentially perform the update for each intermediate minor version if there are intermediate minor versions (two or more update steps):</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;upgrade&nbsp;--install&nbsp;elma365&nbsp;elma365/elma365&nbsp;-f&nbsp;values-elma365.yaml&nbsp;--version&nbsp;&lt;elma365-chart-version&gt;&nbsp;--timeout=30m&nbsp;--wait&nbsp;[-n&nbsp;namespace]</span></p>
<p class="p_Normal">The <code><b>--timeout</b></code> parameter defines the timeout for data update. It must match the value of <code><b>deploy.appconfig.migrateTimeout</b></code> if you changed it in the configuration file in step 3.</p>
<p class="p_Normal">If the data volume is small, updating the application takes 10-30 minutes at each step. </p>
<ol style="list-style-type:upper-roman" start="2">
<li value="2" class="p_Normal">Perform the update to the latest version:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">helm&nbsp;upgrade&nbsp;--install&nbsp;elma365&nbsp;elma365/elma365&nbsp;-f&nbsp;values-elma365.yaml&nbsp;--timeout=30m&nbsp;--wait&nbsp;[-n&nbsp;namespace]</span></p>
<p class="p_Normal">The <code><b>--timeout</b></code> parameter defines the timeout for data update. It must match the value of <code><b>deploy.appconfig.migrateTimeout</b></code> if you changed it in the configuration file in step 3.</p>
<p class="p_Normal">If the data volume is small, updating t<span style="font-size: 15px; font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; background-color: #ffffff;">he application takes 10-30 minutes. Wait for the update of the BRIX Enterprise application version to complete.</span></p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="affinity-antiaffinity.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">affinity-antiaffinity.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="offline-version-update-enterprise.html">
<span class="bottom-nav__link">offline-version-update-enterprise.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>