docs: update operator deployment

This commit is contained in:
Jonas Kaninda
2024-12-02 07:50:42 +01:00
parent 015906b009
commit bca392ce1c
25 changed files with 281 additions and 292 deletions

View File

@@ -0,0 +1,33 @@
---
title: Distributed instances
layout: default
parent: Monitoring and Performance
nav_order: 4
---
# Distributed instances
Goma Gateway includes built-in support for Redis-based rate limiting, enabling efficient and scalable deployments.
By leveraging Redis, the Gateway ensures high-performance request throttling and distributed rate limiting across multiple instances, making it ideal for modern, cloud-native architectures.
```yaml
version: "1.0"
gateway:
tlsCertFile: cert.pem
tlsKeyFile: key.pem
writeTimeout: 15
readTimeout: 15
idleTimeout: 30
rateLimit: 60 # peer minute
blockCommonExploits: false
accessLog: /dev/Stdout
errorLog: /dev/stderr
logLevel: ''
## Redis connexion for distributed rate limiting; when using multiple instances | It's optional
redis:
addr: redis:6379
password: password
```

8
docs/monitoring/index.md Normal file
View File

@@ -0,0 +1,8 @@
---
title: Monitoring and Performance
layout: default
nav_order: 5
has_children: true
---
## Monitoring and Performance

View File

@@ -0,0 +1,39 @@
---
title: Load Balancing
layout: default
parent: Monitoring and Performance
nav_order: 3
---
# Load Balancing
Goma Gateway supports round-robin algorithm load balancing.
It comes with an integrated load balancing backends healthcheck.
```yaml
version: 1.0
gateway:
routes:
- path: /
name: example route
hosts:
- example.com
- example.localhost
rewrite: /
methods: []
healthCheck:
path: "/"
interval: 30s
timeout: 10s
healthyStatuses: [200,404]
## destination: will be override by backends
destination: ""
backends:
- https://example.com
- https://example2.com
- https://example4.com
cors:
```

View File

@@ -0,0 +1,34 @@
---
title: Logging
layout: default
parent: Monitoring and Performance
nav_order: 2
---
# Logging
### Set the log level to TRACE
Setting the log level to trace configures the server to trace-log all the headers given in forward auth requests.
This is helpful to confirm that certain required Headers are correctly forwarded from the reverse proxy.
### When using the environment variable
Set the Goma log level to TRACE:
Add the following block to your .env file:
```shell
GOMA_LOG_LEVEL=trace
```
### When using a configuration file
Edit the Goma settings and set `logLevel: trace`.
### Disable logging
To disable logs, you need to set `logLevel: off`, it will turn off logs

View File

@@ -0,0 +1,21 @@
---
title: Monitoring
layout: default
parent: Monitoring and Performance
nav_order: 1
---
# Monitoring
Goma collects and exports metrics
To enable metrics, you need to set `enableMetrics` to `true` and the metrics are available at `/metrics`
```yaml
version: 1.0
gateway:
enableMetrics: true
...
```