Skip to content

Commit

Permalink
Include envoy extensions in the lib and the docs (#3)
Browse files Browse the repository at this point in the history
Closes #2
  • Loading branch information
harsimranmaan authored Apr 13, 2023
1 parent a110705 commit fbfbf65
Show file tree
Hide file tree
Showing 1,088 changed files with 90,338 additions and 97 deletions.
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,23 @@ gen:
mkdir -p docs
git clone --depth=1 --branch=$(ENVOY_VERSION) https://github.com/envoyproxy/envoy .gen/envoy
git clone --depth=1 https://github.com/cncf/udpa .gen/udpa
git clone --depth=1 https://github.com/googleapis/googleapis.git .gen/googleapis
git clone --depth=1 https://github.com/open-telemetry/opentelemetry-proto.git .gen/opentelemetry-proto
git clone --depth=1 https://github.com/cncf/xds .gen/xds
git clone --depth 1 --branch $(PROTOC_GEN_VALIDATE_VERSION) https://github.com/bufbuild/protoc-gen-validate .gen/validate
protoc --plugin jsonnet --jsonnet_out=envoy -I .gen/envoy/api -I .gen/udpa -I .gen/xds -I .gen/validate .gen/envoy/api/envoy/config/bootstrap/v3/bootstrap.proto
protoc --plugin jsonnet --jsonnet_out=envoy -I .gen/envoy/api -I .gen/googleapis -I .gen/opentelemetry-proto -I .gen/udpa -I .gen/xds -I .gen/validate .gen/envoy/api/envoy/config/bootstrap/v3/bootstrap.proto $(shell find .gen/envoy/api/envoy/extensions -type f -name "*.proto")
mv envoy/doc docs/doc
mv envoy/index.html docs/index.html

.PHONY: regen
regen:
rm -rf envoy
rm -rf docs
mkdir -p envoy
protoc --plugin jsonnet --jsonnet_out=envoy -I .gen/envoy/api -I .gen/udpa -I .gen/xds -I .gen/validate .gen/envoy/api/envoy/config/bootstrap/v3/bootstrap.proto
mkdir -p docs
protoc --plugin jsonnet --jsonnet_out=envoy -I .gen/envoy/api -I .gen/googleapis -I .gen/opentelemetry-proto -I .gen/udpa -I .gen/xds -I .gen/validate .gen/envoy/api/envoy/config/bootstrap/v3/bootstrap.proto $(shell find .gen/envoy/api/envoy/extensions -type f -name "*.proto")
mv envoy/doc docs/doc
mv envoy/index.html docs/index.html

.PHONY: test
test:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@


<html lang="en">
<head>
<link rel="stylesheet" href="../styles.css">
<title>envoy.config.common.key_value.v3.KeyValueStoreConfig</title>
</head>
<body>

<div class='crumb'>
<a href="../../index.html">Home</a>
</div>

<h1>envoy.config.common.key_value.v3.KeyValueStoreConfig</h1>




<h2>Example</h2>
<div class='disclaimer'>
Disclaimer: The example is meant to show what methods are available on the object and does not necessarily constitute working
code.
</div>

<pre class='example'>
local types = import 'types.libsonnet';

types.envoy.config.common.key_value.v3.KeyValueStoreConfig
.withConfig(<a href="../envoy.config.core.v3/typed-extension-config.html">types.envoy.config.core.v3.TypedExtensionConfig</a>)
._validate()

</pre>






<h2>Fields</h2>
<table class='fields'>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>One-of group</th>
<th>Required</th>
<th>Constraints</th>
</tr>
</thead>
<tbody>


<tr>
<td>config</td>
<td>



<a href="../envoy.config.core.v3/typed-extension-config.html">envoy.config.core.v3.TypedExtensionConfig</a>

</td>
<td></td>
<td>
yes&nbsp;
</td>
<td>
<code></code>
</td>
</tr>

</tbody>
</table>



</body>
</html>

Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@


<html lang="en">
<head>
<link rel="stylesheet" href="../styles.css">
<title>envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch</title>
</head>
<body>

<div class='crumb'>
<a href="../../index.html">Home</a>
</div>

<h1>envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch</h1>




<h2>Example</h2>
<div class='disclaimer'>
Disclaimer: The example is meant to show what methods are available on the object and does not necessarily constitute working
code.
</div>

<pre class='example'>
local types = import 'types.libsonnet';

types.envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch
.withBinaryMatch('c3RyaW5n')
.withStringMatch('string')
._validate()

</pre>






<h2>Fields</h2>
<table class='fields'>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>One-of group</th>
<th>Required</th>
<th>Constraints</th>
</tr>
</thead>
<tbody>


<tr>
<td>binary_match</td>
<td>



bytes

</td>
<td>rule</td>
<td>
&nbsp;
</td>
<td>
<code>{&#34;Bytes&#34;:{&#34;WellKnown&#34;:null,&#34;min_len&#34;:1}}</code>
</td>
</tr>


<tr>
<td>string_match</td>
<td>



string

</td>
<td>rule</td>
<td>
&nbsp;
</td>
<td>
<code>{&#34;String_&#34;:{&#34;WellKnown&#34;:null,&#34;min_len&#34;:1}}</code>
</td>
</tr>

</tbody>
</table>



</body>
</html>

108 changes: 108 additions & 0 deletions docs/doc/envoy.config.common.matcher.v3/http-generic-body-match.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@


<html lang="en">
<head>
<link rel="stylesheet" href="../styles.css">
<title>envoy.config.common.matcher.v3.HttpGenericBodyMatch</title>
</head>
<body>

<div class='crumb'>
<a href="../../index.html">Home</a>
</div>

<h1>envoy.config.common.matcher.v3.HttpGenericBodyMatch</h1>




<h2>Example</h2>
<div class='disclaimer'>
Disclaimer: The example is meant to show what methods are available on the object and does not necessarily constitute working
code.
</div>

<pre class='example'>
local types = import 'types.libsonnet';

types.envoy.config.common.matcher.v3.HttpGenericBodyMatch
.withBytesLimit(1)
.withPatterns(<span class='coll'>[</span> <a href="../envoy.config.common.matcher.v3/http-generic-body-match-generic-text-match.html">types.envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch</a> <span class='coll'>]</span>)
._validate()

</pre>




<h2>Nested Messages</h2>
<ul>



<li><a href="../envoy.config.common.matcher.v3/http-generic-body-match-generic-text-match.html">envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch</a></li>


</ul>



<h2>Fields</h2>
<table class='fields'>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>One-of group</th>
<th>Required</th>
<th>Constraints</th>
</tr>
</thead>
<tbody>


<tr>
<td>bytes_limit</td>
<td>



uint32

</td>
<td></td>
<td>
&nbsp;
</td>
<td>
<code></code>
</td>
</tr>


<tr>
<td>patterns</td>
<td>
[]


<a href="../envoy.config.common.matcher.v3/http-generic-body-match-generic-text-match.html">envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch</a>

</td>
<td></td>
<td>
yes&nbsp;
</td>
<td>
<code>{&#34;Repeated&#34;:{&#34;min_items&#34;:1}}</code>
</td>
</tr>

</tbody>
</table>



</body>
</html>

78 changes: 78 additions & 0 deletions docs/doc/envoy.config.common.matcher.v3/http-headers-match.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@


<html lang="en">
<head>
<link rel="stylesheet" href="../styles.css">
<title>envoy.config.common.matcher.v3.HttpHeadersMatch</title>
</head>
<body>

<div class='crumb'>
<a href="../../index.html">Home</a>
</div>

<h1>envoy.config.common.matcher.v3.HttpHeadersMatch</h1>




<h2>Example</h2>
<div class='disclaimer'>
Disclaimer: The example is meant to show what methods are available on the object and does not necessarily constitute working
code.
</div>

<pre class='example'>
local types = import 'types.libsonnet';

types.envoy.config.common.matcher.v3.HttpHeadersMatch
.withHeaders(<span class='coll'>[</span> <a href="../envoy.config.route.v3/header-matcher.html">types.envoy.config.route.v3.HeaderMatcher</a> <span class='coll'>]</span>)
._validate()

</pre>






<h2>Fields</h2>
<table class='fields'>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>One-of group</th>
<th>Required</th>
<th>Constraints</th>
</tr>
</thead>
<tbody>


<tr>
<td>headers</td>
<td>
[]


<a href="../envoy.config.route.v3/header-matcher.html">envoy.config.route.v3.HeaderMatcher</a>

</td>
<td></td>
<td>
&nbsp;
</td>
<td>
<code></code>
</td>
</tr>

</tbody>
</table>



</body>
</html>

Loading

0 comments on commit fbfbf65

Please sign in to comment.