Skip to content

Commit

Permalink
Deployed dcb0df0 to 3.6.0 with MkDocs 1.3.0 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
whitewum committed Oct 9, 2023
1 parent ea4a057 commit 9ce85ef
Show file tree
Hide file tree
Showing 14 changed files with 171 additions and 39 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5694,7 +5694,7 @@ <h2 id="enterprise_edition_350">Enterprise Edition 3.5.0<a class="headerlink" hr
<li><a href="../../../nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore/">Back up and restore</a> support full backup to local.</li>
<li>Add <a href="../../../nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst/">Slow query analyst</a> function.</li>
<li>The <a href="../../../nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/cluster-diagnosis/">Cluster diagnostics</a> formula supports configuration.</li>
<li><a href="../../../nebula-dashboard-ent/4.cluster-operator/operator/config-management/">Config Management</a> support <strong>Add Config</strong>, view the <strong>Effective value</strong> of the current configuration, and <strong>View inconsistent configurations</strong>.</li>
<li><a href="../../../nebula-dashboard-ent/4.cluster-operator/operator/update-config/">Config Management</a> support <strong>Add Config</strong>, view the <strong>Effective value</strong> of the current configuration, and <strong>View inconsistent configurations</strong>.</li>
<li>In the <a href="../../../nebula-dashboard-ent/system-settings/notification-endpoint/">Notification endpoint</a>, the webhook supports configuring the <strong>Webhook request body</strong>.</li>
<li>Support <a href="../../../nebula-dashboard-ent/4.cluster-operator/2.monitor/">custom monitoring panel</a>.</li>
</ul>
Expand Down Expand Up @@ -5788,7 +5788,7 @@ <h2 id="enterprise_edition_340">Enterprise Edition 3.4.0<a class="headerlink" hr
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 11, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 9, 2023</span>


</small>
Expand Down
2 changes: 1 addition & 1 deletion 3.6.0/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5767,7 +5767,7 @@ <h1 id="welcome_to_nebulagraph_360_documentation">Welcome to NebulaGraph 3.6.0 D
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This manual is revised on 2023-10-9, with GitHub commit <a href="https://github.com/vesoft-inc/nebula-docs/commits/v3.6.0">c17c65de9b</a>.</p>
<p>This manual is revised on 2023-10-9, with GitHub commit <a href="https://github.com/vesoft-inc/nebula-docs/commits/v3.6.0">dcb0df07d1</a>.</p>
</div>
<div class="admonition compatibility">
<p class="admonition-title">Compatibility</p>
Expand Down
6 changes: 3 additions & 3 deletions 3.6.0/nebula-dashboard-ent/10.tasks/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5713,22 +5713,22 @@ <h2 id="entry">Entry<a class="headerlink" href="#entry" title="Permanent link">&
<h2 id="running_tasks">Running tasks<a class="headerlink" href="#running_tasks" title="Permanent link">&para;</a></h2>
<p>Click the tab <strong>Running Task</strong> to view the progress of the running tasks.</p>
<ul>
<li>Click a task name to view the ID, node name, type, create time, and operator of the running task. </li>
<li>Click a task name to view the ID, node name, type, create time, and operator of the running task.</li>
<li>Clink <strong>Task information</strong> to view task details.</li>
</ul>
<h2 id="task_history">Task history<a class="headerlink" href="#task_history" title="Permanent link">&para;</a></h2>
<p>Click <strong>Task History</strong> to view all ended tasks.</p>
<ul>
<li>You can filter historical tasks by status, type, date, and time.</li>
<li>On the right side of the target historical task, click <strong>Task information</strong> to view task details, and click <strong>Logs</strong> to view task execution logs.</li>
<li>On the right side of the target historical task, click <strong>Task information</strong> to view task details, click <strong>Logs</strong> to view task execution logs, and click <strong>Retry</strong> to re-execute the failed task.</li>
</ul>

