Skip to content

Commit 4c4ed0f

Browse files
Finish plugin examples
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
1 parent af36fb1 commit 4c4ed0f

File tree

5 files changed

+121
-71
lines changed

5 files changed

+121
-71
lines changed

app/_kong_plugins/ace/examples/example.yaml

Lines changed: 0 additions & 33 deletions
This file was deleted.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
description: 'The ACE plugin only engages with a request when it matches an operation.'
2+
3+
extended_description: |
4+
The ACE plugin only engages with a request when it matches an operation.
5+
If a request doesn't match, ACE lets the request pass through untouched.
6+
This means that non-matching requests aren't rejected, but ACE also won't perform authentication and authorization on them.
7+
This allows a request to still be processed by other plugins with a [lower priority](/gateway/entities/plugin/#plugin-priority) than ACE.
8+
9+
A limitation of this method is that all traffic outside of published APIs linked to an ACE-enabled {{site.base_gateway}} won't be access controlled, this must be configured with a different plugin.
10+
Dev Portal will not be able to protect all operations.
11+
12+
Use cases:
13+
* You have an environment where some Gateway Services or Routes are governed by Dev Portal–exposed APIs (with ACE), while others are regular Routes that should be left alone.
14+
* You already have existing traffic and other access controls in place and want to avoid interruption.
15+
16+
title: 'Only engage when a request matches an operation'
17+
18+
weight: 900
19+
20+
requirements:
21+
- "An API or API package in Dev Portal"
22+
23+
config:
24+
match_policy: required
25+
redis:
26+
host: localhost
27+
port: 6379
28+
sync_rate: 1
29+
anonymous: anonymous
30+
31+
min_version:
32+
gateway: '3.13'
33+
34+
tools:
35+
- deck
36+
- admin-api
37+
- konnect-api
38+
- kic
39+
- terraform
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
description: 'Requires every incoming request to match a defined operation from an API or API package in Dev Portal.'
2+
3+
extended_description: |
4+
Requires every incoming request to match a defined operation from an API or API package in Dev Portal.
5+
If a request doesn't match, ACE rejects the request outright with a 404.
6+
All traffic will be rejected except operations or Routes in published APIs linked to an ACE-enabled {{site.base_gateway}}.
7+
8+
{:.danger}
9+
> **Warning:** Setting the `match_policy` to `required` can **block all traffic with a 404**. Any undefined endpoints will be blocked. If you accidentally enable this in your control planes, this could cause a potential outage in production.
10+
11+
title: 'Require all requests to match operation'
12+
13+
weight: 900
14+
15+
requirements:
16+
- "An API or API package in Dev Portal"
17+
18+
config:
19+
match_policy: required
20+
redis:
21+
host: localhost
22+
port: 6379
23+
sync_rate: 1
24+
anonymous: anonymous
25+
26+
min_version:
27+
gateway: '3.13'
28+
29+
tools:
30+
- deck
31+
- admin-api
32+
- konnect-api
33+
- kic
34+
- terraform
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
description: 'The ACE plugin skips processing entirely.'
2+
3+
title: 'Skip processing'
4+
5+
weight: 900
6+
7+
requirements:
8+
- "An API or API package in Dev Portal"
9+
10+
config:
11+
match_policy: ignored
12+
redis:
13+
host: localhost
14+
port: 6379
15+
sync_rate: 1
16+
anonymous: anonymous
17+
18+
min_version:
19+
gateway: '3.13'
20+
21+
tools:
22+
- deck
23+
- admin-api
24+
- konnect-api
25+
- kic
26+
- terraform

app/_kong_plugins/ace/index.md

Lines changed: 22 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,52 +5,36 @@ name: 'ACE'
55
content_type: plugin
66

77
publisher: kong-inc
8-
description: 'placeholder'
9-
8+
description: 'The ACE plugin manages developer access control to APIs published with Dev Portal.'
109

1110
products:
12-
- gateway
11+
- gateway
1312

1413
works_on:
15-
- konnect
14+
- konnect
1615

1716
min_version:
1817
gateway: '3.13'
1918

20-
# topologies:
21-
# on_prem:
22-
# - hybrid
23-
# - db-less
24-
# - traditional
25-
# konnect_deployments:
26-
# - hybrid
27-
# - cloud-gateways
28-
# - serverless
29-
30-
# tags:
31-
# - traffic-control
32-
33-
# search_aliases:
34-
# - plugin-name-in-code eg rate-limiting-advanced
35-
# - common aliases, eg OIDC or RLA
36-
# - related terms, eg LLM for AI plugins
37-
38-
######## third-party plugin params, not needed for kong bundled plugins
39-
# third_party: true
40-
# source_code_url: ''
41-
# support_url: ''
42-
########
43-
44-
# premium_partner: true # can be a kong plugin or a third-party plugin
45-
46-
icon: ace.png # e.g. acme.svg or acme.png
47-
48-
# categories:
49-
# - traffic-control
50-
51-
# related_resources:
52-
# - text: How-to guide for the plugin
53-
# url: /how-to/guide/
19+
topologies:
20+
on_prem:
21+
- hybrid
22+
konnect_deployments:
23+
- hybrid
24+
- cloud-gateways
25+
- serverless
26+
27+
tags:
28+
- traffic-control
29+
30+
icon: ace.png
31+
32+
categories:
33+
- traffic-control
34+
35+
related_resources:
36+
- text: Dev Portal API packaging
37+
url: /dev-portal/api-catalog-and-packaging/
5438
---
5539

5640
The ACE plugin manages developer access control to APIs published with Dev Portal.

0 commit comments

Comments
 (0)