Add IAMAuthPolicy doc #492
Conversation
zijun726911
force-pushed
the
iam-auth-policy-doc
branch
from
a169fa2 to
460b6ec
Compare
zijun726911
force-pushed
the
iam-auth-policy-doc
branch
from
460b6ec to
0a9a758
Compare
docs/reference/iam-auth-policy.md
Outdated
| VPC Lattice auth policies are IAM policy documents that you attach to service networks or services to control whether a specified principal has access to a group of services or specific service (AuthZ). | ||
| By attaching Kubernetes IAMAuthPolicy CRD to the k8s gateway or k8s route, you could apply auth policy to corresponding VPC Lattice service network or VPC Lattice service that you want to control access. | ||
| Please check [VPC Lattice auth policy documentation](https://docs.aws.amazon.com/vpc-lattice/latest/ug/auth-policies.html) for more details. |
There was a problem hiding this comment.
nit: formatting: can set line length limit?
There was a problem hiding this comment.
Starting from "By attaching" can be removed.
IAMAuthPolicy implements Direct Policy Attachment of Gateway API's GEP-713: Metaresources and Policy Attachment. Policy can be attached to Gateway, HTTPRoute, GRPCRoute Kinds. (you can add links to gw spec here). Gateway policy attaches to Lattice Service Network and HTTP/GRPCRoute to Lattice Service. Please see Control access to services using auth policies for more details about Lattice Auth Policies.
docs/reference/iam-auth-policy.md
Outdated
| </table> | ||
|
|
||
|
|
||
| ## IAMAauthPolicy Example |
There was a problem hiding this comment.
please move example above spec
docs/reference/iam-auth-policy.md
Outdated
| If you create the above IAMAuthPolicy in the k8s cluster, the `my-route` (and it's corresponding VPC Lattice service) will be attached with the given IAM auth policy. | ||
| Only HTTP traffic with header `header1:value1` will be allowed to access the `my-route`. Please check the [VPC Lattice documentation](https://docs.aws.amazon.com/vpc-lattice/latest/ug/auth-policies.html#auth-policies-common-elements) to get more detail on how lattice auth policy work. |
There was a problem hiding this comment.
Didnt get what the point of this part.
There was a problem hiding this comment.
Do you mean remove the whole ## IAMAauthPolicy Example section?
Done
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.