Commit Graph

31 Commits

Author SHA1 Message Date
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
Daneyon Hansen 2b5bf4c8a0
Adds Service Type to PolicyTargetReference API Docs (#3199)
Previously, only a Gateway resource was defined as a supported
attachment type. This PR updates the API docs to include a Service
as a supported type and also fixes an incorrect link to Gateway API
documentation.

Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
2024-05-15 22:29:11 -04:00
John Howard 7dfab5580f
Place JWTRule under RequestAuthentication like every other API (#3187)
There is no reason for this to be split, it just makes the docs more
confusing.

I am fairly sure this change only impacts the HTML, merging two pages
into one. I tested with istio.io/istio still builds fine.
2024-05-13 08:22:20 -07:00
John Howard fe48267f86
policy attachment: allow `targetRefs` (#3159)
* policy attachment: allow `targetRefs`

Based on https://github.com/kubernetes-sigs/gateway-api/pull/2966. Note
that we do not HAVE to follow the GatewayAPI here; we can make our own
decision. There is, however, a general desire to allow multiple for
ergonomics.

In this proposal, I hide `targetRef`, but the API will remain + be
implemented forever. Implementation cost here is near zero, as we can
easily translate it to a single `targetRefs`; we just hide from docs to
push users toward the new ones.

* codegen

* Align documentation

* consistency
2024-04-12 13:44:31 -07: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
Keith Mattix II bb3cb9c034
Add note on targetRef + authorization policy in multi-revision environment (#3021)
Signed-off-by: Keith Mattix II <keithmattix@microsoft.com>
2023-12-08 11:57:07 -08:00
Jackie Elliott 283cc40b07
Define targetRef proto (#2888)
* Define protobuf for PolicyTargetReference

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Add targetRef to AuthorizationPolicy, Telemetry, WasmPlugin,
ProxyConfig, and RequestAuthentication.

Need more examples.

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Add examples

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Moved targetRef def to selector.proto. Removed kubebuilder
comments. Added release note for targetRef.

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Add oneof to CRD protos. Add clarifying comments about intended
use of taretRef.

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Remove targetRef from ProxyConfig

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Removed root namespace references and ingress gateway targetRef
examples.

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Hide API changes from docs and remove examples until impl is
complete

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Remove telemtry example until impl complete

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* add clarification resource must be in same ns as policy and add
oneof to wasm plugin.

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Remove oneof in to avoid go changes.

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* update release note to clarify scope is limited to waypoints

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Update authorizationPolicy selector comment

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* clarify in targetRef description only waypoint is supported as a
targeted resource

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* add k8s gateway references

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Respond to PR feedback and add selector example.

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

* Address nits

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>

---------

Signed-off-by: Jackie Elliott <jaellio@microsoft.com>
2023-09-05 15:45:52 -07:00
wulianglongrd 68bd84f7b0
fix JWT claim based routing doc (#2918) 2023-08-29 02:48:34 -07:00
AndreaM12345 f8ef33f530
fixes for Duplicate reference docs overwriting each other (#2811)
* change page

* changes for docs to sync the needed ones

* fix tabset error

* fix spacing issue

* add checks to sync.sh to ensure mode is set

* fix changes from merge

* fix missing tabset

* fix tabset again
2023-06-22 06:41:07 -07: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
John Howard 72aa7f8e98
Validate and fix all samples (#2413)
* Fix broken samples

* run make gen
2022-07-12 19:08:17 -07:00
Yangmin Zhu a6aeb68ad2
clarify multiple tokens case for request authentication API (#2220)
* clarify multiple tokens case for request authentication API

* address comments
2022-02-06 19:04:16 -08:00
Yangmin Zhu 4af825ec1a
update authz and JWT documentation (#2152) 2021-12-07 11:02:10 -08:00
Yangmin Zhu a1902f2405
update jwt based routing (#2134)
* update jwt based routing

* update

* update

* update comment

* update comment

* add quote

* address comments

* update comment
2021-11-08 13:38:41 -08:00
Yangmin Zhu 5eaecec55c
support x-jwt-claim in request authentication (#2105)
* support x-jwt-claim in virtual service

* update

* update to request authN

* revert vs

* Apply suggestions from code review

Co-authored-by: Sven Mawson <sven@google.com>

* update

Co-authored-by: Sven Mawson <sven@google.com>
2021-10-04 09:49:41 -07:00
Jianfei Hu 7f52510f94
Clarify request authentication root namespace scope. (#2086)
* Clarify request authentication root namespace scope.

* typo fix.

* make gen.

* make gen.

* clarified all workloads instead.

* update with authz example.

* Update security/v1beta1/request_authentication.proto

Co-authored-by: Sven Mawson <sven@google.com>

* Update security/v1beta1/request_authentication.proto

Co-authored-by: Sven Mawson <sven@google.com>

* update the doc gen.

Co-authored-by: Lin Sun <lin.sun@solo.io>
Co-authored-by: Sven Mawson <sven@google.com>
2021-09-14 11:39:02 -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
Yangmin Zhu ccade247d8
fix request authentication comment (#1786) 2021-01-20 15:40:33 -08:00
Yangmin Zhu 8c3489c742
fix workload selector link in security API (#1705) 2020-11-05 12:26:40 -08:00
Jean-Rémy Bancel 544a95fb3c
Add missing quote in AuthenticationPolicy example. (#1672)
* Fix typo.

* Generated files.
2020-10-14 18:59:28 -07:00
Linggg 206ab80879
Fix typo in request authn v1beta1 (#1657)
* fix typo in  request authn v1beta1

* fix typo in  request authn v1beta1
2020-09-28 09:22:15 -07:00
Shamsher Ansari af0b0b3fd6
Fix broken link for WorkloadSelector (#1550) 2020-07-23 08:33:36 -07:00
Shamsher Ansari d32519b265
Fix invalid link for WorkloadSelector (#1540) 2020-07-21 10:36:07 -07:00
LukasAuerbeck c19f5f1ec5
fixed minor typos in security/request_authentication documentation (#1470)
Co-authored-by: Lukas Auerbeck <auerbeck@youniqx.com>
2020-06-16 02:00:52 -07:00
Jens Ulrich Hjuler Fosgerau e61fec7453
Fix rendering of yaml in RequestAuthentication docs (#1367) 2020-04-07 07:22:52 -07:00
Diem Vu f290a04d07
Fix comment indent (#1345) 2020-03-24 17:38:48 -07:00
Jason Wang 31e7c1917c
Fix front matter generation in some API docs (#1295)
* fix front matter generation in some API docs

* regen
2020-02-20 16:52:26 -08:00
Diem Vu 3738877341 Add forward spec to JWTRule (#1172)
* Add forward spec to JWTRule

* Drop forward_original

* Rename forward-xxx to output-

* Update proto.lock due to Jwt -> JwtRule rename

* Add back the option to keep the original token

* Update comment for less google specific

* Rename retain_ to forward_

* Fix rebase proto.lock
2019-12-16 19:20:50 -08:00
Diem Vu 70879dca4e Fix documentation for RequestAuthentication (#1168)
* Fix documentation for RequestAuthentication

* Fix merge
2019-11-14 15:48:46 -08:00
Jason Wang 4d74abbb0d Add RequestAuthentication to CRD gen (#1169) 2019-11-14 13:47:19 -08:00
Diem Vu 62bf0afefa Add RequestAuthetication API (#1151)
* Add RequestAuthetication API

* Address comments

* Make JWTHeader type to define header with prefix

* Revert go.sum

* Address more comments

* Add blank line to end of file

* Update JwtHeader field

* Rename JwtHeader to JWTHeader for consistency

* Update security/v1beta1/jwt.proto

Co-Authored-By: Sven Mawson <sven@google.com>

* Update make gen

* Regenerate file after rebase

* Update comment

* Rebase
2019-11-12 19:06:52 -08:00