Skip to content

Commit

Permalink
gateway entities page (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
Guaris authored Jul 18, 2024
1 parent d5705a1 commit 42c355d
Show file tree
Hide file tree
Showing 5 changed files with 188 additions and 0 deletions.
9 changes: 9 additions & 0 deletions app/_includes/landing_pages/card.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div class="rounded p-2 border-2 border-gray-200 flex flex-col">
<div>
<h3>{{ include.config.title}}</h3>
<p>{{ include.config.description}}</p>
</div>
{% if include.config.cta %}
{% include landing_pages/cta.md config=include.config.cta %}
{% endif %}
</div>
1 change: 1 addition & 0 deletions app/_includes/landing_pages/image.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<img src="{{include.config.url}}" alt="{{include.config.alt_text}}" />
133 changes: 133 additions & 0 deletions app/_landing_pages/gateway-entities.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
content:
- row:
- column:
- type: header
config:
type: h1
text: "Kong Gateway Entities"
align: center

- row:
- column:
- type: structured_text
config:
blocks:
- type: text
text: |
Kong entities refer to the various components and objects that make up the Kong API Gateway and its ecosystem.
- type: image
config:
url: "https://raw.githubusercontent.com/Kong/docs.konghq.com/main/app/assets/images/products/konnect/getting-started/konnect-gateway-entities.png"
alt_text: "this is alt text"

- row:
- column:
- type: header
config:
type: h2
text: "Entity References"
- row:
- column:
- type: card
config:
title: "Service"
description: "Represent your upstream APIs or microservices. Each Service corresponds to a set of APIs that you want to expose through Kong."
cta:
text: ABC
url: "#"
align: end
- column:
- type: card
config:
title: "Routes"
description: "Define how requests are mapped to Services. Routes specify criteria such as paths, hosts, methods, and headers that determine which Service a request should be proxied to"
cta:
text: XYZ
url: "x"
align: end
- column:
- type: card
config:
title: "Consumers"
description: "Represent the clients or users consuming your APIs. Consumers can be individual users, applications, or other services."
cta:
text: ABC
url: "#"
align: end
- column:
- type: card
config:
title: "Certificates"
description: "Used for securing communication between clients and Kong or between Kong and upstream services using SSL/TLS."
cta:
text: ABC
url: "#"
align: end
- row:
- column:
- type: card
config:
title: "Upstreams"
description: "Represent a load-balanced group of backend services. An Upstream can have multiple Targets (backend services), and Kong will distribute requests among these Targets."
cta:
text: ABC
url: "#"
align: end
- column:
- type: card
config:
title: "Targets"
description: "he actual backend servers or instances that Kong forwards requests to. They are part of an Upstream."
cta:
text: XYZ
url: "x"
align: end
- column:
- type: card
config:
title: "SNIs"
description: "Server Name Indications used to support multiple SSL certificates for different domain names using a single IP address"
cta:
text: ABC
url: "#"
align: end
- column:
- type: card
config:
title: "ACLs"
description: "Used to control access to Services and Routes by grouping Consumers and allowing or denying access based on these groups"
cta:
text: ABC
url: "#"
align: end
- row:
- column:
- type: card
config:
title: "Plugins"
description: "Extend Kong’s functionality by adding features such as authentication, rate limiting, logging, and transformations. Plugins can be applied globally or on specific Services"
cta:
text: ABC
url: "#"
align: end
- column:
- type: card
config:
title: "Workspace"
description: "Extend Kong’s functionality by adding features such as authentication, rate limiting, logging, and transformations. Plugins can be applied globally or on specific Services"
cta:
text: XYZ
url: "x"
align: end
- column:
- type: structured_text
config:
blocks:
type: text
text: "&nbsp;"
- column:
- type: structured_text
config:
blocks:
type: text
text: "&nbsp;"
8 changes: 8 additions & 0 deletions app/_layouts/concept.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
---

<div class="mx-16">
<h1 class="text-3xl my-4">{{ page.title }}</h1>
{{ content }}
</div>
37 changes: 37 additions & 0 deletions app/gateway/entities/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Kong Gateway Entities
layout: landing_page
entities:
- service
- route
- upstream
- plugin
related_resources:
- text: How to create rate limiting tiers
url: /plugins/rate-limiting/
---


## Entities

Kong entities refer to the various components and objects that make up the Kong API Gateway and its ecosystem.

Entities include:

* [Services]: Represent your upstream APIs or microservices. Each Service corresponds to a set of APIs that you want to expose through Kong.
* Routes: Define how requests are mapped to Services. Routes specify criteria such as paths, hosts, methods, and headers that determine which Service a request should be proxied to.
* Consumers: Represent the clients or users consuming your APIs. Consumers can be individual users, applications, or other services.
* Plugins: Extend Kong’s functionality by adding features such as authentication, rate limiting, logging, and transformations. Plugins can be applied globally or on specific Services, Routes, or Consumers.
* Certificates: Used for securing communication between clients and Kong or between Kong and upstream services using SSL/TLS.
* Upstreams: Represent a load-balanced group of backend services. An Upstream can have multiple Targets (backend services), and Kong will distribute requests among these Targets.
* Targets: The actual backend servers or instances that Kong forwards requests to. They are part of an Upstream.
* SNIs: Server Name Indications used to support multiple SSL certificates for different domain names using a single IP address.
* ACLs (Access Control Lists): Used to control access to Services and Routes by grouping Consumers and allowing or denying access based on these groups.
* Certificates: Used to handle SSL/TLS certificates for secure communication.


{place holder text about how kong entities are kong gateway entities that map across all of our products.}


![image](https://raw.githubusercontent.com/Kong/docs.konghq.com/main/app/assets/images/products/konnect/getting-started/konnect-gateway-entities.png) #this thing renders to the right

0 comments on commit 42c355d

Please sign in to comment.