Deployed a3cf55f to v1.12.x with MkDocs 1.4.3 and mike 1.1.2

v1.12.x/en/reference/dev-env/index.html

@@ -6,7 +6,7 @@
   var s = document.getElementsByTagName("script")[0];
   s.parentNode.insertBefore(hm, s);
 })();
-</script> <a href=https://github.com/kubeovn/docs/edit/master/docs/reference/dev-env.en.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=development-setup>Development Setup<a class=headerlink href=#development-setup title="Permanent link">&para;</a></h1> <h2 id=environmental-preparation>Environmental Preparation<a class=headerlink href=#environmental-preparation title="Permanent link">&para;</a></h2> <p>Kube-OVN uses <a href=https://golang.org/ target=_blank>Golang</a> 1.18 to develop and <a href=https://github.com/golang/go/wiki/Modules target=_blank>Go Modules</a> to manage dependency, please check env <code>GO111MODULE="on"</code>。</p> <p><a href=https://github.com/securego/gosec target=_blank>gosec</a> is used to scan for code security related issues and requires to be installed in the development environment:</p> <div class=highlight><pre><span></span><code>go<span class=w> </span>get<span class=w> </span>github.com/securego/gosec/v2/cmd/gosec
+</script> <a href=https://github.com/kubeovn/docs/edit/master/docs/reference/dev-env.en.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=development-setup>Development Setup<a class=headerlink href=#development-setup title="Permanent link">&para;</a></h1> <h2 id=environmental-preparation>Environmental Preparation<a class=headerlink href=#environmental-preparation title="Permanent link">&para;</a></h2> <p>Kube-OVN uses <a href=https://golang.org/ target=_blank>Golang</a> 1.20 to develop and <a href=https://github.com/golang/go/wiki/Modules target=_blank>Go Modules</a> to manage dependency, please check env <code>GO111MODULE="on"</code>。</p> <p><a href=https://github.com/securego/gosec target=_blank>gosec</a> is used to scan for code security related issues and requires to be installed in the development environment:</p> <div class=highlight><pre><span></span><code>go<span class=w> </span>get<span class=w> </span>github.com/securego/gosec/v2/cmd/gosec
 </code></pre></div> <p>To reduce the size of the final generated image, Kube-OVN uses some of the Docker buildx experimental features, please update Docker to the latest version and enable buildx:</p> <div class=highlight><pre><span></span><code>docker<span class=w> </span>buildx<span class=w> </span>create<span class=w> </span>--use
 </code></pre></div> <h2 id=build-image>Build Image<a class=headerlink href=#build-image title="Permanent link">&para;</a></h2> <p>Use the following command to download the code and generate the image required to run Kube-OVN:</p> <div class=highlight><pre><span></span><code>git<span class=w> </span>clone<span class=w> </span>https://github.com/kubeovn/kube-ovn.git
 <span class=nb>cd</span><span class=w> </span>kube-ovn
@@ -17,7 +17,7 @@
 
 <span class=c1># build arm base image</span>
 make<span class=w> </span>base-arm64
-</code></pre></div> <h2 id=run-e2e>Run E2E<a class=headerlink href=#run-e2e title="Permanent link">&para;</a></h2> <p>Kube-OVN uses <a href=https://kind.sigs.k8s.io/ target=_blank>KIND</a> to build local Kubernetes cluster, <a href=https://github.com/kolypto/j2cli target=_blank>j2cli</a> to render templates， and <a href=https://onsi.github.io/ginkgo/ target=_blank>Ginkgo</a> to run test cases. Please refer to the relevant documentation for dependency installation.</p> <p>Run E2E locally:</p> <div class=highlight><pre><span></span><code>make<span class=w> </span>kind-init
+</code></pre></div> <h2 id=run-e2e>Run E2E<a class=headerlink href=#run-e2e title="Permanent link">&para;</a></h2> <p>Kube-OVN uses <a href=https://kind.sigs.k8s.io/ target=_blank>KIND</a> to build local Kubernetes cluster, <a href=https://github.com/kolypto/j2cli target=_blank>j2cli</a> to render templates, and <a href=https://onsi.github.io/ginkgo/ target=_blank>Ginkgo</a> to run test cases. Please refer to the relevant documentation for dependency installation.</p> <p>Run E2E locally:</p> <div class=highlight><pre><span></span><code>make<span class=w> </span>kind-init
 make<span class=w> </span>kind-install
 make<span class=w> </span>e2e
 </code></pre></div> <p>To run the Underlay E2E test, run the following commands:</p> <div class=highlight><pre><span></span><code>make<span class=w> </span>kind-init