<hr>
<div class="md-source-file">
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 2, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 9, 2023</span>


</small>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5729,6 +5729,13 @@
Manage services in Dashboard
</a>

</li>

<li class="md-nav__item">
<a href="#directory_structure" class="md-nav__link">
Directory structure
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -6036,6 +6043,27 @@ <h2 id="manage_services_in_dashboard">Manage services in Dashboard<a class="head
</code></pre></div>
</li>
</ul>
<h2 id="directory_structure">Directory structure<a class="headerlink" href="#directory_structure" title="Permanent link">&para;</a></h2>
<p>The structure of the Dashboard Enterprise Edition is as follows:</p>
<div class="highlight"><pre><span></span><code>├──<span class="w"> </span>assets<span class="w"> </span><span class="c1"># Static resource files</span>
<span class="w">   </span>└──<span class="w"> </span>...
├──<span class="w"> </span>bin<span class="w"> </span><span class="c1"># System executables</span>
<span class="w">   </span>└──...
├──<span class="w"> </span>CMakeLists.txt<span class="w"> </span><span class="c1"># CMake configuration files</span>
<span class="p">|</span><span class="w"> </span>
├──<span class="w"> </span>data<span class="w"> </span><span class="c1"># Database data files</span>
<span class="w">   </span>└──...
├──<span class="w"> </span>download<span class="w"> </span><span class="c1"># Dependency packages</span>
<span class="w">   </span>└──...
├──<span class="w"> </span>etc<span class="w"> </span><span class="c1"># Configuration files</span>
<span class="w">   </span>└──...
├──<span class="w"> </span>logs<span class="w"> </span><span class="c1"># Log files</span>
<span class="w">   </span>└──...
├──<span class="w"> </span>pids<span class="w"> </span><span class="c1"># Service process files</span>
<span class="w">   </span>└──...
└──<span class="w"> </span>scripts<span class="w"> </span><span class="c1"># Scripts for managing services</span>
<span class="w"> </span>└──...
</code></pre></div>
<h2 id="view_logs">View logs<a class="headerlink" href="#view_logs" title="Permanent link">&para;</a></h2>
<ul>
<li>
Expand Down Expand Up @@ -6074,23 +6102,23 @@ <h2 id="view_logs">View logs<a class="headerlink" href="#view_logs" title="Perma
</tr>
<tr>
<td align="left"><code>access.log</code></td>
<td align="left">Access log. </br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
<td align="left">Access log. Records all request messages for accessing the services, including request time, source address, requested URL, HTTP method, returned HTTP status code, etc.</br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
</tr>
<tr>
<td align="left"><code>error.log</code></td>
<td align="left">Error log. </br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
<td align="left">Error log. Records error messages that occur during service running. This may include runtime errors, system errors, service logic errors, etc.</br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
</tr>
<tr>
<td align="left"><code>severe.log</code></td>
<td align="left">Severe log. </br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
<td align="left">Severe log. Records error messages that could cause the system to crash, or seriously affect the correct functioning of the system. This may include runtime errors, system errors, serious service logic errors, etc.</br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
</tr>
<tr>
<td align="left"><code>slow.log</code></td>
<td align="left">Slow log. </br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
<td align="left">Slow log. Records requests or operations whose execution time exceeds a preset threshold, helping users identify performance bottlenecks.</br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
</tr>
<tr>
<td align="left"><code>stat.log</code></td>
<td align="left">Statistic log. </br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
<td align="left">Statistic log. Records statistical information about the service, the content of which depends on the needs of the application and may include a variety of performance metrics, usage statistics, etc.</br>It takes effect only when the <code>Log.Mode</code> in the Dashboard configuration is <code>file</code>.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -6179,7 +6207,7 @@ <h2 id="next_to_do">Next to do<a class="headerlink" href="#next_to_do" title="Pe
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 7, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 9, 2023</span>


