docs: update Kubernetes deployment example
This commit is contained in:
@@ -6,7 +6,7 @@ nav_order: 1
|
||||
|
||||
# Goma Gateway
|
||||
{:.no_toc}
|
||||
Goma Gateway is a lightweight API Gateway Management.
|
||||
Goma Gateway is a lightweight High-Performance Declarative API Gateway Management.
|
||||
|
||||
<img src="https://raw.githubusercontent.com/jkaninda/goma-gateway/main/logo.png" width="150" alt="Goma logo">
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ metadata:
|
||||
spec:
|
||||
# The version of Goma Gateway
|
||||
# See: https://github.com/jkaninda/goma-gateway/releases
|
||||
gatewayVersion: latest # 0.2.2
|
||||
gatewayVersion: latest
|
||||
## Server config
|
||||
server:
|
||||
# Kubernetes tls secret name
|
||||
|
||||
@@ -27,3 +27,10 @@ With Goma, you can create custom middleware tailored to your needs and apply the
|
||||
- Validates user permissions or access rights for specific route paths.
|
||||
|
||||
Middleware provides a flexible and powerful way to enhance the functionality, security, and performance of your API.
|
||||
|
||||
## Configuration Options
|
||||
|
||||
- **`name`** (`string`): Name of the middleware without white space.
|
||||
- **`type`** (`string`): Type of the middleware.
|
||||
- **`paths`** (`array of string`): Paths to prevent or protect.
|
||||
- **`rule`** (`dictionary`): Middleware rule, changes depending on their type.
|
||||
|
||||
@@ -13,8 +13,8 @@ These settings enable precise control over traffic flow and routing within your
|
||||
|
||||
## Configuration Options
|
||||
|
||||
- **`sslCertFile`** (`string`): Path to the SSL certificate file.
|
||||
- **`sslKeyFile`** (`string`): Path to the SSL certificate private key file.
|
||||
- **`tlsCertFile`** (`string`): Path to the TLS certificate file.
|
||||
- **`tlsKeyFile`** (`string`): Path to the TLS certificate private key file.
|
||||
- **`redis`**: Redis configuration settings.
|
||||
- **`writeTimeout`** (`integer`): Timeout for writing responses (in seconds).
|
||||
- **`readTimeout`** (`integer`): Timeout for reading requests (in seconds).
|
||||
@@ -103,7 +103,7 @@ metadata:
|
||||
spec:
|
||||
# The version of Goma Gateway
|
||||
# See: https://github.com/jkaninda/goma-gateway/releases
|
||||
gatewayVersion: latest # 0.2.2
|
||||
gatewayVersion: latest
|
||||
server:
|
||||
# Kubernetes tls secret name
|
||||
tlsSecretName: '' #Optional, tls-secret
|
||||
|
||||
Reference in New Issue
Block a user