v1.12.x/en/start/prepare/index.html

@@ -6,7 +6,7 @@
   var s = document.getElementsByTagName("script")[0];
   s.parentNode.insertBefore(hm, s);
 })();
-</script> <a href=https://github.com/kubeovn/docs/edit/master/docs/start/prepare.en.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=prerequisites>Prerequisites<a class=headerlink href=#prerequisites title="Permanent link">&para;</a></h1> <p>Kube-OVN is a CNI-compliant network system that depends on the Kubernetes environment and the corresponding kernel network module for its operation. Below are the operating system and software versions tested, the environment configuration and the ports that need to be opened.</p> <h2 id=software-version>Software Version<a class=headerlink href=#software-version title="Permanent link">&para;</a></h2> <ul> <li>Kubernetes &gt;= 1.16，1.19 and above is recommended.</li> <li>Docker &gt;= 1.12.6, Containerd &gt;= 1.3.4.</li> <li>OS: CentOS 7/8, Ubuntu 16.04/18.04/20.04.</li> <li>For other Linux distributions, please make sure <code>geneve</code>, <code>openvswitch</code>, <code>ip_tables</code> and <code>iptable_nat</code> kernel modules exist.</li> </ul> <p><em>Attention</em>：</p> <ol> <li>For CentOS kernel version 3.10.0-862 bug exists in <code>netfilter</code> modules that lead Kube-OVN embed nat and lb failure.Please update kernel and check <a href=https://bugs.launchpad.net/neutron/+bug/1776778 target=_blank>Floating IPs broken after kernel upgrade to Centos/RHEL 7.5 - DNAT not working</a>.</li> <li>Kernel version 4.18.0-372.9.1.el8.x86_64 in Rocky Linux 8.6 has a TCP connection problem <a href=https://github.com/kubeovn/kube-ovn/issues/1647 target=_blank>TCP connection failed in Rocky Linux 8.6</a>，please update kernel to 4.18.0-372.13.1.el8_6.x86_64 or later。</li> <li>For kernel version 4.4, the related <code>openvswitch</code> module has some issues for ct，please update kernel version or manually compile <code>openvswitch</code> kernel module.</li> <li>When building Geneve tunnel IPv6 in kernel should be enabled，check the kernel bootstrap options with <code>cat /proc/cmdline</code>.Check <a href=https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1794232 target=_blank>Geneve tunnels don't work when ipv6 is disabled</a> for the detail bug info.</li> </ol> <h2 id=environment-setup>Environment Setup<a class=headerlink href=#environment-setup title="Permanent link">&para;</a></h2> <ul> <li>Kernel should enable IPv6, if kernel bootstrap options contain <code>ipv6.disable=1</code>, it should be set to <code>0</code>.</li> <li><code>kube-proxy</code> works, Kube-OVN can visit <code>kube-apiserver</code> from Service ClusterIP.</li> <li>Make sure kubelet enabled <code>CNI</code> and find cni-bin and cni-conf in default directories, kubelet bootstrap options should contain <code>--network-plugin=cni --cni-bin-dir=/opt/cni/bin --cni-conf-dir=/etc/cni/net.d</code>.</li> <li>Make sure no other CNI installed or has been removed，check if any config files still exist in<code>/etc/cni/net.d/</code>.</li> </ul> <h2 id=ports-need-open>Ports Need Open<a class=headerlink href=#ports-need-open title="Permanent link">&para;</a></h2> <table> <thead> <tr> <th>Component</th> <th>Port</th> <th>Usage</th> </tr> </thead> <tbody> <tr> <td>ovn-central</td> <td>6641/tcp, 6642/tcp, 6643/tcp, 6644/tcp</td> <td>ovn-db and raft server listen ports</td> </tr> <tr> <td>ovs-ovn</td> <td>Geneve 6081/udp, STT 7471/tcp, Vxlan 4789/udp</td> <td>tunnel ports</td> </tr> <tr> <td>kube-ovn-controller</td> <td>10660/tcp</td> <td>metrics port</td> </tr> <tr> <td>kube-ovn-daemon</td> <td>10665/tcp</td> <td>metrics port</td> </tr> <tr> <td>kube-ovn-monitor</td> <td>10661/tcp</td> <td>metrics port</td> </tr> </tbody> </table> <p><a class=md-button href=https://ma.alauda.cn/p/0f39a target=_blank><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 4C5.36 4 2 6.69 2 10c0 1.89 1.08 3.56 2.78 4.66L4 17l2.5-1.5c.89.31 1.87.5 2.91.5A5.22 5.22 0 0 1 9 14c0-3.31 3.13-6 7-6 .19 0 .38 0 .56.03C15.54 5.69 12.78 4 9.5 4m-3 2.5a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m5 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1M16 9c-3.31 0-6 2.24-6 5s2.69 5 6 5c.67 0 1.31-.08 1.91-.25L20 20l-.62-1.87C20.95 17.22 22 15.71 22 14c0-2.76-2.69-5-6-5m-2 2.5a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1Z"/></svg></span> 微信群</a> <a class=md-button href=https://communityinviter.com/apps/kube-ovn/kube-ovn/ target=_blank><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M6 15a2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2h2v2m1 0a2 2 0 0 1 2-2 2 2 0 0 1 2 2v5a2 2 0 0 1-2 2 2 2 0 0 1-2-2v-5m2-8a2 2 0 0 1-2-2 2 2 0 0 1 2-2 2 2 0 0 1 2 2v2H9m0 1a2 2 0 0 1 2 2 2 2 0 0 1-2 2H4a2 2 0 0 1-2-2 2 2 0 0 1 2-2h5m8 2a2 2 0 0 1 2-2 2 2 0 0 1 2 2 2 2 0 0 1-2 2h-2v-2m-1 0a2 2 0 0 1-2 2 2 2 0 0 1-2-2V5a2 2 0 0 1 2-2 2 2 0 0 1 2 2v5m-2 8a2 2 0 0 1 2 2 2 2 0 0 1-2 2 2 2 0 0 1-2-2v-2h2m0-1a2 2 0 0 1-2-2 2 2 0 0 1 2-2h5a2 2 0 0 1 2 2 2 2 0 0 1-2 2h-5Z"/></svg></span> Slack</a> <a class=md-button href=https://twitter.com/KubeOvn target=_blank><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M22.46 6c-.77.35-1.6.58-2.46.69.88-.53 1.56-1.37 1.88-2.38-.83.5-1.75.85-2.72 1.05C18.37 4.5 17.26 4 16 4c-2.35 0-4.27 1.92-4.27 4.29 0 .34.04.67.11.98C8.28 9.09 5.11 7.38 3 4.79c-.37.63-.58 1.37-.58 2.15 0 1.49.75 2.81 1.91 3.56-.71 0-1.37-.2-1.95-.5v.03c0 2.08 1.48 3.82 3.44 4.21a4.22 4.22 0 0 1-1.93.07 4.28 4.28 0 0 0 4 2.98 8.521 8.521 0 0 1-5.33 1.84c-.34 0-.68-.02-1.02-.06C3.44 20.29 5.7 21 8.12 21 16 21 20.33 14.46 20.33 8.79c0-.19 0-.37-.01-.56.84-.6 1.56-1.36 2.14-2.23Z"/></svg></span> Twitter</a> <a class=md-button href=https://ma.alauda.cn/p/2f53a target=_blank><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m20 8-8 5-8-5V6l8 5 8-5m0-2H4c-1.11 0-2 .89-2 2v12a2 2 0 0 0 2 2h16a2 2 0 0 0 2-2V6a2 2 0 0 0-2-2Z"/></svg></span> Support</a></p> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 15, 2023</span> <br> Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 30, 2022</span> </small> </div> <h2 id=__comments>Comments</h2> <script src=https://giscus.app/client.js data-repo=kubeovn/kube-ovn data-repo-id="MDEwOlJlcG9zaXRvcnkxNzcwNjg5NjE=" data-category=Announcements data-category-id=DIC_kwDOCo3boc4CAj60 data-mapping=pathname data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
+</script> <a href=https://github.com/kubeovn/docs/edit/master/docs/start/prepare.en.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=prerequisites>Prerequisites<a class=headerlink href=#prerequisites title="Permanent link">&para;</a></h1> <p>Kube-OVN is a CNI-compliant network system that depends on the Kubernetes environment and the corresponding kernel network module for its operation. Below are the operating system and software versions tested, the environment configuration and the ports that need to be opened.</p> <h2 id=software-version>Software Version<a class=headerlink href=#software-version title="Permanent link">&para;</a></h2> <ul> <li>Kubernetes &gt;= 1.23.</li> <li>Docker &gt;= 1.12.6, Containerd &gt;= 1.3.4.</li> <li>OS: CentOS 7/8, Ubuntu 16.04/18.04/20.04.</li> <li>For other Linux distributions, please make sure <code>geneve</code>, <code>openvswitch</code>, <code>ip_tables</code> and <code>iptable_nat</code> kernel modules exist.</li> </ul> <p><em>Attention</em>：</p> <ol> <li>For CentOS kernel version 3.10.0-862 bug exists in <code>netfilter</code> modules that lead Kube-OVN embed nat and lb failure.Please update kernel and check <a href=https://bugs.launchpad.net/neutron/+bug/1776778 target=_blank>Floating IPs broken after kernel upgrade to Centos/RHEL 7.5 - DNAT not working</a>.</li> <li>Kernel version 4.18.0-372.9.1.el8.x86_64 in Rocky Linux 8.6 has a TCP connection problem <a href=https://github.com/kubeovn/kube-ovn/issues/1647 target=_blank>TCP connection failed in Rocky Linux 8.6</a>，please update kernel to 4.18.0-372.13.1.el8_6.x86_64 or later。</li> <li>For kernel version 4.4, the related <code>openvswitch</code> module has some issues for ct，please update kernel version or manually compile <code>openvswitch</code> kernel module.</li> <li>When building Geneve tunnel IPv6 in kernel should be enabled，check the kernel bootstrap options with <code>cat /proc/cmdline</code>.Check <a href=https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1794232 target=_blank>Geneve tunnels don't work when ipv6 is disabled</a> for the detail bug info.</li> </ol> <h2 id=environment-setup>Environment Setup<a class=headerlink href=#environment-setup title="Permanent link">&para;</a></h2> <ul> <li>Kernel should enable IPv6, if kernel bootstrap options contain <code>ipv6.disable=1</code>, it should be set to <code>0</code>.</li> <li><code>kube-proxy</code> works, Kube-OVN can visit <code>kube-apiserver</code> from Service ClusterIP.</li> <li>Make sure kubelet enabled <code>CNI</code> and find cni-bin and cni-conf in default directories, kubelet bootstrap options should contain <code>--network-plugin=cni --cni-bin-dir=/opt/cni/bin --cni-conf-dir=/etc/cni/net.d</code>.</li> <li>Make sure no other CNI installed or has been removed，check if any config files still exist in<code>/etc/cni/net.d/</code>.</li> </ul> <h2 id=ports-need-open>Ports Need Open<a class=headerlink href=#ports-need-open title="Permanent link">&para;</a></h2> <table> <thead> <tr> <th>Component</th> <th>Port</th> <th>Usage</th> </tr> </thead> <tbody> <tr> <td>ovn-central</td> <td>6641/tcp, 6642/tcp, 6643/tcp, 6644/tcp</td> <td>ovn-db and raft server listen ports</td> </tr> <tr> <td>ovs-ovn</td> <td>Geneve 6081/udp, STT 7471/tcp, Vxlan 4789/udp</td> <td>tunnel ports</td> </tr> <tr> <td>kube-ovn-controller</td> <td>10660/tcp</td> <td>metrics port</td> </tr> <tr> <td>kube-ovn-daemon</td> <td>10665/tcp</td> <td>metrics port</td> </tr> <tr> <td>kube-ovn-monitor</td> <td>10661/tcp</td> <td>metrics port</td> </tr> </tbody> </table> <p><a class=md-button href=https://ma.alauda.cn/p/0f39a target=_blank><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 4C5.36 4 2 6.69 2 10c0 1.89 1.08 3.56 2.78 4.66L4 17l2.5-1.5c.89.31 1.87.5 2.91.5A5.22 5.22 0 0 1 9 14c0-3.31 3.13-6 7-6 .19 0 .38 0 .56.03C15.54 5.69 12.78 4 9.5 4m-3 2.5a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m5 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1M16 9c-3.31 0-6 2.24-6 5s2.69 5 6 5c.67 0 1.31-.08 1.91-.25L20 20l-.62-1.87C20.95 17.22 22 15.71 22 14c0-2.76-2.69-5-6-5m-2 2.5a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1Z"/></svg></span> 微信群</a> <a class=md-button href=https://communityinviter.com/apps/kube-ovn/kube-ovn/ target=_blank><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M6 15a2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2h2v2m1 0a2 2 0 0 1 2-2 2 2 0 0 1 2 2v5a2 2 0 0 1-2 2 2 2 0 0 1-2-2v-5m2-8a2 2 0 0 1-2-2 2 2 0 0 1 2-2 2 2 0 0 1 2 2v2H9m0 1a2 2 0 0 1 2 2 2 2 0 0 1-2 2H4a2 2 0 0 1-2-2 2 2 0 0 1 2-2h5m8 2a2 2 0 0 1 2-2 2 2 0 0 1 2 2 2 2 0 0 1-2 2h-2v-2m-1 0a2 2 0 0 1-2 2 2 2 0 0 1-2-2V5a2 2 0 0 1 2-2 2 2 0 0 1 2 2v5m-2 8a2 2 0 0 1 2 2 2 2 0 0 1-2 2 2 2 0 0 1-2-2v-2h2m0-1a2 2 0 0 1-2-2 2 2 0 0 1 2-2h5a2 2 0 0 1 2 2 2 2 0 0 1-2 2h-5Z"/></svg></span> Slack</a> <a class=md-button href=https://twitter.com/KubeOvn target=_blank><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M22.46 6c-.77.35-1.6.58-2.46.69.88-.53 1.56-1.37 1.88-2.38-.83.5-1.75.85-2.72 1.05C18.37 4.5 17.26 4 16 4c-2.35 0-4.27 1.92-4.27 4.29 0 .34.04.67.11.98C8.28 9.09 5.11 7.38 3 4.79c-.37.63-.58 1.37-.58 2.15 0 1.49.75 2.81 1.91 3.56-.71 0-1.37-.2-1.95-.5v.03c0 2.08 1.48 3.82 3.44 4.21a4.22 4.22 0 0 1-1.93.07 4.28 4.28 0 0 0 4 2.98 8.521 8.521 0 0 1-5.33 1.84c-.34 0-.68-.02-1.02-.06C3.44 20.29 5.7 21 8.12 21 16 21 20.33 14.46 20.33 8.79c0-.19 0-.37-.01-.56.84-.6 1.56-1.36 2.14-2.23Z"/></svg></span> Twitter</a> <a class=md-button href=https://ma.alauda.cn/p/2f53a target=_blank><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m20 8-8 5-8-5V6l8 5 8-5m0-2H4c-1.11 0-2 .89-2 2v12a2 2 0 0 0 2 2h16a2 2 0 0 0 2-2V6a2 2 0 0 0-2-2Z"/></svg></span> Support</a></p> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 20, 2023</span> <br> Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 30, 2022</span> </small> </div> <h2 id=__comments>Comments</h2> <script src=https://giscus.app/client.js data-repo=kubeovn/kube-ovn data-repo-id="MDEwOlJlcG9zaXRvcnkxNzcwNjg5NjE=" data-category=Announcements data-category-id=DIC_kwDOCo3boc4CAj60 data-mapping=pathname data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
 </script> <script>
     var palette = __md_get("__palette")
     if (palette && typeof palette.color === "object")