Commit Graph

43 Commits

Author SHA1 Message Date
Faseela K f7e2506971
Clarify Service Entry addresses behavior limitations (#3549)
Signed-off-by: Faseela K <faseela.k@est.tech>
2025-08-19 16:56:20 -04:00
Daniel Grimm 813f014341
fix: remove spaces to fix YAML examples in ServiceEntry docstrings (#3488) 2025-04-14 11:37:22 -04:00
Craig Box 5fcb020312
New HTML (#3388) 2024-12-16 10:19:15 -05:00
Craig Box 83045844df
Fix some proto descriptions (#3384)
* fix some protos

* change comments from proto_names to yamlCase

* missed some backticks

* add make gen from prow
2024-12-12 12:02:02 -05:00
John Howard fae8de666d
Fix incorrect SE docs (#3364)
There is no 'egress policy'.

Fixes https://github.com/istio/istio/issues/53904
2024-11-20 11:28:59 -05:00
rob salmond 76c3278753
new schema format (#3352) 2024-11-07 02:19:27 -05:00
Ian Rudie c591cad198
fix: ServiceEntryStatus (#3279)
* update status to support 1 address per host rather than 1 address per service entry

Signed-off-by: ilrudie <ian.rudie@solo.io>

* release notes

Signed-off-by: ilrudie <ian.rudie@solo.io>

---------

Signed-off-by: ilrudie <ian.rudie@solo.io>
2024-07-26 16:51:32 -04:00
Ian Rudie 840956d74e
minor reorg and fixes (#3257)
* addressing late comments from 3244

Signed-off-by: ilrudie <ilrudie@gmail.com>

* adding an istio-status-override comment so tools may override the status without hardcoding

Signed-off-by: ilrudie <ilrudie@gmail.com>

* fix spelling

Signed-off-by: ilrudie <ilrudie@gmail.com>

* move status comment to a location where it can be consumed

Signed-off-by: ilrudie <ian.rudie@solo.io>

---------

Signed-off-by: ilrudie <ilrudie@gmail.com>
Signed-off-by: ilrudie <ian.rudie@solo.io>
2024-07-06 19:10:20 -04:00
Whitney Griffith db01f1058c
update docs to show latest API version examples (#3192)
Signed-off-by: Whitney Griffith <whitney.griffith16@gmail.com>
2024-05-20 13:50:35 -04:00
John Howard 76d8e65ae7
docs: remove per-version API tabs (#3100)
Fixes https://github.com/istio/api/issues/2994
2024-03-05 07:22:21 -08:00
John Howard 4881de7246
Align REQUIRED declaration with reality (#2946)
The `REQUIRED` proto label currently does nothing. As a result, some of
them are misaligned with reality -- fields marked REQUIRED are actually
not required, and often even have valid behaviors and are used in the
real world.

Unfortunately, many of these are fields that *should* be required but
are not. To maintain backwards compatibility, these cannot be made
required at this point, sadly.

In a future PR, I intend to make `REQUIRED` *actually make it required*,
so this PR is a pre-requisite to doing that.
2023-10-05 09:46:37 -07:00
Zhonghu Xu 06179ffd0b
Separate ServiceEntry port from Gateway Server and Sidecar ingress listener (#2626)
* Separate serviceentry port from gateway and sidecar, because only service entry port need target port

* make gen

* remove targer port from port struct

* remove unused import

* remove unused import
2023-01-12 08:06:14 -08:00
Antoine Cotten 3017a057f7
Remove remnants of old example in ServiceEntry docs (#2554)
* doc(serviceentry): remove remnants of old example

This part was copied verbatim from workload_entry.proto and is not
relevant here.

* Run gen
2022-11-08 07:27:12 -08:00
Eric Van Norman a51f8f8389
Run `make gen` with the new build-tools to generate new html (#2509) 2022-10-17 06:58:09 -07:00
merusso 5b41322084
Fix API rendering issue in ServiceEntry.Resolution (#2354)
* Fix API rendering issue in ServiceEntry.Resolution

URL: https://istio.io/latest/docs/reference/config/networking/service-entry/#ServiceEntry-Resolution

ServiceEntry.Resolution description for `DNS_ROUND_ROBIN` does not
wrap `DNS_ROUND_ROBIN` in Markdown backticks, causing the keyword to
show up as italicized DNS<em>ROUND</em>ROBIN due to the underscores.

This change wraps `DNS` and `DNS_ROUND_ROBIN` in backticks, avoiding
this rendering issue.

Also added a comma in the description.

* Run `make gen`

Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
2022-05-19 10:46:59 -07:00
John Howard 5796da5cb8
Regen docs after docs change (#2287) 2022-03-16 17:02:31 -07:00
LiuDui 20feaf2097
fix httpbin.com -> example.com (#2199)
* fix httpbin.com -> httpbin.org

* update httpbin.org -> example.com
2022-01-09 18:44:07 -08:00
jacob-delgado 5c0524bcf8
Add support for Envoy's connection type LOGICAL_DNS in ServiceEntry (#2084)
* Add logical to service entry resolution

* Run make gen

* Attempt to come up with a better name instead of LOGICAL

* Run make gen

* Code review comments

* Add release notes

* Update comments

* Update previous definitions

* Fix releasenotes

* Run make gen

* Fix release notes

* Fix release notes
2021-10-04 22:43:55 -07:00
John Howard 6e9e4699ed
Validate api docs, and fix issues (#1885)
* Fix invalid examples and alpha/beta discrepencies

* gen

* license

* lint

* missing space

* gen
2021-02-17 09:30:48 -08:00
Ed Snible e7679329ea
Fix invalid ServiceEntry sample (#1392) 2020-04-17 10:10:56 -07:00
Shriram Rajagopalan 8217d7225b
VMs: Separate endpoints from service entry into WorkloadEntry (#1331)
* Separate endpoints from service entry

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* updates

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* fixes

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* sync

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* move message out

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* renaming

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* generate files

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* update release lock status

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* make gen

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>

* bad merge

Signed-off-by: Shriram Rajagopalan <rshriram@tetrate.io>
2020-03-24 17:53:57 -07:00
Jason Wang 11f0c7211a
Generate with latest build tool (#1349) 2020-03-24 16:02:30 -07:00
Daniel fefdc2c661
add more details for TCP connection timeout description (#1343)
* add more details for TCP connection timeout description

* make gen

* add mke gen-check
2020-03-21 20:01:09 -07:00
Jason Wang 082bb23391
Add networking v1beta1 example to docs (#1266) 2020-01-31 15:12:58 -08:00
Martin Taillefer cc9d61a1c5
Fix some comments that were leading to bogus HTML. (#1202) 2019-12-14 23:08:44 -08:00
Frank Budinsky 7a8183d7e4 Fix broken aliases (#1170) 2019-11-15 09:12:46 -08:00
Martin Taillefer e871b2898d
Update common files. (#1146)
- Make the gen target invoke tidy-go and mirror-licenses.
2019-10-24 13:08:52 -07:00
Jason Wang d00922a1ff Add CRD structural schema generation (#1142)
* modify cue configuration

* Add CRD structural schema generation

* remove preserveUnknowFields
2019-10-23 17:20:41 -07:00
Martin Taillefer 5ee5d605c4
Fix bad alias syntax. (#1135) 2019-10-17 10:16:37 -07:00
Martin Taillefer e0c65682fa Updated paths for networking docs. (#1133) 2019-10-17 08:53:15 -07:00
Jason Wang 1187adbd14 Use field_behavior as an option for required fields (#1125)
* use field_behavior opiton for required fields

* modify makefile to replace import path for field_behavior

* generate after image update

* changes after comments from policy and telemetry team

* regen after changes

* update networking and rebase
2019-10-14 10:42:57 -07:00
Martin Taillefer ebe44b4258
Update common files. (#1124) 2019-10-11 09:24:41 -07:00
Martin Taillefer 891d7f9d3d
Update common files. (#1121) 2019-10-09 21:18:35 -07:00
Martin Taillefer 67e00885e3
Add a gen-check target. (#1113)
- New common target to check that a repo is clean wrt generated files.
2019-10-02 09:51:41 -07:00
Rob Cernich 1b594bcab9 Support using api types with k8s code generation tools (#1081) 2019-09-25 11:01:16 -07:00
Martin Taillefer cd150f8ca1
Update common files. (#1075) 2019-09-08 08:12:11 -07:00
Zhonghu Xu 251533346f Fix invalid ServiceEntry docs (#932)
* update ServiceEntry API docs

* gen

* fix comments

* gen

* add blank lines

* fix comments
2019-06-20 09:40:21 -07:00
Martin Taillefer 7a674f5eb2 Try to check links in generated .html files (#943) 2019-06-06 14:01:26 -07:00
Martin Taillefer c9118cd127
Update to latest doc gen tool. (#889) 2019-03-29 14:57:17 -07:00
Ed Snible 785ea83cee Be precise about 'workload' vs 'workload instance' (#876) 2019-03-22 06:42:40 -07:00
John Howard 87afa02b7b Merge release-1.1 into master (#872)
* Doc fixes.

* Add high-level overview and diagrams for MCP (#805)

* document MCP

* add additional note on NACK behavior

* add a note about ignoring stale nonces

* Add envoy metrics service configuration to ProxyConfig (#803)

* Add envoy metrics service configuration to ProxyConfig

Similar to the statsd sink config, this change is in preparation for adding support for the envoy metrics service API.

* Update proto.lock

* Reorder metrics_service_address just after statsd_udp_address

* Update comment in the authN API to match with 1.1 behavior (#808)

* Rename metrics_service_address to clarify that it is for Envoy's API (#809)

Since "metrics service" is so ambiguous, this change specifically denotes that the config is for Envoy's metrics service API. The comments also now link to detailed info about the metrics service API.

* Generate separate HTML page per proto under networking (#811)

* Generate separate pages for each networking proto

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* update

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* tweaks

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* Fix interdoc references

* separate doc and go gen

* change dash to underscore

* fix

* more fixes

* makefile fix

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* remove bad target

* Revert "change dash to underscore"

This reverts commit 7fbced66f6.

* final update

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* Revert "Generate separate HTML page per proto under networking (#811)"

This reverts commit 5f14eadd since it breaks the ability
to generate reference docs in istio.io

* Update to latest tools.

* Revert "Update to latest tools."

This reverts commit 231fadc5 which I accidentally pushed to the
wrong place.

* fix mcp update error diagram (#810)

* update istio/tools (#815)

* Revert "Revert "Generate separate HTML page per proto under networking (#811)"" (#818)

* Minor updates for building docker images. (#817)

* Add spell checking for docs. (#819)

* Add a bunch of words to the custom dictionary.

* Document exportTo restrictions (#820)

* Doc fixes. (#821)

* Proxy config: Add tls_certs_to_watch field (#824)

* Proxy config: Add tls_certs_to_watch field

* Address PR comment

* Revert "Proxy config: Add tls_certs_to_watch field (#824)" (#825)

This reverts commit e613e358ae.

* Update gateway and sidecar hosts doc (#826)

* Update gateway and sidecar hosts doc

* regen

* review comments

* Update API docs (service entry, gateway, sidecar) (#831)

* Update sidecar and gateway docs

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* gen docs

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* update service entry

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* updates

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* add configurable dns refresh rate to mesh for strict dns cluster,  (#832)

* add configurable dns refresh rate to mesh for strict dns cluster, issue #12181

* add lock file

* Hosts are not ignored in ServiceEntry for HTTPs (#833)

* Hosts are not ignored in ServiceEntry for HTTPs

* Clarify

* Reword

* Generate protos

* Address code review comments

* Fix typo

* generate

* make mixer config marshal deterministic (#846)

Signed-off-by: Kuat Yessenov <kuat@google.com>

* Fix some doc errors. (#854)

This started out to just fix a bad link to unblock work on
istio.io, but I ended up fixing a bunch of typos/incorrect format
throughout.

* Fix two more broken links. (#856)

* Fix CRD examples for release-1.1 (#859)

* fix MeshNetworks demo (#841)

* fix MeshNetworks demo

* generate

* update

* last minute doc fixes (#865)

Signed-off-by: Shriram Rajagopalan <rshriram@gmail.com>

* Clarify comment for server_name field in Mixer oop auth config (#800)

* add mixerclient config to istio.io reference docs (#827)

* Envoyfilter docs fix (#867)

* Tweaks to get the mixer client config docs to be published. (#868)

* Change where the Mixer client docs are published.
2019-03-21 13:54:42 -07:00
idouba 70dd072430 ns of egress gateway should be istio-system in the context (#869) 2019-03-20 14:22:39 -07:00
Ozben Evren 5a79ba0ecb Merge release-1.1 to master (#840)
* Doc fixes.

* Add high-level overview and diagrams for MCP (#805)

* document MCP

* add additional note on NACK behavior

* add a note about ignoring stale nonces

* Add envoy metrics service configuration to ProxyConfig (#803)

* Add envoy metrics service configuration to ProxyConfig

Similar to the statsd sink config, this change is in preparation for adding support for the envoy metrics service API.

* Update proto.lock

* Reorder metrics_service_address just after statsd_udp_address

* Update comment in the authN API to match with 1.1 behavior (#808)

* Rename metrics_service_address to clarify that it is for Envoy's API (#809)

Since "metrics service" is so ambiguous, this change specifically denotes that the config is for Envoy's metrics service API. The comments also now link to detailed info about the metrics service API.

* Generate separate HTML page per proto under networking (#811)

* Generate separate pages for each networking proto

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* update

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* tweaks

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* Fix interdoc references

* separate doc and go gen

* change dash to underscore

* fix

* more fixes

* makefile fix

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* remove bad target

* Revert "change dash to underscore"

This reverts commit 7fbced66f6.

* final update

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* Revert "Generate separate HTML page per proto under networking (#811)"

This reverts commit 5f14eadd since it breaks the ability
to generate reference docs in istio.io

* Update to latest tools.

* Revert "Update to latest tools."

This reverts commit 231fadc5 which I accidentally pushed to the
wrong place.

* fix mcp update error diagram (#810)

* update istio/tools (#815)

* Revert "Revert "Generate separate HTML page per proto under networking (#811)"" (#818)

* Minor updates for building docker images. (#817)

* Add spell checking for docs. (#819)

* Add a bunch of words to the custom dictionary.

* Document exportTo restrictions (#820)

* Doc fixes. (#821)

* Proxy config: Add tls_certs_to_watch field (#824)

* Proxy config: Add tls_certs_to_watch field

* Address PR comment

* Revert "Proxy config: Add tls_certs_to_watch field (#824)" (#825)

This reverts commit e613e358ae.

* Update gateway and sidecar hosts doc (#826)

* Update gateway and sidecar hosts doc

* regen

* review comments

* Update API docs (service entry, gateway, sidecar) (#831)

* Update sidecar and gateway docs

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* gen docs

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* update service entry

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* updates

Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com>

* add configurable dns refresh rate to mesh for strict dns cluster,  (#832)

* add configurable dns refresh rate to mesh for strict dns cluster, issue #12181

* add lock file

* Post-merge generation
2019-03-09 07:47:29 -08:00