Skip to content

Commit

Permalink
Deployed f488eba 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
@ChrisChen2023
ChrisChen2023 committed Oct 30, 2023
1 parent 027a25a commit b889008
Show file tree
Hide file tree
Showing 7 changed files with 155 additions and 75 deletions.
2 changes: 1 addition & 1 deletion 3.6.0/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5737,7 +5737,7 @@
<h1 id="welcome_to_nebulagraph_360_documentation">Welcome to NebulaGraph 3.6.0 Documentation<a class="headerlink" href="#welcome_to_nebulagraph_360_documentation" title="Permanent link">&para;</a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This manual is revised on 2023-10-30, with GitHub commit <a href="https://github.com/vesoft-inc/nebula-docs/commits/v3.6.0">095118b400</a>.</p>
<p>This manual is revised on 2023-10-30, with GitHub commit <a href="https://github.com/vesoft-inc/nebula-docs/commits/v3.6.0">f488eba609</a>.</p>
</div>
<p>NebulaGraph is a distributed, scalable, and lightning-fast graph database. It is the optimal solution in the world capable of hosting graphs with dozens of billions of vertices (nodes) and trillions of edges (relationships) with millisecond latency.</p>
<h2 id="getting_started">Getting started<a class="headerlink" href="#getting_started" title="Permanent link">&para;</a></h2>
Expand Down
16 changes: 0 additions & 16 deletions 3.6.0/nebula-operator/1.introduction-to-nebula-operator/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5072,13 +5072,6 @@
Version limitations
</a>

</li>

<li class="md-nav__item">
<a href="#feature_limitations" class="md-nav__link">
Feature limitations
</a>

</li>

</ul>
Expand Down Expand Up @@ -5735,13 +5728,6 @@
Version limitations
</a>

</li>

<li class="md-nav__item">
<a href="#feature_limitations" class="md-nav__link">
Feature limitations
</a>

</li>

</ul>
Expand Down Expand Up @@ -5837,8 +5823,6 @@ <h3 id="version_limitations">Version limitations<a class="headerlink" href="#ver
<li>Starting from NebulaGraph Operator 0.9.0, logs and data are stored separately. Using NebulaGraph Operator 0.9.0 or later versions to manage a NebulaGraph 2.5.x cluster created with Operator 0.8.0 can cause compatibility issues. You can backup the data of the NebulaGraph 2.5.x cluster and then create a 2.6.x cluster with Operator 0.9.0.</li>
</ul>
</div>
<h3 id="feature_limitations">Feature limitations<a class="headerlink" href="#feature_limitations" title="Permanent link">&para;</a></h3>
<p>The NebulaGraph Operator scaling feature is only available for the Enterprise Edition of NebulaGraph clusters and does not support scaling the Community Edition version of NebulaGraph clusters.</p>
<h2 id="release_note">Release note<a class="headerlink" href="#release_note" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/vesoft-inc/nebula-operator/releases/tag/v1.7.1">Release</a></p>

Expand Down
4 changes: 2 additions & 2 deletions 3.6.0/nebula-operator/2.deploy-nebula-operator/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5835,7 +5835,7 @@ <h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites"
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul>
<li>If using a role-based access control policy, you need to enable <a href="https://kubernetes.io/docs/admin/authorization/rbac">RBAC</a> (optional).</li>
<li>If using a role-based access control policy, you need to enable <a href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/">RBAC</a> (optional).</li>
</ul>
<ul>
<li><a href="https://coredns.io/">CoreDNS</a> is a flexible and scalable DNS server that is <a href="https://github.com/coredns/helm">installed</a> for Pods in NebulaGraph clusters.</li>
Expand Down Expand Up @@ -6102,7 +6102,7 @@ <h2 id="whats_next">What's next<a class="headerlink" href="#whats_next" title="P
<small>

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


