Skip to content

Commit

Permalink
Deployed 634fe25 to 3.6.0 with MkDocs 1.5.3 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisChen2023 committed Nov 28, 2023
1 parent 24662cf commit 4adba32
Show file tree
Hide file tree
Showing 17 changed files with 313 additions and 304 deletions.
2 changes: 1 addition & 1 deletion 3.6.0/20.appendix/6.eco-tool-version/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8296,7 +8296,7 @@ <h2 id="nebulagraph_operator">NebulaGraph Operator<a class="headerlink" href="#n
<tbody>
<tr>
<td align="left">v3.6.0</td>
<td align="left">v1.7.2</td>
<td align="left">v1.7.3</td>
</tr>
</tbody>
</table>
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 @@ -8103,7 +8103,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-11-22, with GitHub commit <a href="https://github.com/vesoft-inc/nebula-docs/commits/v3.6.0">8633a38093</a>.</p>
<p>This manual is revised on 2023-11-28, with GitHub commit <a href="https://github.com/vesoft-inc/nebula-docs/commits/v3.6.0">634fe25aa0</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
Original file line number Diff line number Diff line change
Expand Up @@ -8192,7 +8192,7 @@ <h3 id="version_limitations">Version limitations<a class="headerlink" href="#ver
</ul>
</div>
<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.2">Release</a></p>
<p><a href="https://github.com/vesoft-inc/nebula-operator/releases/tag/v1.7.3">Release</a></p>