</small>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5746,7 +5746,7 @@ <h3 id="creating_monitoring">Creating Monitoring<a class="headerlink" href="#cre
</div>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>Before using Graph Space Metrics, users need to set <code>enable_space_level_metrics</code> to <code>true</code> in the Graph service. For specific operations, see <a href="../operator/config-management/">Update config</a>.</p>
<p>Before using Graph Space Metrics, users need to set <code>enable_space_level_metrics</code> to <code>true</code> in the Graph service. For specific operations, see <a href="../operator/update-config/">Update config</a>.</p>
</div>
<h3 id="managing_monitoring">Managing Monitoring<a class="headerlink" href="#managing_monitoring" title="Permanent link">&para;</a></h3>
<p>To manage monitoring metric panels, click the <a class="glightbox" href="https://docs-cdn.nebula-graph.com.cn/figures/Setup_cn.png" data-type="image" data-width="100%" data-height="auto" data-desc-position="bottom"><img alt="setup" src="https://docs-cdn.nebula-graph.com.cn/figures/Setup_cn.png" /></a> button in the upper right corner of each panel to modify or delete the panel.</p>
Expand All @@ -5771,7 +5771,7 @@ <h2 id="more_operations">More operations<a class="headerlink" href="#more_operat
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 11, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 9, 2023</span>


</small>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5793,7 +5793,7 @@ <h3 id="create_custom_rules">Create custom rules<a class="headerlink" href="#cre
<tbody>
<tr>
<td>Metric Type</td>
<td>Set a metric type. Metric type includes the node metric type and the service type (graphd,storaged,metad).</td>
<td>Set a metric type. Metric type includes the node metric type, service metric type (graphd,storaged,metad), and graph space metric type.</td>
</tr>
<tr>
<td>Metric Rule</td>
Expand Down Expand Up @@ -5861,7 +5861,7 @@ <h2 id="receiver_configuration">Receiver configuration<a class="headerlink" href
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 11, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 9, 2023</span>


</small>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<meta name="author" content="NebulaGraph">


<link rel="canonical" href="https://docs.nebula-graph.io/3.6.0/nebula-dashboard-ent/4.cluster-operator/operator/config-management/">
<link rel="canonical" href="https://docs.nebula-graph.io/3.6.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config/">

<link rel="icon" href="https://docs-cdn.nebula-graph.com.cn/figures/favicon.ico">
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.5.4">
Expand Down Expand Up @@ -5636,13 +5636,6 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#precautions" class="md-nav__link">
Precautions
</a>

</li>

<li class="md-nav__item">
<a href="#entry" class="md-nav__link">
Entry
Expand Down Expand Up @@ -5685,16 +5678,14 @@



<a href="https://github.com/vesoft-inc/nebula-docs/edit/v3.6.0/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/config-management.md" title="Edit this page" class="md-content__button md-icon">
<a href="https://github.com/vesoft-inc/nebula-docs/edit/v3.6.0/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config.md" title="Edit this page" class="md-content__button md-icon">

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg>
</a>