</small>
Expand Down
191 changes: 150 additions & 41 deletions ...0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5760,43 +5760,154 @@ <h2 id="create_clusters">Create clusters<a class="headerlink" href="#create_clus
</li>
<li>
<p>Create a file named <code>apps_v1alpha1_nebulacluster.yaml</code>.</p>
<ul>
<li>
<p>To create a NebulaGraph Community cluster</p>
<p>See <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.1/config/samples/apps_v1alpha1_nebulacluster.yaml">community cluster configurations</a>.</p>
<p>??? Info "Expand to show parameter descriptions of community clusters"</p>
<div class="codehilite"><pre><span></span><code>| Parameter | Default value | Description |
| :---- | :--- | :--- |
| `metadata.name` | - | The name of the created NebulaGraph cluster. |
|`spec.console`|-| Configuration of the Console service. For details, see [nebula-console](https://github.com/vesoft-inc/nebula-operator/blob/v1.7.1/doc/user/nebula_console.md#nebula-console).|
| `spec.graphd.replicas` | `1` | The numeric value of replicas of the Graphd service. |
| `spec.graphd.image` | `vesoft/nebula-graphd` | The container image of the Graphd service. |
| `spec.graphd.version` | `v3.6.0` | The version of the Graphd service. |
| `spec.graphd.service` | - | The Service configurations for the Graphd service. |
| `spec.graphd.logVolumeClaim.storageClassName` | - | The log disk storage configurations for the Graphd service. |
| `spec.metad.replicas` | `1` | The numeric value of replicas of the Metad service. |
| `spec.metad.image` | `vesoft/nebula-metad` | The container image of the Metad service. |
| `spec.metad.version` | `v3.6.0` | The version of the Metad service. |
| `spec.metad.dataVolumeClaim.storageClassName` | - | The data disk storage configurations for the Metad service. |
| `spec.metad.logVolumeClaim.storageClassName`|- | The log disk storage configurations for the Metad service.|
| `spec.storaged.replicas` | `3` | The numeric value of replicas of the Storaged service. |
| `spec.storaged.image` | `vesoft/nebula-storaged` | The container image of the Storaged service. |
| `spec.storaged.version` | `v3.6.0` | The version of the Storaged service. |
| `spec.storaged.dataVolumeClaims.resources.requests.storage` | - | Data disk storage size for the Storaged service. You can specify multiple data disks to store data. When multiple disks are specified, the storage path is `/usr/local/nebula/data1`, `/usr/local/nebula/data2`, etc.|
| `spec.storaged.dataVolumeClaims.resources.storageClassName` | - | The data disk storage configurations for Storaged. If not specified, the global storage parameter is applied. |
| `spec.storaged.logVolumeClaim.storageClassName`|- | The log disk storage configurations for the Storaged service.|
| `spec.storaged.enableAutoBalance` | `true` |Whether to balance data automatically. |
|`spec.&lt;metad|storaged|graphd&gt;.securityContext`|`{}`|Defines privilege and access control settings for NebulaGraph service containers. For details, see [SecurityContext](https://github.com/vesoft-inc/nebula-operator/blob/release-1.7/doc/user/security_context.md). |
|`spec.agent`|`{}`| Configuration of the Agent service. This is used for backup and recovery as well as log cleanup functions. If you do not customize this configuration, the default configuration will be used.|
| `spec.reference.name` | - | The name of the dependent controller. |
| `spec.schedulerName` | - | The scheduler name. |
| `spec.imagePullPolicy` | The image policy to pull the NebulaGraph image. For details, see [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy). | The image pull policy in Kubernetes. |
|`spec.logRotate`| - |Log rotation configuration. For more information, see [Manage cluster logs](../8.custom-cluster-configurations/8.4.manage-running-logs.md).|
|`spec.enablePVReclaim`|`false`|Define whether to automatically delete PVCs and release data after deleting the cluster. For more information, see [Reclaim PVs](../8.custom-cluster-configurations/8.2.pv-reclaim.md).|
</code></pre></div>

</li>
</ul>
<p>See <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.1/config/samples/nebulacluster.yaml">community cluster configurations</a>.</p>
<p>The following table describes the parameters in the sample configuration file.</p>
<table>
<thead>
<tr>
<th align="left">Parameter</th>
<th align="left">Default value</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>metadata.name</code></td>
<td align="left">-</td>
<td align="left">The name of the created NebulaGraph cluster.</td>
</tr>
<tr>
<td align="left"><code>spec.console</code></td>
<td align="left">-</td>
<td align="left">Configuration of the Console service. For details, see <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.1/doc/user/nebula_console.md#nebula-console">nebula-console</a>.</td>
</tr>
<tr>
<td align="left"><code>spec.graphd.replicas</code></td>
<td align="left"><code>1</code></td>
<td align="left">The numeric value of replicas of the Graphd service.</td>
</tr>
<tr>
<td align="left"><code>spec.graphd.image</code></td>
<td align="left"><code>vesoft/nebula-graphd</code></td>
<td align="left">The container image of the Graphd service.</td>
</tr>
<tr>
<td align="left"><code>spec.graphd.version</code></td>
<td align="left"><code>v3.6.0</code></td>
<td align="left">The version of the Graphd service.</td>
</tr>
<tr>
<td align="left"><code>spec.graphd.service</code></td>
<td align="left">-</td>
<td align="left">The Service configurations for the Graphd service.</td>
</tr>
<tr>
<td align="left"><code>spec.graphd.logVolumeClaim.storageClassName</code></td>
<td align="left">-</td>
<td align="left">The log disk storage configurations for the Graphd service.</td>
</tr>
<tr>
<td align="left"><code>spec.metad.replicas</code></td>
<td align="left"><code>1</code></td>
<td align="left">The numeric value of replicas of the Metad service.</td>
</tr>
<tr>
<td align="left"><code>spec.metad.image</code></td>
<td align="left"><code>vesoft/nebula-metad</code></td>
<td align="left">The container image of the Metad service.</td>
</tr>
<tr>
<td align="left"><code>spec.metad.version</code></td>
<td align="left"><code>v3.6.0</code></td>
<td align="left">The version of the Metad service.</td>
</tr>
<tr>
<td align="left"><code>spec.metad.dataVolumeClaim.storageClassName</code></td>
<td align="left">-</td>
<td align="left">The data disk storage configurations for the Metad service.</td>
</tr>
<tr>
<td align="left"><code>spec.metad.logVolumeClaim.storageClassName</code></td>
<td align="left">-</td>
<td align="left">The log disk storage configurations for the Metad service.</td>
</tr>
<tr>
<td align="left"><code>spec.storaged.replicas</code></td>
<td align="left"><code>3</code></td>
<td align="left">The numeric value of replicas of the Storaged service.</td>
</tr>
<tr>
<td align="left"><code>spec.storaged.image</code></td>
<td align="left"><code>vesoft/nebula-storaged</code></td>
<td align="left">The container image of the Storaged service.</td>
</tr>
<tr>
<td align="left"><code>spec.storaged.version</code></td>
<td align="left"><code>v3.6.0</code></td>
<td align="left">The version of the Storaged service.</td>
</tr>
<tr>
<td align="left"><code>spec.storaged.dataVolumeClaims.resources.requests.storage</code></td>
<td align="left">-</td>
<td align="left">Data disk storage size for the Storaged service. You can specify multiple data disks to store data. When multiple disks are specified, the storage path is <code>/usr/local/nebula/data1</code>, <code>/usr/local/nebula/data2</code>, etc.</td>
</tr>
<tr>
<td align="left"><code>spec.storaged.dataVolumeClaims.resources.storageClassName</code></td>
<td align="left">-</td>
<td align="left">The data disk storage configurations for Storaged. If not specified, the global storage parameter is applied.</td>
</tr>
<tr>
<td align="left"><code>spec.storaged.logVolumeClaim.storageClassName</code></td>
<td align="left">-</td>
<td align="left">The log disk storage configurations for the Storaged service.</td>
</tr>
<tr>
<td align="left"><code>spec.storaged.enableAutoBalance</code></td>
<td align="left"><code>true</code></td>
<td align="left">Whether to balance data automatically.</td>
</tr>
<tr>
<td align="left"><code>spec.&lt;metad|storaged|graphd&gt;.securityContext</code></td>
<td align="left"><code>{}</code></td>
<td align="left">Defines privilege and access control settings for NebulaGraph service containers. For details, see <a href="https://github.com/vesoft-inc/nebula-operator/blob/release-1.5/doc/user/security_context.md">SecurityContext</a>.</td>
</tr>
<tr>
<td align="left"><code>spec.agent</code></td>
<td align="left"><code>{}</code></td>
<td align="left">Configuration of the Agent service. This is used for backup and recovery as well as log cleanup functions. If you do not customize this configuration, the default configuration will be used.</td>
</tr>
<tr>
<td align="left"><code>spec.reference.name</code></td>
<td align="left">-</td>
<td align="left">The name of the dependent controller.</td>
</tr>
<tr>
<td align="left"><code>spec.schedulerName</code></td>
<td align="left">-</td>
<td align="left">The scheduler name.</td>
</tr>
<tr>
<td align="left"><code>spec.imagePullPolicy</code></td>
<td align="left">The image policy to pull the NebulaGraph image. For details, see <a href="https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy">Image pull policy</a>.</td>
<td align="left">The image pull policy in Kubernetes.</td>
</tr>
<tr>
<td align="left"><code>spec.logRotate</code></td>
<td align="left">-</td>
<td align="left">Log rotation configuration. For more information, see <a href="../../8.custom-cluster-configurations/8.4.manage-running-logs/">Manage cluster logs</a>.</td>
</tr>
<tr>
<td align="left"><code>spec.enablePVReclaim</code></td>
<td align="left"><code>false</code></td>
<td align="left">Define whether to automatically delete PVCs and release data after deleting the cluster. For more information, see <a href="../8.custom-cluster-configurations/8.2.pv-reclaim.md">Reclaim PVs</a>.</td>
</tr>
<tr>
<td align="left"></td>
<td align="left"></td>
<td align="left"></td>
</tr>
</tbody>
</table>
</li>
<li>
<p>Create a NebulaGraph cluster.</p>
Expand All @@ -5817,9 +5928,7 @@ <h2 id="create_clusters">Create clusters<a class="headerlink" href="#create_clus
</li>
</ol>
<h2 id="scaling_clusters">Scaling clusters<a class="headerlink" href="#scaling_clusters" title="Permanent link">&para;</a></h2>
<ul>
<li>The cluster scaling feature is for NebulaGraph Enterprise Edition only. </li>
</ul>
<p>The cluster scaling feature is for NebulaGraph Enterprise Edition only. </p>
<h2 id="delete_clusters">Delete clusters<a class="headerlink" href="#delete_clusters" title="Permanent link">&para;</a></h2>
<p>Run the following command to delete a NebulaGraph cluster with Kubectl:</p>
<div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>delete<span class="w"> </span>-f<span class="w"> </span>apps_v1alpha1_nebulacluster.yaml
Expand All @@ -5832,7 +5941,7 @@ <h2 id="whats_next">What's next<a class="headerlink" href="#whats_next" title="P
<small>

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


</small>
Expand Down
17 changes: 2 additions & 15 deletions 3.6.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5794,23 +5794,10 @@ <h2 id="create_clusters">Create clusters<a class="headerlink" href="#create_clus
<p>Check the status of the NebulaGraph cluster you created.</p>
<div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>-n<span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">NEBULA_CLUSTER_NAMESPACE</span><span class="si">}</span><span class="s2">&quot;</span><span class="w"> </span>get<span class="w"> </span>pod<span class="w"> </span>-l<span class="w"> </span><span class="s2">&quot;app.kubernetes.io/cluster=</span><span class="si">${</span><span class="nv">NEBULA_CLUSTER_NAME</span><span class="si">}</span><span class="s2">&quot;</span>
</code></pre></div>
<p>Output:</p>
<div class="highlight"><pre><span></span><code>NAME<span class="w"> </span>READY<span class="w"> </span>STATUS<span class="w"> </span>RESTARTS<span class="w"> </span>AGE
nebula-graphd-0<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span>Running<span class="w"> </span><span class="m">0</span><span class="w"> </span>5m34s
nebula-graphd-1<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span>Running<span class="w"> </span><span class="m">0</span><span class="w"> </span>5m34s
nebula-metad-0<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span>Running<span class="w"> </span><span class="m">0</span><span class="w"> </span>5m34s
nebula-metad-1<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span>Running<span class="w"> </span><span class="m">0</span><span class="w"> </span>5m34s
nebula-metad-2<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span>Running<span class="w"> </span><span class="m">0</span><span class="w"> </span>5m34s
nebula-storaged-0<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span>Running<span class="w"> </span><span class="m">0</span><span class="w"> </span>5m34s
nebula-storaged-1<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span>Running<span class="w"> </span><span class="m">0</span><span class="w"> </span>5m34s
nebula-storaged-2<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span>Running<span class="w"> </span><span class="m">0</span><span class="w"> </span>5m34s
</code></pre></div>
</li>
</ol>
<h2 id="scaling_clusters">Scaling clusters<a class="headerlink" href="#scaling_clusters" title="Permanent link">&para;</a></h2>
<ul>
<li>The cluster scaling feature is for NebulaGraph Enterprise Edition only. </li>
</ul>
<p>The cluster scaling feature is for NebulaGraph Enterprise Edition only.</p>
<h2 id="delete_clusters">Delete clusters<a class="headerlink" href="#delete_clusters" title="Permanent link">&para;</a></h2>
<p>Run the following command to delete a NebulaGraph cluster with Helm:</p>
<div class="highlight"><pre><span></span><code>helm<span class="w"> </span>uninstall<span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">NEBULA_CLUSTER_NAME</span><span class="si">}</span><span class="s2">&quot;</span><span class="w"> </span>--namespace<span class="o">=</span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">NEBULA_CLUSTER_NAMESPACE</span><span class="si">}</span><span class="s2">&quot;</span>
Expand All @@ -5826,7 +5813,7 @@ <h2 id="whats_next">What's next<a class="headerlink" href="#whats_next" title="P
<small>

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


</small>
Expand Down
Binary file modified 3.6.0/pdf/NebulaGraph-EN.pdf
View file
Binary file not shown.
Binary file modified 3.6.0/sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit b889008

Please sign in to comment.