Skip to content

Commit

Permalink
chore: update linkinator comment (envoyproxy#3870)
Browse files Browse the repository at this point in the history
Signed-off-by: zirain <[email protected]>
  • Loading branch information
zirain authored and zhaohuabing committed Jul 17, 2024
1 parent 995803c commit dc7baa6
Show file tree
Hide file tree
Showing 4 changed files with 97 additions and 6 deletions.
2 changes: 1 addition & 1 deletion internal/gatewayapi/securitypolicy.go
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ func (t *Translator) translateSecurityPolicyForGateway(
for _, r := range h.Routes {
// If any of the features are already set, it means that a more specific
// policy(targeting xRoute) has already set it, so we skip it.
if r.Security != nil {
if !r.Security.Empty() {
continue
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
gateways:
- apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
namespace: envoy-gateway
name: gateway-1
spec:
gatewayClassName: envoy-gateway-class
listeners:
- name: http
protocol: HTTP
port: 80
allowedRoutes:
namespaces:
from: All
httpRoutes:
- apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
namespace: default
name: httproute-1
spec:
hostnames:
- gateway.envoyproxy.io
parentRefs:
- namespace: envoy-gateway
name: gateway-1
sectionName: http
rules:
- matches:
- path:
value: "/foo"
backendRefs:
- name: service-1
port: 8080
securityPolicies:
- apiVersion: gateway.envoyproxy.io/v1alpha1
kind: SecurityPolicy
metadata:
namespace: envoy-gateway
name: policy-for-gateway-1
spec:
targetRef:
group: gateway.networking.k8s.io
kind: Gateway
name: gateway-1
cors:
allowOrigins:
- "http://*.example.com"
- "http://foo.bar.com"
- "https://*"
allowMethods:
- GET
- POST
allowHeaders:
- "x-header-1"
- "x-header-2"
exposeHeaders:
- "x-header-3"
- "x-header-4"
maxAge: 1000s
jwt:
providers:
- name: example1
issuer: https://one.example.com
audiences:
- one.foo.com
remoteJWKS:
uri: https://one.example.com/jwt/public-key/jwks.json
claimToHeaders:
- header: one-route-example-key
claim: claim1
- apiVersion: gateway.envoyproxy.io/v1alpha1
kind: SecurityPolicy
metadata:
namespace: default
name: policy-for-route-1
spec:
targetRef:
group: gateway.networking.k8s.io
kind: HTTPRoute
name: httproute-1
10 changes: 10 additions & 0 deletions internal/ir/xds.go
Original file line number Diff line number Diff line change
Expand Up @@ -652,6 +652,16 @@ func (s *SecurityFeatures) Validate() error {
return errs
}

func (s *SecurityFeatures) Empty() bool {
return s == nil ||
(s.Authorization != nil &&
s.BasicAuth != nil &&
s.CORS != nil &&
s.ExtAuth != nil &&
s.OIDC != nil &&
s.JWT != nil)
}

// UnstructuredRef holds unstructured data for an arbitrary k8s resource introduced by an extension
// Envoy Gateway does not need to know about the resource types in order to store and pass the data for these objects
// to an extension.
Expand Down
9 changes: 4 additions & 5 deletions tools/make/docs.mk
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
DOCS_OUTPUT_DIR := site/public
RELEASE_VERSIONS ?= $(foreach v,$(wildcard ${ROOT_DIR}/docs/*),$(notdir ${v}))
# TODO: github.com does not allow access too often, there are a lot of 429 errors
# find a way to remove github.com from ignore list
# TODO: example.com is not a valid domain, we should remove it from ignore list
LINKINATOR_IGNORE := "github.com githubusercontent.com example.com github.io _print"
CLEAN_NODE_MODULES ?= true

Expand Down Expand Up @@ -116,12 +119,8 @@ docs-release-gen:
@echo ' url = "/$(DOC_VERSION)"' >> site/hugo.toml

.PHONY: docs-check-links
docs-check-links:
docs-check-links: # Check for broken links in the docs
@$(LOG_TARGET)
# Check for broken links, right now we are focusing on the v1.0.0
# github.com does not allow access too often, there are a lot of 429 errors
# TODO: find a way to remove github.com from ignore list
# TODO: example.com is not a valid domain, we should remove it from ignore list
linkinator site/public/ -r --concurrency 25 --skip $(LINKINATOR_IGNORE)

release-notes-docs: $(tools/release-notes-docs)
Expand Down

0 comments on commit dc7baa6

Please sign in to comment.