<h1 id="config_management">Config Management<a class="headerlink" href="#config_management" title="Permanent link">&para;</a></h1>
<p>On <strong>Config Management</strong> page, you can view and update the service configuration files.</p>
<h2 id="precautions">Precautions<a class="headerlink" href="#precautions" title="Permanent link">&para;</a></h2>
<p>You need to restart the corresponding service in the <strong>Service</strong> page after the configuration modification. For details, see <a href="../service/">Service</a>.</p>
<h2 id="entry">Entry<a class="headerlink" href="#entry" title="Permanent link">&para;</a></h2>
<ol>
<li>At the top navigation bar of the Dashboard Enterprise Edition page, click <strong>Cluster Management</strong>.</li>
Expand All @@ -5707,10 +5698,14 @@ <h2 id="modify_configuration">Modify configuration<a class="headerlink" href="#m
<li>Locate the configuration to be modified and click <strong>Edit</strong> in the <strong>Operation</strong> column.</li>
<li>
<p>In the pop-up dialog box, you can modify the <strong>Value</strong> individually. They can also be modified uniformly at the top, and you need to click <strong>Apply To All Services</strong> after modification.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The top of the dialog box displays whether the modification of the parameter requires a restart to take effect. Please restart the corresponding service on the <strong>Services</strong> page. For details, see <a href="../service/">Service</a>.</p>
</div>
<p><a class="glightbox" href="https://docs-cdn.nebula-graph.com.cn/figures/eo_dash_config_230913_en.png" data-type="image" data-width="100%" data-height="auto" data-desc-position="bottom"><img src="https://docs-cdn.nebula-graph.com.cn/figures/eo_dash_config_230913_en.png" width="1000" alt="A screenshot that shows the configuration of dashboard"></a></p>
</li>
<li>
<p>Click <strong>Confirm</strong> after the modification is complete.</p>
<p>Click <strong>Confirm</strong> or <strong>Save and Apply</strong> after the modification is complete.</p>
</li>
</ol>
<h2 id="add_configuration">Add configuration<a class="headerlink" href="#add_configuration" title="Permanent link">&para;</a></h2>
Expand All @@ -5735,7 +5730,7 @@ <h2 id="delete_configuration">Delete configuration<a class="headerlink" href="#d
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 13, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 9, 2023</span>


</small>
Expand Down
14 changes: 13 additions & 1 deletion 3.6.0/nebula-dashboard-ent/8.faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5697,6 +5697,13 @@
Why does it prompt “SSH connection error” when importing a cluster?
</a>

</li>

<li class="md-nav__item">
<a href="#how_to_implement_a_highly_available_architecture" class="md-nav__link">
How to implement a highly available architecture
</a>

</li>

</ul>
Expand Down Expand Up @@ -5772,13 +5779,18 @@ <h2 id="can_i_add_the_nebulagraph_installation_package_manually">"Can I add the
<h2 id="why_does_it_prompt_ssh_connection_error_when_importing_a_cluster">Why does it prompt “SSH connection error” when importing a cluster?<a class="headerlink" href="#why_does_it_prompt_ssh_connection_error_when_importing_a_cluster" title="Permanent link">&para;</a></h2>
<p>If <strong>Service Host</strong> shows <code>127.0.0.1</code>, and your Dashboard and NebulaGraph are deployed on the same machine when authorizing service hosts, the system will prompt "SSH connection error”. You need to change the Host IP of each service to the real machine IP in the configuration files of all NebulaGraph services. For more information, see <a href="../../5.configurations-and-logs/1.configurations/1.configurations/">Configuration management</a>.</p>
<p>If you import a cluster deployed with Docker, it also prompts "SSH connection error". Dashboard does not support importing a cluster deployed with Docker.</p>
<h2 id="how_to_implement_a_highly_available_architecture">How to implement a highly available architecture<a class="headerlink" href="#how_to_implement_a_highly_available_architecture" title="Permanent link">&para;</a></h2>
<p>Users can use third-party high-availability software (e.g. <a href="https://www.haproxy.org/">HAProxy</a>) to implement the high-availability architecture for Dashboard and the high-availability architecture for LM.</p>
<p>For example, you can deploy Dashboard service, database service, Prometheus service, and LM service on multiple machines. Then use HAProxy to implement their respective load balancing.</p>
<p>Then fill in the external interfaces of each service into the configuration of the Dashboard, for example, fill in the external interface information of the database service, Prometheus service, LM service, so as to realize the highly available architecture.</p>
<p>For detailed solutions, you can contact the after-sales staff for consultation.</p>

<hr>
<div class="md-source-file">
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 18, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 9, 2023</span>


</small>
Expand Down
Loading

0 comments on commit 9ce85ef

Please sign in to comment.