Skip to content

Commit

Permalink
chore: upate gateway docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 13, 2024
1 parent 088b3df commit 1682708
Show file tree
Hide file tree
Showing 117 changed files with 117 additions and 117 deletions.
2 changes: 1 addition & 1 deletion gateway/latest/docs/getting-started/benchmark/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,6 @@
Transfer/sec: 0.00bytes
Avg Req Time: 1.255678s

</code></pre></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/latest/docs/content.en/docs/getting-started/benchmark.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
</code></pre></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/main/docs/content.en/docs/getting-started/benchmark.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
<span>Edit this page</span></a></div><div class="flex align-center footer">©INFINI.LTD, All Rights Reserved.</div><script>(function(h,o,t,j,a,r){h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};h._hjSettings={hjid:2567416,hjsv:6};a=o.getElementsByTagName('head')[0];r=o.createElement('script');r.async=1;r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;a.appendChild(r);})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-VV6PGDHH84"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
gtag('js',new Date());gtag('config','G-VV6PGDHH84');</script><script type=text/javascript>var _smartsupp=_smartsupp||{};_smartsupp.key='691ff544d18a237005a011a7290b839d8fe811a4';window.smartsupp||(function(d){var s,c,o=smartsupp=function(){o._.push(arguments)};o._=[];s=d.getElementsByTagName('script')[0];c=d.createElement('script');c.type='text/javascript';c.charset='utf-8';c.async=true;c.src='https://www.smartsuppchat.com/loader.js?';s.parentNode.insertBefore(c,s);})(document);</script></div></footer><label for=menu-control class="hidden book-menu-overlay"></label></div><aside class=book-toc><nav id=TableOfContents><ul><li><a href=#benchmark-testing>Benchmark Testing</a><ul><li><a href=#loadgen>Loadgen</a><ul><li><a href=#runner-configurations>Runner Configurations</a></li><li><a href=#http-headers-canonization>HTTP Headers Canonization</a></li></ul></li><li><a href=#usage-of-variables>Usage of Variables</a><ul><li><a href=#examples>Examples</a></li><li><a href=#environment-variables>Environment Variables</a></li></ul></li><li><a href=#request-definition>Request Definition</a><ul><li><a href=#simulating-bulk-ingestion>Simulating Bulk Ingestion</a></li><li><a href=#response-assertions>Response Assertions</a></li><li><a href=#dynamic-variable-registration>Dynamic Variable Registration</a></li><li><a href=#benchmark-test>Benchmark Test</a></li><li><a href=#cli-parameters>CLI Parameters</a></li><li><a href=#limiting-the-client-workload>Limiting the Client Workload</a></li><li><a href=#limiting-the-total-number-of-requests>Limiting the Total Number of Requests</a></li><li><a href=#using-auto-incremental-ids-to-ensure-the-document-sequence>Using Auto Incremental IDs to Ensure the Document Sequence</a></li><li><a href=#reuse-variables-in-request-context>Reuse variables in Request Context</a></li><li><a href=#customize-header>Customize Header</a></li></ul></li><li><a href=#running-testing-suites>Running Testing Suites</a><ul><li><a href=#environment-variables-1>Environment Variables</a></li><li><a href=#preparing-test-cases>Preparing Test Cases</a></li><li><a href=#executing-the-test-cases>Executing the Test Cases</a></li></ul></li></ul></li></ul></nav></aside></main></body></html>
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@
password: pass
</code></pre><p>The <code>endpoint</code> parameter is used to set the access address for Elasticsearch. If identity authentication is enabled for Elasticsearch, you can use <code>basic_auth</code> to specify the username and password and the user must have the permission to obtain cluster status information.
The <code>discover</code> parameter is used to enable automatic discovery to automatically detect the status of back-end nodes and identify new and offline nodes.</p><p>After these basic configurations have been completed, INFINI Gateway can normally handle Elasticsearch requests as a proxy. For details about parameters of each component, see the
<a href=/gateway/latest/docs/references/filters/>Reference</a>.</p></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/latest/docs/content.en/docs/getting-started/configuration.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
<a href=/gateway/latest/docs/references/filters/>Reference</a>.</p></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/main/docs/content.en/docs/getting-started/configuration.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
<span>Edit this page</span></a></div><div class="flex align-center footer">©INFINI.LTD, All Rights Reserved.</div><script>(function(h,o,t,j,a,r){h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};h._hjSettings={hjid:2567416,hjsv:6};a=o.getElementsByTagName('head')[0];r=o.createElement('script');r.async=1;r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;a.appendChild(r);})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-VV6PGDHH84"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
gtag('js',new Date());gtag('config','G-VV6PGDHH84');</script><script type=text/javascript>var _smartsupp=_smartsupp||{};_smartsupp.key='691ff544d18a237005a011a7290b839d8fe811a4';window.smartsupp||(function(d){var s,c,o=smartsupp=function(){o._.push(arguments)};o._=[];s=d.getElementsByTagName('script')[0];c=d.createElement('script');c.type='text/javascript';c.charset='utf-8';c.async=true;c.src='https://www.smartsuppchat.com/loader.js?';s.parentNode.insertBefore(c,s);})(document);</script></div></footer><label for=menu-control class="hidden book-menu-overlay"></label></div><aside class=book-toc><nav id=TableOfContents><ul><li><a href=#configuration>Configuration</a><ul><li><a href=#cli-parameters>CLI Parameters</a></li><li><a href=#configuration-file>Configuration File</a><ul><li><a href=#defining-an-entry>Defining an Entry</a></li><li><a href=#defining-a-router>Defining a Router</a></li><li><a href=#defining-a-flow>Defining a Flow</a></li><li><a href=#defining-a-resource>Defining a Resource</a></li></ul></li></ul></li></ul></nav></aside></main></body></html>
2 changes: 1 addition & 1 deletion gateway/latest/docs/getting-started/docker/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,6 @@
infini-gateway | [12-30 13:24:16] [INF] [runner.go:59] pipeline: primary started with 1 instances
infini-gateway | [12-30 13:24:16] [INF] [entry.go:257] entry [es_gateway] listen at: http://0.0.0.0:8000
infini-gateway | [12-30 13:24:16] [INF] [app.go:247] gateway now started.
</code></pre></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/latest/docs/content.en/docs/getting-started/docker.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
</code></pre></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/main/docs/content.en/docs/getting-started/docker.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
<span>Edit this page</span></a></div><div class="flex align-center footer">©INFINI.LTD, All Rights Reserved.</div><script>(function(h,o,t,j,a,r){h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};h._hjSettings={hjid:2567416,hjsv:6};a=o.getElementsByTagName('head')[0];r=o.createElement('script');r.async=1;r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;a.appendChild(r);})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-VV6PGDHH84"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
gtag('js',new Date());gtag('config','G-VV6PGDHH84');</script><script type=text/javascript>var _smartsupp=_smartsupp||{};_smartsupp.key='691ff544d18a237005a011a7290b839d8fe811a4';window.smartsupp||(function(d){var s,c,o=smartsupp=function(){o._.push(arguments)};o._=[];s=d.getElementsByTagName('script')[0];c=d.createElement('script');c.type='text/javascript';c.charset='utf-8';c.async=true;c.src='https://www.smartsuppchat.com/loader.js?';s.parentNode.insertBefore(c,s);})(document);</script></div></footer><label for=menu-control class="hidden book-menu-overlay"></label></div><aside class=book-toc><nav id=TableOfContents><ul><li><a href=#container-deployment>Container Deployment</a><ul><li><a href=#installation-demo>Installation Demo</a></li><li><a href=#downloading-an-image>Downloading an Image</a></li><li><a href=#verifying-the-image>Verifying the Image</a></li><li><a href=#creating-configuration>Creating Configuration</a></li><li><a href=#starting-the-gateway>Starting the Gateway</a></li><li><a href=#verifying-the-gateway>Verifying the Gateway</a></li><li><a href=#docker-compose>Docker Compose</a></li></ul></li></ul></nav></aside></main><script src=/gateway/latest/js/asciinema-player.js></script></body></html>
2 changes: 1 addition & 1 deletion gateway/latest/docs/getting-started/helm/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,6 @@
</code></pre></div><h2 id=uninstall>Uninstall
<a class=anchor href=#uninstall>#</a></h2><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash>helm uninstall gateway -n &lt;namespace&gt;
kubectl delete pvc gateway-data-gateway-0 -n &lt;namespace&gt;
</code></pre></div></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/latest/docs/content.en/docs/getting-started/helm.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
</code></pre></div></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/main/docs/content.en/docs/getting-started/helm.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
<span>Edit this page</span></a></div><div class="flex align-center footer">©INFINI.LTD, All Rights Reserved.</div><script>(function(h,o,t,j,a,r){h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};h._hjSettings={hjid:2567416,hjsv:6};a=o.getElementsByTagName('head')[0];r=o.createElement('script');r.async=1;r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;a.appendChild(r);})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-VV6PGDHH84"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
gtag('js',new Date());gtag('config','G-VV6PGDHH84');</script><script type=text/javascript>var _smartsupp=_smartsupp||{};_smartsupp.key='691ff544d18a237005a011a7290b839d8fe811a4';window.smartsupp||(function(d){var s,c,o=smartsupp=function(){o._.push(arguments)};o._=[];s=d.getElementsByTagName('script')[0];c=d.createElement('script');c.type='text/javascript';c.charset='utf-8';c.async=true;c.src='https://www.smartsuppchat.com/loader.js?';s.parentNode.insertBefore(c,s);})(document);</script></div></footer><label for=menu-control class="hidden book-menu-overlay"></label></div><aside class=book-toc><nav id=TableOfContents><ul><li><a href=#helm-charts>Helm Charts</a><ul><li><a href=#the-chart-repository>The Chart Repository</a></li><li><a href=#prerequisites>Prerequisites</a></li><li><a href=#install>Install</a></li><li><a href=#uninstall>Uninstall</a></li></ul></li></ul></nav></aside></main><script src=/gateway/latest/js/asciinema-player.js></script></body></html>
2 changes: 1 addition & 1 deletion gateway/latest/docs/getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@
<label for=section-7e4e95606453deb85437b78d9c3f2d72 class="flex justify-between"><a href=/gateway/latest/docs/user-cases/>User Cases</a>
<span></span></label><ul><li><a href=/gateway/latest/docs/user-cases/stories/indexing_speedup_for_big_index_rebuild/>How an Insurance Group Improved the Indexing Speed by 200x Times</a></li><li><a href=/gateway/latest/docs/user-cases/stories/a_cross_region_cluster_access_locality/>Nearest Cluster Access Across Two Cloud Providers</a></li></ul></li><li><a href=/gateway/latest/docs/troubleshooting/>FAQs</a><ul></ul></li><li><a href=/gateway/latest/docs/release-notes/>Release Notes</a><ul></ul></li></ul><ul><a class=download-btn href=https://release.infinilabs.com/gateway/>Download</a></ul></nav><script>(function(){var menu=document.querySelector("aside.book-menu nav");addEventListener("beforeunload",function(event){localStorage.setItem("menu.scrollTop",menu.scrollTop);});menu.scrollTop=localStorage.getItem("menu.scrollTop");})();</script></aside><div class=book-page><header class=book-header><div class="flex align-center justify-between"><label for=menu-control><img src=/gateway/latest/svg/menu.svg class=book-icon alt=Menu></label>
<strong>Getting Started</strong>
<label for=toc-control><img src=/gateway/latest/svg/toc.svg class=book-icon alt="Table of Contents"></label></div><aside class="hidden clearfix"><nav id=TableOfContents></nav></aside></header><article class=markdown></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/latest/docs/content.en/docs/getting-started/_index.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
<label for=toc-control><img src=/gateway/latest/svg/toc.svg class=book-icon alt="Table of Contents"></label></div><aside class="hidden clearfix"><nav id=TableOfContents></nav></aside></header><article class=markdown></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/main/docs/content.en/docs/getting-started/_index.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
<span>Edit this page</span></a></div><div class="flex align-center footer">©INFINI.LTD, All Rights Reserved.</div><script>(function(h,o,t,j,a,r){h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};h._hjSettings={hjid:2567416,hjsv:6};a=o.getElementsByTagName('head')[0];r=o.createElement('script');r.async=1;r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;a.appendChild(r);})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-VV6PGDHH84"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
gtag('js',new Date());gtag('config','G-VV6PGDHH84');</script><script type=text/javascript>var _smartsupp=_smartsupp||{};_smartsupp.key='691ff544d18a237005a011a7290b839d8fe811a4';window.smartsupp||(function(d){var s,c,o=smartsupp=function(){o._.push(arguments)};o._=[];s=d.getElementsByTagName('script')[0];c=d.createElement('script');c.type='text/javascript';c.charset='utf-8';c.async=true;c.src='https://www.smartsuppchat.com/loader.js?';s.parentNode.insertBefore(c,s);})(document);</script></div></footer><label for=menu-control class="hidden book-menu-overlay"></label></div><aside class=book-toc><nav id=TableOfContents></nav></aside></main></body></html>
2 changes: 1 addition & 1 deletion gateway/latest/docs/getting-started/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,6 @@
sudo SERVICE_NAME=mygw ./bin/gateway -service start
sudo SERVICE_NAME=mygw ./bin/gateway -service stop
sudo SERVICE_NAME=mygw ./bin/gateway -service uninstall
</code></pre><p>INFINI Gateway has been completely installed. Next, configure the gateway.</p><a href=/gateway/latest/docs/getting-started/configuration/ class=book-btn>Configuring INFINI Gateway</a></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/latest/docs/content.en/docs/getting-started/install.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
</code></pre><p>INFINI Gateway has been completely installed. Next, configure the gateway.</p><a href=/gateway/latest/docs/getting-started/configuration/ class=book-btn>Configuring INFINI Gateway</a></article><footer class=book-footer><div class="flex flex-wrap justify-between"><div><a class="flex align-center" href=https://github.com/infinilabs/gateway/edit/main/docs/content.en/docs/getting-started/install.md target=_blank rel=noopener><img src=/gateway/latest/svg/edit.svg class=book-icon alt=Edit>
<span>Edit this page</span></a></div><div class="flex align-center footer">©INFINI.LTD, All Rights Reserved.</div><script>(function(h,o,t,j,a,r){h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};h._hjSettings={hjid:2567416,hjsv:6};a=o.getElementsByTagName('head')[0];r=o.createElement('script');r.async=1;r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;a.appendChild(r);})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-VV6PGDHH84"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
gtag('js',new Date());gtag('config','G-VV6PGDHH84');</script><script type=text/javascript>var _smartsupp=_smartsupp||{};_smartsupp.key='691ff544d18a237005a011a7290b839d8fe811a4';window.smartsupp||(function(d){var s,c,o=smartsupp=function(){o._.push(arguments)};o._=[];s=d.getElementsByTagName('script')[0];c=d.createElement('script');c.type='text/javascript';c.charset='utf-8';c.async=true;c.src='https://www.smartsuppchat.com/loader.js?';s.parentNode.insertBefore(c,s);})(document);</script></div></footer><label for=menu-control class="hidden book-menu-overlay"></label></div><aside class=book-toc><nav id=TableOfContents><ul><li><a href=#installing-the-gateway>Installing the Gateway</a><ul><li><a href=#installation-demo>Installation Demo</a></li><li><a href=#downloading>Downloading</a></li><li><a href=#container-deployment>Container Deployment</a></li><li><a href=#verifying-the-installation>Verifying the Installation</a></li><li><a href=#starting-the-gateway>Starting the Gateway</a></li><li><a href=#accessing-the-gateway>Accessing the Gateway</a></li><li><a href=#shutting-down-the-gateway>Shutting Down the Gateway</a></li><li><a href=#system-service>System Service</a></li></ul></li></ul></nav></aside></main><script src=/gateway/latest/js/asciinema-player.js></script></body></html>
Loading

0 comments on commit 1682708

Please sign in to comment.