https://edgemesh.netlify.app/assets/js/v-889d07b2.54cf6691.js

1"use strict";(self.webpackChunkedgemesh=self.webpackChunkedgemesh||[]).push([[572],{2250:(n,s,a)=>{a.r(s),a.d(s,{data:()=>e});const e={key:"v-889d07b2",path:"/reference/config-items.html",title:"Configure",lang:"en-US",frontmatter:{},excerpt:"",headers:[{level:2,title:"Helm configure",slug:"helm-configure",children:[{level:3,title:"EdgeMesh",slug:"edgemesh",children:[]},{level:3,title:"EdgeMesh-Gateway",slug:"edgemesh-gateway",children:[]}]},{level:2,title:"ConfigMap Configure",slug:"configmap-configure",children:[{level:3,title:"edgemesh-agent-cfg",slug:"edgemesh-agent-cfg",children:[]},{level:3,title:"edgemesh-gateway-cfg",slug:"edgemesh-gateway-cfg",children:[]}]}],filePathRelative:"reference/config-items.md",git:{updatedTime:1677596827e3,contributors:[]}}},2572:(n,s,a)=>{a.r(s),a.d(s,{default:()=>k});var e=a(6252);const t=(0,e.uE)('<h1 id="configure" tabindex="-1"><a class="header-anchor" href="#configure" aria-hidden="true">#</a> Configure</h1><h2 id="helm-configure" tabindex="-1"><a class="header-anchor" href="#helm-configure" aria-hidden="true">#</a> Helm configure</h2><h3 id="edgemesh" tabindex="-1"><a class="header-anchor" href="#edgemesh" aria-hidden="true">#</a> EdgeMesh</h3><p>The Helm Chart configuration of EdgeMesh is placed in the build/helm/edgemesh directory.</p><h4 id="_1-edgemesh-agent" tabindex="-1"><a class="header-anchor" href="#_1-edgemesh-agent" aria-hidden="true">#</a> 1. edgemesh-agent</h4><table><thead><tr><th>Name</th><th>Type</th><th>Example of use</th><th>Describe</th></tr></thead><tbody><tr><td>image</td><td>string</td><td>--set agent.image=kubeedge/edgemesh-agent:v1.12.0</td><td>Specifies the image used by edgemesh-agent</td></tr><tr><td>psk</td><td>string</td><td>--set agent.psk=123456</td><td>PSK cipher</td></tr><tr><td>relayNodes</td><td>list</td><td>--set relayNodes[0].nodeName=k8s-master</td><td>Relay node configuration table</td></tr><tr><td>metaServerSecret</td><td>string</td><td>--set agent.metaServerSecret=metaserver-certs</td><td>Secret to store the metaServer certificate file</td></tr><tr><td>kubeAPIConfig</td><td>object</td><td>--set agent.kubeAPIConfig.master=https://1.1.1.1:6443</td><td>Same meaning as kubeAPIConfig in configmap</td></tr><tr><td>commonConfig</td><td>object</td><td>--set agent.commonConfig.bridgeDeviceIP=169.254.96.16</td><td>Same meaning as commonConfig in configmap</td></tr><tr><td>modules</td><td>object</td><td>--set agent.modules.edgeProxy.socks5Proxy.enable=true</td><td>Same meaning as modules in configmap</td></tr></tbody></table><h3 id="edgemesh-gateway" tabindex="-1"><a class="header-anchor" href="#edgemesh-gateway" aria-hidden="true">#</a> EdgeMesh-Gateway</h3><p>The Helm Chart configuration of EdgeMesh-Gateway is placed in the build/helm/edgemesh-gateway directory.</p><table><thead><tr><th>Name</th><th>Type</th><th>Example of use</th><th>Describe</th></tr></thead><tbody><tr><td>image</td><td>string</td><td>--set image=kubeedge/edgemesh-gateway:v1.12.0</td><td>Specifies the image used by edgemesh-gateway</td></tr><tr><td>nodeName</td><td>string</td><td>--set nodeName=k8s-master</td><td>Specify the node where edgemesh-gateway is deployed</td></tr><tr><td>psk</td><td>string</td><td>--set psk=123456</td><td>PSK cipher</td></tr><tr><td>relayNodes</td><td>list</td><td>--set relayNodes[0].nodeName=k8s-master</td><td>Relay node configuration table</td></tr><tr><td>metaServerSecret</td><td>string</td><td>--set metaServerSecret=metaserver-certs</td><td>Secret to store the metaServer certificate file</td></tr><tr><td>kubeAPIConfig</td><td>object</td><td>--set kubeAPIConfig.master=https://1.1.1.1:6443</td><td>Same meaning as kubeAPIConfig in configmap</td></tr><tr><td>modules</td><td>object</td><td>--set modules.edgeGateway.nic=eth0</td><td>Same meaning as modules in configmap</td></tr></tbody></table><h2 id="configmap-configure" tabindex="-1"><a class="header-anchor" href="#configmap-configure" aria-hidden="true">#</a> ConfigMap Configure</h2>',10),p={class:"custom-container tip"},l=(0,e._)("p",{class:"custom-container-title"},"TIP",-1),c=(0,e.Uk)("For detailed field explanation, please refer to "),r={href:"https://github.com/kubeedge/edgemesh/blob/main/pkg/apis/config/v1alpha1/types.go",target:"_blank",rel:"noopener noreferrer"},o=(0,e.Uk)("API Definition"),u=(0,e.Uk)("."),i=(0,e.uE)('<h3 id="edgemesh-agent-cfg" tabindex="-1"><a class="header-anchor" href="#edgemesh-agent-cfg" aria-hidden="true">

1#</a> edgemesh-agent-cfg</h3><div class="language-yaml ext-yml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">apiVersion</span><span class="token punctuation">:</span> agent.edgemesh.config.kubeedge.io/v1alpha1\n<span class="token key atrule">kind</span><span class="token punctuation">:</span> EdgeMeshAgent\n<span class="token key atrule">kubeAPIConfig</span><span class="token punctuation">:</span>\n  <span class="token key atrule">master</span><span class="token punctuation">:</span> https<span class="token punctuation">:</span>//119.8.211.54<span class="token punctuation">:</span><span class="token number">6443</span>\n  <span class="token key atrule">contentType</span><span class="token punctuation">:</span> application/vnd.kubernetes.protobuf\n  <span class="token key atrule">qps</span><span class="token punctuation">:</span> <span class="token number">100</span>\n  <span class="token key atrule">burst</span><span class="token punctuation">:</span> <span class="token number">200</span>\n  <span class="token key atrule">kubeConfig</span><span class="token punctuation">:</span> /root/.kube/config\n  <span class="token key atrule">metaServer</span><span class="token punctuation">:</span>\n    <span class="token key atrule">server</span><span class="token punctuation">:</span> http<span class="token punctuation">:</span>//127.0.0.1<span class="token punctuation">:</span><span class="token number">10550</span>\n    <span class="token key atrule">security</span><span class="token punctuation">:</span>\n      <span class="token key atrule">requireAuthorization</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n      <span class="token key atrule">insecureSkipTLSVerify</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n      <span class="token key atrule">tlsCaFile</span><span class="token punctuation">:</span> /etc/edgemesh/metaserver/rootCA.crt\n      <span class="token key atrule">tlsCertFile</span><span class="token punctuation">:</span> /etc/edgemesh/metaserver/server.crt\n      <span class="token key atrule">tlsPrivateKeyFile</span><span class="token punctuation">:</span> /etc/edgemesh/metaserver/server.key\n  <span class="token key atrule">deleteKubeConfig</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n<span class="token key atrule">commonConfig</span><span class="token punctuation">:</span>\n  <span class="token key atrule">bridgeDeviceName</span><span class="token punctuation">:</span> edgemesh0\n  <span class="token key atrule">bridgeDeviceIP</span><span class="token punctuation">:</span> 169.254.96.16\n<span class="token key atrule">modules</span><span class="token punctuation">:</span>\n  <span class="token key atrule">edgeDNS</span><span class="token punctuation">:</span>\n    <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n    <span class="token key atrule">listenPort</span><span class="token punctuation">:</span> <span class="token number">53</span>\n    <span class="token key atrule">cacheDNS</span><span class="token punctuation">:</span>\n      <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n      <span class="token key atrule">autoDetect</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>\n      <span class="token key atrule">upstreamServers</span><span class="token punctuation">:</span>\n      <span class="token punctuation">-</span>

1 10.96.0.10\n      <span class="token punctuation">-</span> 1.1.1.1\n      <span class="token key atrule">cacheTTL</span><span class="token punctuation">:</span> <span class="token number">30</span>\n  <span class="token key atrule">edgeProxy</span><span class="token punctuation">:</span>\n    <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n    <span class="token key atrule">socks5Proxy</span><span class="token punctuation">:</span>\n      <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n      <span class="token key atrule">listenPort</span><span class="token punctuation">:</span> <span class="token number">10800</span>\n    <span class="token key atrule">loadBalancer</span><span class="token punctuation">:</span>\n      <span class="token key atrule">consistentHash</span><span class="token punctuation">:</span>\n        <span class="token key atrule">partitionCount</span><span class="token punctuation">:</span> <span class="token number">100</span>\n        <span class="token key atrule">replicationFactor</span><span class="token punctuation">:</span> <span class="token number">10</span>\n        <span class="token key atrule">load</span><span class="token punctuation">:</span> <span class="token number">1.25</span>\n    <span class="token key atrule">serviceFilterMode</span><span class="token punctuation">:</span> FilterIfLabelExists\n  <span class="token key atrule">edgeTunnel</span><span class="token punctuation">:</span>\n    <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n    <span class="token key atrule">listenPort</span><span class="token punctuation">:</span> <span class="token number">20006</span>\n    <span class="token key atrule">transport</span><span class="token punctuation">:</span> tcp\n    <span class="token key atrule">rendezvous</span><span class="token punctuation">:</span> EDGEMESH_PLAYGOUND\n    <span class="token key atrule">relayNodes</span><span class="token punctuation">:</span>\n    <span class="token punctuation">-</span> <span class="token key atrule">nodeName</span><span class="token punctuation">:</span> k8s<span class="token punctuation">-</span>master\n      <span class="token key atrule">advertiseAddress</span><span class="token punctuation">:</span>\n      <span class="token punctuation">-</span> 1.1.1.1\n    <span class="token punctuation">-</span> <span class="token key atrule">nodeName</span><span class="token punctuation">:</span> ke<span class="token punctuation">-</span>edge1\n      <span class="token key atrule">advertiseAddress</span><span class="token punctuation">:</span>\n      <span class="token punctuation">-</span> 2.2.2.2\n      <span class="token punctuation">-</span> 3.3.3.3\n    <span class="token key atrule">enableIpfsLog</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n    <span class="token key atrule">maxCandidates</span><span class="token punctuation">:</span> <span class="token number">5</span>\n    <span class="token key atrule">heartbeatPeriod</span><span class="token punctuation">:</span> <span class="token number">120</span>\n    <span class="token key atrule">finderPeriod</span><span class="token punctuation">:</span> <span class="token number">60</span>\n    <span class="token key atrule">psk</span><span class="token punctuation">:</span>\n      <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>\n      <span class="token key atrule">path</span><span class="token punctuation">:</span> /etc/edgemesh/psk\n    <span class="token key atrule">tunnelLimitConfig</span><span class="token punctuation">:</span>\n      <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n      <span class="token key atrule">tunnelBaseStreamIn</span><span class="token punctuation">:</span> <span class="token number">10240</span>

1\n      <span class="token key atrule">tunnelBaseStreamOut</span><span class="token punctuation">:</span> <span class="token number">10240</span>\n      <span class="token key atrule">TunnelPeerBaseStreamIn</span><span class="token punctuation">:</span> <span class="token number">1024</span>\n      <span class="token key atrule">tunnelPeerBaseStreamOut</span><span class="token punctuation">:</span> <span class="token number">1024</span>\n</code></pre><div class="line-numbers"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br><span class="line-number">15</span><br><span class="line-number">16</span><br><span class="line-number">17</span><br><span class="line-number">18</span><br><span class="line-number">19</span><br><span class="line-number">20</span><br><span class="line-number">21</span><br><span class="line-number">22</span><br><span class="line-number">23</span><br><span class="line-number">24</span><br><span class="line-number">25</span><br><span class="line-number">26</span><br><span class="line-number">27</span><br><span class="line-number">28</span><br><span class="line-number">29</span><br><span class="line-number">30</span><br><span class="line-number">31</span><br><span class="line-number">32</span><br><span class="line-number">33</span><br><span class="line-number">34</span><br><span class="line-number">35</span><br><span class="line-number">36</span><br><span class="line-number">37</span><br><span class="line-number">38</span><br><span class="line-number">39</span><br><span class="line-number">40</span><br><span class="line-number">41</span><br><span class="line-number">42</span><br><span class="line-number">43</span><br><span class="line-number">44</span><br><span class="line-number">45</span><br><span class="line-number">46</span><br><span class="line-number">47</span><br><span class="line-number">48</span><br><span class="line-number">49</span><br><span class="line-number">50</span><br><span class="line-number">51</span><br><span class="line-number">52</span><br><span class="line-number">53</span><br><span class="line-number">54</span><br><span class="line-number">55</span><br><span class="line-number">56</span><br><span class="line-number">57</span><br><span class="line-number">58</span><br><span class="line-number">59</span><br><span class="line-number">60</span><br><span class="line-number">61</span><br><span class="line-number">62</span><br><span class="line-number">63</span><br><span class="line-number">64</span><br><span class="line-number">65</span><br><span class="line-number">66</span><br><span class="line-number">67</span><br><span class="line-number">68</span><br></div></div><h3 id="edgemesh-gateway-cfg" tabindex="-1"><a class="header-anchor" href="#edgemesh-gateway-cfg" aria-hidden="true">#</a> edgemesh-gateway-cfg</h3><div class="language-yaml ext-yml line-numbers-mode"><pre class="language-yaml"><code><span class="token key atrule">apiVersion</span><span class="token punctuation">:</span> gateway.edgemesh.config.kubeedge.io/v1alpha1\n<span class="token key atrule">kind</span><span class="token punctuation">:</span> EdgeMeshGateway\n<span class="token key atrule">kubeAPIConfig</span><span class="token punctuation">:</span>\n  <span class="token key atrule">master</span><span class="token punctuation">:</span> https<span class="token punctuation">:</span>//119.8.211.54<span class="token punctuation">:</span><span class="token number">6443</span>\n  <span class="token key atrule">contentType</span><span class="token punctuation">:</span> application/vnd.kubernetes.protobuf\n  <span class="token key atrule">qps</span><span class="token punctuation">:</span> <span class="token number">100</span>\n  <span class="token key atrule">burst</span><span class="token punctuation">:</span> <span class="token number">200</span>\n  <span class="token key atrule">kubeConfig</span><span class="token punctuation">:</span> /root/.kube/config\n  <span class="token key atrule">metaServer</span><span class="token punctuation">:</span>\n    <span class="token key atrule">server</span><span class="token punctuation">:</span> http<span class="token punctuation">:</span>//127.0.0.1<span class="token punctuation">:</span><span class="token number">10550</span>\n    <span class="token key atrule">security</span><span class="token punctuation">:</span>

1\n      <span class="token key atrule">requireAuthorization</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n      <span class="token key atrule">insecureSkipTLSVerify</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n      <span class="token key atrule">tlsCaFile</span><span class="token punctuation">:</span> /etc/edgemesh/metaserver/rootCA.crt\n      <span class="token key atrule">tlsCertFile</span><span class="token punctuation">:</span> /etc/edgemesh/metaserver/server.crt\n      <span class="token key atrule">tlsPrivateKeyFile</span><span class="token punctuation">:</span> /etc/edgemesh/metaserver/server.key\n  <span class="token key atrule">deleteKubeConfig</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n<span class="token key atrule">modules</span><span class="token punctuation">:</span>\n  <span class="token key atrule">edgeGateway</span><span class="token punctuation">:</span>\n    <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n    <span class="token key atrule">nic</span><span class="token punctuation">:</span> <span class="token string">&quot;lo,eth0&quot;</span><span class="token punctuation">,</span>\n    <span class="token key atrule">includeIP</span><span class="token punctuation">:</span> <span class="token string">&quot;192.168.0.1,172.16.0.1&quot;</span><span class="token punctuation">,</span>\n    <span class="token key atrule">excludeIP</span><span class="token punctuation">:</span> <span class="token string">&quot;10.0.0.1&quot;</span><span class="token punctuation">,</span>\n    <span class="token key atrule">loadBalancer</span><span class="token punctuation">:</span>\n      <span class="token key atrule">consistentHash</span><span class="token punctuation">:</span>\n        <span class="token key atrule">partitionCount</span><span class="token punctuation">:</span> <span class="token number">100</span>\n        <span class="token key atrule">replicationFactor</span><span class="token punctuation">:</span> <span class="token number">10</span>\n        <span class="token key atrule">load</span><span class="token punctuation">:</span> <span class="token number">1.25</span>\n  <span class="token key atrule">edgeTunnel</span><span class="token punctuation">:</span>\n    <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n    <span class="token key atrule">listenPort</span><span class="token punctuation">:</span> <span class="token number">20006</span>\n    <span class="token key atrule">transport</span><span class="token punctuation">:</span> tcp\n    <span class="token key atrule">rendezvous</span><span class="token punctuation">:</span> EDGEMESH_PLAYGOUND\n    <span class="token key atrule">relayNodes</span><span class="token punctuation">:</span>\n    <span class="token punctuation">-</span> <span class="token key atrule">nodeName</span><span class="token punctuation">:</span> k8s<span class="token punctuation">-</span>master\n      <span class="token key atrule">advertiseAddress</span><span class="token punctuation">:</span>\n      <span class="token punctuation">-</span> 1.1.1.1\n    <span class="token punctuation">-</span> <span class="token key atrule">nodeName</span><span class="token punctuation">:</span> ke<span class="token punctuation">-</span>edge1\n      <span class="token key atrule">advertiseAddress</span><span class="token punctuation">:</span>\n      <span class="token punctuation">-</span> 2.2.2.2\n      <span class="token punctuation">-</span> 3.3.3.3\n    <span class="token key atrule">enableIpfsLog</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n    <span class="token key atrule">maxCandidates</span><span class="token punctuation">:</span> <span class="token number">5</span>\n    <span class="token key atrule">

1heartbeatPeriod</span><span class="token punctuation">:</span> <span class="token number">120</span>\n    <span class="token key atrule">finderPeriod</span><span class="token punctuation">:</span> <span class="token number">60</span>\n    <span class="token key atrule">psk</span><span class="token punctuation">:</span>\n      <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>\n      <span class="token key atrule">path</span><span class="token punctuation">:</span> /etc/edgemesh/psk\n    <span class="token key atrule">tunnelLimitConfig</span><span class="token punctuation">:</span>\n      <span class="token key atrule">enable</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>\n      <span class="token key atrule">tunnelBaseStreamIn</span><span class="token punctuation">:</span> <span class="token number">10240</span>\n      <span class="token key atrule">tunnelBaseStreamOut</span><span class="token punctuation">:</span> <span class="token number">10240</span>\n      <span class="token key atrule">TunnelPeerBaseStreamIn</span><span class="token punctuation">:</span> <span class="token number">1024</span>\n      <span class="token key atrule">tunnelPeerBaseStreamOut</span><span class="token punctuation">:</span> <span class="token number">1024</span>\n</code></pre><div class="line-numbers"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br><span class="line-number">15</span><br><span class="line-number">16</span><br><span class="line-number">17</span><br><span class="line-number">18</span><br><span class="line-number">19</span><br><span class="line-number">20</span><br><span class="line-number">21</span><br><span class="line-number">22</span><br><span class="line-number">23</span><br><span class="line-number">24</span><br><span class="line-number">25</span><br><span class="line-number">26</span><br><span class="line-number">27</span><br><span class="line-number">28</span><br><span class="line-number">29</span><br><span class="line-number">30</span><br><span class="line-number">31</span><br><span class="line-number">32</span><br><span class="line-number">33</span><br><span class="line-number">34</span><br><span class="line-number">35</span><br><span class="line-number">36</span><br><span class="line-number">37</span><br><span class="line-number">38</span><br><span class="line-number">39</span><br><span class="line-number">40</span><br><span class="line-number">41</span><br><span class="line-number">42</span><br><span class="line-number">43</span><br><span class="line-number">44</span><br><span class="line-number">45</span><br><span class="line-number">46</span><br><span class="line-number">47</span><br><span class="line-number">48</span><br><span class="line-number">49</span><br><span class="line-number">50</span><br><span class="line-number">51</span><br><span class="line-number">52</span><br><span class="line-number">53</span><br><span class="line-number">54</span><br></div></div>',4),k={render:function(n,s){const a=(0,e.up)("OutboundLink");return(0,e.wg)(),(0,e.iD)(e.HY,null,[t,(0,e._)("div",p,[l,(0,e._)("p",null,[c,(0,e._)("a",r,[o,(0,e.Wm)(a)]),u])]),i],64)}}}}]);