<hr>
<div class="md-source-file">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8155,10 +8155,10 @@ <h2 id="steps">Steps<a class="headerlink" href="#steps" title="Permanent link">&
<p>Install NebulaGraph Operator.</p>
<div class="highlight"><pre><span></span><code>helm<span class="w"> </span>install<span class="w"> </span>nebula-operator<span class="w"> </span>nebula-operator/nebula-operator<span class="w"> </span>--namespace<span class="o">=</span>&lt;namespace_name&gt;<span class="w"> </span>--version<span class="o">=</span><span class="si">${</span><span class="nv">chart_version</span><span class="si">}</span>
</code></pre></div>
<p>For example, the command to install NebulaGraph Operator of version 1.7.2 is as follows.</p>
<div class="highlight"><pre><span></span><code>helm<span class="w"> </span>install<span class="w"> </span>nebula-operator<span class="w"> </span>nebula-operator/nebula-operator<span class="w"> </span>--namespace<span class="o">=</span>nebula-operator-system<span class="w"> </span>--version<span class="o">=</span><span class="m">1</span>.7.2
<p>For example, the command to install NebulaGraph Operator of version 1.7.3 is as follows.</p>
<div class="highlight"><pre><span></span><code>helm<span class="w"> </span>install<span class="w"> </span>nebula-operator<span class="w"> </span>nebula-operator/nebula-operator<span class="w"> </span>--namespace<span class="o">=</span>nebula-operator-system<span class="w"> </span>--version<span class="o">=</span><span class="m">1</span>.7.3
</code></pre></div>
<p><code>1.7.2</code> is the version of the nebula-operator chart. When not specifying <code>--version</code>, the latest version of the nebula-operator chart is used by default. </p>
<p><code>1.7.3</code> is the version of the nebula-operator chart. When not specifying <code>--version</code>, the latest version of the nebula-operator chart is used by default. </p>
<p>Run <code>helm search repo -l nebula-operator</code> to see chart versions.</p>
<p>You can customize the configuration items of the NebulaGraph Operator chart before running the installation command. For more information, see <a href="../../3.operator-management/3.1.customize-installation/">Customize installation defaults</a>.</p>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8142,7 +8142,7 @@ <h2 id="create_a_nebulagraph_cluster_with_helm">Create a NebulaGraph cluster wit
<span class="w"> </span>--set<span class="w"> </span>nebula.version<span class="o">=</span>v3.6.0<span class="w"> </span><span class="se">\ </span><span class="w"> </span>
<span class="w"> </span><span class="c1"># Specify the version of the nebula-cluster chart. If not specified, the latest version of the chart is installed by default.</span>
<span class="w"> </span><span class="c1"># Run &#39;helm search repo nebula-operator/nebula-cluster&#39; to view the available versions of the chart. </span>
<span class="w"> </span>--version<span class="o">=</span><span class="m">1</span>.7.2<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--version<span class="o">=</span><span class="m">1</span>.7.3<span class="w"> </span><span class="se">\</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><span class="w"> </span><span class="se">\</span>
</code></pre></div>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8180,13 +8180,13 @@ <h2 id="connect_to_nebulagraph_databases_from_within_a_nebulagraph_cluster">Conn
nebula-console<span class="w"> </span>-addr<span class="w"> </span>nebula-graphd-svc.default.svc.cluster.local<span class="w"> </span>-port<span class="w"> </span><span class="m">9669</span><span class="w"> </span>-u<span class="w"> </span>&lt;username&gt;<span class="w"> </span>-p<span class="w"> </span>&lt;password&gt;
</code></pre></div>
</div>
<p>For information about the nebula-console container, see <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.2/doc/user/nebula_console.md#nebula-console">nebula-console</a>.</p>
<p>For information about the nebula-console container, see <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.3/doc/user/nebula_console.md#nebula-console">nebula-console</a>.</p>
</li>
</ol>
<h2 id="connect_to_nebulagraph_databases_from_outside_a_nebulagraph_cluster_via_nodeport">Connect to NebulaGraph databases from outside a NebulaGraph cluster via <code>NodePort</code><a class="headerlink" href="#connect_to_nebulagraph_databases_from_outside_a_nebulagraph_cluster_via_nodeport" title="Permanent link">&para;</a></h2>
<p>You can create a <code>NodePort</code> type Service to access internal cluster services from outside the cluster using any node IP and the exposed node port. You can also utilize load balancing services provided by cloud vendors (such as Azure, AWS, etc.) by setting the Service type to <code>LoadBalancer</code>. This allows external access to internal cluster services through the public IP and port of the load balancer provided by the cloud vendor.</p>
<p>The Service of type <code>NodePort</code> forwards the front-end requests via the label selector <code>spec.selector</code> to Graphd pods with labels <code>app.kubernetes.io/cluster: &lt;cluster-name&gt;</code> and <code>app.kubernetes.io/component: graphd</code>.</p>
<p>After creating a NebulaGraph cluster based on the <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.2/config/samples/apps_v1alpha1_nebulacluster.yaml">example template</a>, where <code>spec.graphd.service.type=NodePort</code>, the NebulaGraph Operator will automatically create a NodePort type Service named <code>&lt;cluster-name&gt;-graphd-svc</code> in the same namespace. You can directly connect to the NebulaGraph database through any node IP and the exposed node port (see step 4 below). You can also create a custom Service according to your needs.</p>
<p>After creating a NebulaGraph cluster based on the <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.3/config/samples/apps_v1alpha1_nebulacluster.yaml">example template</a>, where <code>spec.graphd.service.type=NodePort</code>, the NebulaGraph Operator will automatically create a NodePort type Service named <code>&lt;cluster-name&gt;-graphd-svc</code> in the same namespace. You can directly connect to the NebulaGraph database through any node IP and the exposed node port (see step 4 below). You can also create a custom Service according to your needs.</p>
<p>Steps:</p>
<ol>
<li>
Expand Down Expand Up @@ -8267,7 +8267,7 @@ <h2 id="connect_to_nebulagraph_databases_from_outside_a_nebulagraph_cluster_via_
<span class="c1"># Connect to NebulaGraph databases.</span>
nebula-console<span class="w"> </span>-addr<span class="w"> </span>&lt;node_ip&gt;<span class="w"> </span>-port<span class="w"> </span>&lt;node_port&gt;<span class="w"> </span>-u<span class="w"> </span>&lt;username&gt;<span class="w"> </span>-p<span class="w"> </span>&lt;password&gt;
</code></pre></div>
<p>For information about the nebula-console container, see <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.2/doc/user/nebula_console.md#nebula-console">nebula-console</a>.</p>
<p>For information about the nebula-console container, see <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.3/doc/user/nebula_console.md#nebula-console">nebula-console</a>.</p>
</div>
</li>
</ol>
Expand All @@ -8291,7 +8291,7 @@ <h2 id="connect_to_nebulagraph_databases_from_outside_a_nebulagraph_cluster_via_
<ol>
<li>
<p>Create a file named <code>nginx-ingress-daemonset-hostnetwork.yaml</code>. </p>
<p>Click on <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.2/config/samples/nginx-ingress-daemonset-hostnetwork.yaml">nginx-ingress-daemonset-hostnetwork.yaml</a> to view the complete content of the example YAML file.</p>
<p>Click on <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.3/config/samples/nginx-ingress-daemonset-hostnetwork.yaml">nginx-ingress-daemonset-hostnetwork.yaml</a> to view the complete content of the example YAML file.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The resource objects in the YAML file above use the namespace <code>nginx-ingress</code>. You can run <code>kubectl create namespace nginx-ingress</code> to create this namespace, or you can customize the namespace.</p>
Expand Down Expand Up @@ -8350,7 +8350,7 @@ <h2 id="connect_to_nebulagraph_databases_from_outside_a_nebulagraph_cluster_via_
<span class="c1"># Connect to NebulaGraph databases.</span>
nebula-console<span class="w"> </span>-addr<span class="w"> </span>&lt;ingress_host_ip&gt;<span class="w"> </span>-port<span class="w"> </span>&lt;external_port&gt;<span class="w"> </span>-u<span class="w"> </span>&lt;username&gt;<span class="w"> </span>-p<span class="w"> </span>&lt;password&gt;
</code></pre></div>
<p>For information about the nebula-console container, see <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.2/doc/user/nebula_console.md#nebula-console">nebula-console</a>. </p>
<p>For information about the nebula-console container, see <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.3/doc/user/nebula_console.md#nebula-console">nebula-console</a>. </p>
</div>
</li>
</ol>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8068,11 +8068,11 @@ <h1 id="customize_installation_defaults">Customize installation defaults<a class
<p>This topic introduces how to customize the default configurations when installing NebulaGraph Operator.</p>
<h2 id="customizable_parameters">Customizable parameters<a class="headerlink" href="#customizable_parameters" title="Permanent link">&para;</a></h2>
<p>When executing the <code>helm install [NAME] [CHART] [flags]</code> command to install a chart, you can specify the chart configuration. For more information, see <a href="https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing">Customizing the Chart Before Installing</a>.</p>
<p>You can view the configurable options in the <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.2/charts/nebula-operator/values.yaml">nebula-operator chart</a> configuration file. Alternatively, you can view the configurable options through the command <code>helm show values nebula-operator/nebula-operator</code>, as shown below.</p>
<p>You can view the configurable options in the <a href="https://github.com/vesoft-inc/nebula-operator/blob/v1.7.3/charts/nebula-operator/values.yaml">nebula-operator chart</a> configuration file. Alternatively, you can view the configurable options through the command <code>helm show values nebula-operator/nebula-operator</code>, as shown below.</p>
<div class="highlight"><pre><span></span><code><span class="p p-Indicator">[</span><span class="nv">root@master ~</span><span class="p p-Indicator">]</span><span class="l l-Scalar l-Scalar-Plain">$ helm show values nebula-operator/nebula-operator</span><span class="w"> </span>
<span class="l l-Scalar l-Scalar-Plain">image</span><span class="p p-Indicator">:</span>
<span class="w"> </span><span class="nt">nebulaOperator</span><span class="p">:</span>
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vesoft/nebula-operator:v1.7.2</span>
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vesoft/nebula-operator:v1.7.3</span>
<span class="w"> </span><span class="nt">imagePullPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Always</span>

