Skip to content

Commit fbfbf65

Browse files
harsimranmaanharsimranmaan
authored
Include envoy extensions in the lib and the docs (#3)
Closes #2
1 parent a110705 commit fbfbf65

File tree

1,088 files changed

+90338
-97
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,088 files changed

+90338
-97
lines changed

‎Makefile

+8-2
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,23 @@ gen:
1111
mkdir -p docs
1212
git clone --depth=1 --branch=$(ENVOY_VERSION) https://github.com/envoyproxy/envoy .gen/envoy
1313
git clone --depth=1 https://github.com/cncf/udpa .gen/udpa
14+
git clone --depth=1 https://github.com/googleapis/googleapis.git .gen/googleapis
15+
git clone --depth=1 https://github.com/open-telemetry/opentelemetry-proto.git .gen/opentelemetry-proto
1416
git clone --depth=1 https://github.com/cncf/xds .gen/xds
1517
git clone --depth 1 --branch $(PROTOC_GEN_VALIDATE_VERSION) https://github.com/bufbuild/protoc-gen-validate .gen/validate
16-
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
18+
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")
1719
mv envoy/doc docs/doc
1820
mv envoy/index.html docs/index.html
1921

2022
.PHONY: regen
2123
regen:
2224
rm -rf envoy
25+
rm -rf docs
2326
mkdir -p envoy
24-
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
27+
mkdir -p docs
28+
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")
29+
mv envoy/doc docs/doc
30+
mv envoy/index.html docs/index.html
2531

2632
.PHONY: test
2733
test:

‎docs/doc/envoy.config.common.key_value.v3/key-value-store-config.html

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
2+
3+
<html lang="en">
4+
<head>
5+
<link rel="stylesheet" href="../styles.css">
6+
<title>envoy.config.common.key_value.v3.KeyValueStoreConfig</title>
7+
</head>
8+
<body>
9+
10+
<div class='crumb'>
11+
<a href="../../index.html">Home</a>
12+
</div>
13+
14+
<h1>envoy.config.common.key_value.v3.KeyValueStoreConfig</h1>
15+
16+
17+
18+
19+
<h2>Example</h2>
20+
<div class='disclaimer'>
21+
Disclaimer: The example is meant to show what methods are available on the object and does not necessarily constitute working
22+
code.
23+
</div>
24+
25+
<pre class='example'>
26+
local types = import 'types.libsonnet';
27+
28+
types.envoy.config.common.key_value.v3.KeyValueStoreConfig
29+
.withConfig(<a href="../envoy.config.core.v3/typed-extension-config.html">types.envoy.config.core.v3.TypedExtensionConfig</a>)
30+
._validate()
31+
32+
</pre>
33+
34+
35+
36+
37+
38+
39+
<h2>Fields</h2>
40+
<table class='fields'>
41+
<thead>
42+
<tr>
43+
<th>Name</th>
44+
<th>Type</th>
45+
<th>One-of group</th>
46+
<th>Required</th>
47+
<th>Constraints</th>
48+
</tr>
49+
</thead>
50+
<tbody>
51+
52+
53+
<tr>
54+
<td>config</td>
55+
<td>
56+
57+
58+
59+
<a href="../envoy.config.core.v3/typed-extension-config.html">envoy.config.core.v3.TypedExtensionConfig</a>
60+
61+
</td>
62+
<td></td>
63+
<td>
64+
yes&nbsp;
65+
</td>
66+
<td>
67+
<code></code>
68+
</td>
69+
</tr>
70+
71+
</tbody>
72+
</table>
73+
74+
75+
76+
</body>
77+
</html>
78+

‎docs/doc/envoy.config.common.matcher.v3/http-generic-body-match-generic-text-match.html

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
2+
3+
<html lang="en">
4+
<head>
5+
<link rel="stylesheet" href="../styles.css">
6+
<title>envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch</title>
7+
</head>
8+
<body>
9+
10+
<div class='crumb'>
11+
<a href="../../index.html">Home</a>
12+
</div>
13+
14+
<h1>envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch</h1>
15+
16+
17+
18+
19+
<h2>Example</h2>
20+
<div class='disclaimer'>
21+
Disclaimer: The example is meant to show what methods are available on the object and does not necessarily constitute working
22+
code.
23+
</div>
24+
25+
<pre class='example'>
26+
local types = import 'types.libsonnet';
27+
28+
types.envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch
29+
.withBinaryMatch('c3RyaW5n')
30+
.withStringMatch('string')
31+
._validate()
32+
33+
</pre>
34+
35+
36+
37+
38+
39+
40+
<h2>Fields</h2>
41+
<table class='fields'>
42+
<thead>
43+
<tr>
44+
<th>Name</th>
45+
<th>Type</th>
46+
<th>One-of group</th>
47+
<th>Required</th>
48+
<th>Constraints</th>
49+
</tr>
50+
</thead>
51+
<tbody>
52+
53+
54+
<tr>
55+
<td>binary_match</td>
56+
<td>
57+
58+
59+
60+
bytes
61+
62+
</td>
63+
<td>rule</td>
64+
<td>
65+
&nbsp;
66+
</td>
67+
<td>
68+
<code>{&#34;Bytes&#34;:{&#34;WellKnown&#34;:null,&#34;min_len&#34;:1}}</code>
69+
</td>
70+
</tr>
71+
72+
73+
<tr>
74+
<td>string_match</td>
75+
<td>
76+
77+
78+
79+
string
80+
81+
</td>
82+
<td>rule</td>
83+
<td>
84+
&nbsp;
85+
</td>
86+
<td>
87+
<code>{&#34;String_&#34;:{&#34;WellKnown&#34;:null,&#34;min_len&#34;:1}}</code>
88+
</td>
89+
</tr>
90+
91+
</tbody>
92+
</table>
93+
94+
95+
96+
</body>
97+
</html>
98+

‎docs/doc/envoy.config.common.matcher.v3/http-generic-body-match.html

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
2+
3+
<html lang="en">
4+
<head>
5+
<link rel="stylesheet" href="../styles.css">
6+
<title>envoy.config.common.matcher.v3.HttpGenericBodyMatch</title>
7+
</head>
8+
<body>
9+
10+
<div class='crumb'>
11+
<a href="../../index.html">Home</a>
12+
</div>
13+
14+
<h1>envoy.config.common.matcher.v3.HttpGenericBodyMatch</h1>
15+
16+
17+
18+
19+
<h2>Example</h2>
20+
<div class='disclaimer'>
21+
Disclaimer: The example is meant to show what methods are available on the object and does not necessarily constitute working
22+
code.
23+
</div>
24+
25+
<pre class='example'>
26+
local types = import 'types.libsonnet';
27+
28+
types.envoy.config.common.matcher.v3.HttpGenericBodyMatch
29+
.withBytesLimit(1)
30+
.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>)
31+
._validate()
32+
33+
</pre>
34+
35+
36+
37+
38+
<h2>Nested Messages</h2>
39+
<ul>
40+
41+
42+
43+
<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>
44+
45+
46+
</ul>
47+
48+
49+
50+
<h2>Fields</h2>
51+
<table class='fields'>
52+
<thead>
53+
<tr>
54+
<th>Name</th>
55+
<th>Type</th>
56+
<th>One-of group</th>
57+
<th>Required</th>
58+
<th>Constraints</th>
59+
</tr>
60+
</thead>
61+
<tbody>
62+
63+
64+
<tr>
65+
<td>bytes_limit</td>
66+
<td>
67+
68+
69+
70+
uint32
71+
72+
</td>
73+
<td></td>
74+
<td>
75+
&nbsp;
76+
</td>
77+
<td>
78+
<code></code>
79+
</td>
80+
</tr>
81+
82+
83+
<tr>
84+
<td>patterns</td>
85+
<td>
86+
[]
87+
88+
89+
<a href="../envoy.config.common.matcher.v3/http-generic-body-match-generic-text-match.html">envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch</a>
90+
91+
</td>
92+
<td></td>
93+
<td>
94+
yes&nbsp;
95+
</td>
96+
<td>
97+
<code>{&#34;Repeated&#34;:{&#34;min_items&#34;:1}}</code>
98+
</td>
99+
</tr>
100+
101+
</tbody>
102+
</table>
103+
104+
105+
106+
</body>
107+
</html>
108+

‎docs/doc/envoy.config.common.matcher.v3/http-headers-match.html

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
2+
3+
<html lang="en">
4+
<head>
5+
<link rel="stylesheet" href="../styles.css">
6+
<title>envoy.config.common.matcher.v3.HttpHeadersMatch</title>
7+
</head>
8+
<body>
9+
10+
<div class='crumb'>
11+
<a href="../../index.html">Home</a>
12+
</div>
13+
14+
<h1>envoy.config.common.matcher.v3.HttpHeadersMatch</h1>
15+
16+
17+
18+
19+
<h2>Example</h2>
20+
<div class='disclaimer'>
21+
Disclaimer: The example is meant to show what methods are available on the object and does not necessarily constitute working
22+
code.
23+
</div>
24+
25+
<pre class='example'>
26+
local types = import 'types.libsonnet';
27+
28+
types.envoy.config.common.matcher.v3.HttpHeadersMatch
29+
.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>)
30+
._validate()
31+
32+
</pre>
33+
34+
35+
36+
37+
38+
39+
<h2>Fields</h2>
40+
<table class='fields'>
41+
<thead>
42+
<tr>
43+
<th>Name</th>
44+
<th>Type</th>
45+
<th>One-of group</th>
46+
<th>Required</th>
47+
<th>Constraints</th>
48+
</tr>
49+
</thead>
50+
<tbody>
51+
52+
53+
<tr>
54+
<td>headers</td>
55+
<td>
56+
[]
57+
58+
59+
<a href="../envoy.config.route.v3/header-matcher.html">envoy.config.route.v3.HeaderMatcher</a>
60+
61+
</td>
62+
<td></td>
63+
<td>
64+
&nbsp;
65+
</td>
66+
<td>
67+
<code></code>
68+
</td>
69+
</tr>
70+
71+
</tbody>
72+
</table>
73+
74+
75+
76+
</body>
77+
</html>
78+

0 commit comments

Comments
 (0)