<span class="nt">imagePullSecrets</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"> </span><span class="p p-Indicator">]</span>
Expand Down Expand Up @@ -8125,8 +8125,8 @@ <h2 id="customizable_parameters">Customizable parameters<a class="headerlink" hr
<tbody>
<tr>
<td align="left"><code>image.nebulaOperator.image</code></td>
<td align="left"><code>vesoft/nebula-operator:v1.7.2</code></td>
<td align="left">The image of NebulaGraph Operator, version of which is 1.7.2.</td>
<td align="left"><code>vesoft/nebula-operator:v1.7.3</code></td>
<td align="left">The image of NebulaGraph Operator, version of which is 1.7.3.</td>
</tr>
<tr>
<td align="left"><code>image.nebulaOperator.imagePullPolicy</code></td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8070,7 +8070,7 @@ <h2 id="steps">Steps<a class="headerlink" href="#steps" title="Permanent link">&
<li><code>--set</code>:Overrides values using the command line. For more configurable items, see <a href="../3.1.customize-installation/">Customize installation defaults</a>.</li>
</ul>
<p>For example, to enable the AdmissionWebhook, run the following command:</p>
<div class="highlight"><pre><span></span><code>helm<span class="w"> </span>upgrade<span class="w"> </span>nebula-operator<span class="w"> </span>nebula-operator/nebula-operator<span class="w"> </span>--namespace<span class="o">=</span>nebula-operator-system<span class="w"> </span>--version<span class="o">=</span><span class="m">1</span>.7.2<span class="w"> </span>--set<span class="w"> </span>admissionWebhook.create<span class="o">=</span><span class="nb">true</span>
<div class="highlight"><pre><span></span><code>helm<span class="w"> </span>upgrade<span class="w"> </span>nebula-operator<span class="w"> </span>nebula-operator/nebula-operator<span class="w"> </span>--namespace<span class="o">=</span>nebula-operator-system<span class="w"> </span>--version<span class="o">=</span><span class="m">1</span>.7.3<span class="w"> </span>--set<span class="w"> </span>admissionWebhook.create<span class="o">=</span><span class="nb">true</span>
</code></pre></div>
<p>For more information, see <a href="https://helm.sh/docs/helm/helm_update/">Helm upgrade</a>.</p>
</li>
Expand Down
Loading

0 comments on commit 4adba32

Please sign in to comment.