From 0895151b5974f3d64211bb7544be3af56d812b5c Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Sun, 10 Nov 2024 08:15:47 +0100 Subject: [PATCH] docs: update deployment config --- docs/middleware/access.md | 4 ++-- docs/middleware/basic.md | 4 ++-- docs/quickstart/gateway.md | 39 ++++++++++++++++++++++++++++++++ docs/quickstart/healthcheck.md | 2 +- docs/quickstart/loadbalanging.md | 2 +- docs/quickstart/route.md | 4 ++-- docs/quickstart/ssl.md | 19 ++++++++++++++++ examples/configMap.yaml | 2 +- examples/goma.yml | 2 +- goma.yml | 1 + 10 files changed, 69 insertions(+), 10 deletions(-) create mode 100644 docs/quickstart/gateway.md create mode 100644 docs/quickstart/ssl.md diff --git a/docs/middleware/access.md b/docs/middleware/access.md index 6949725..a74f757 100644 --- a/docs/middleware/access.md +++ b/docs/middleware/access.md @@ -28,8 +28,8 @@ Example of access middleware ```yaml routes: - - name: Basic auth - path: /protected + - path: /protected + name: Basic auth rewrite: / destination: 'https://example.com' methods: [POST, PUT, GET] diff --git a/docs/middleware/basic.md b/docs/middleware/basic.md index 3fc4c2e..efe3267 100644 --- a/docs/middleware/basic.md +++ b/docs/middleware/basic.md @@ -29,8 +29,8 @@ Example of access middleware ```yaml routes: - - name: Basic auth - path: /protected + - path: /protected + name: Basic auth rewrite: / destination: 'https://example.com' methods: [POST, PUT, GET] diff --git a/docs/quickstart/gateway.md b/docs/quickstart/gateway.md new file mode 100644 index 0000000..76bd28d --- /dev/null +++ b/docs/quickstart/gateway.md @@ -0,0 +1,39 @@ +--- +title: Gateway +layout: default +parent: Quickstart +nav_order: 1 +--- + +# Gateway + +```yaml +version: 1.0 +gateway: + sslCertFile: cert.pem + sslKeyFile: key.pem + writeTimeout: 15 + readTimeout: 15 + idleTimeout: 30 + # Rate limiting + rateLimiter: 0 + accessLog: /dev/Stdout + errorLog: /dev/stderr + disableRouteHealthCheckError: false + disableDisplayRouteOnStart: false + disableKeepAlive: false + disableHealthCheckStatus: false + blockCommonExploits: true + interceptErrors: + - 500 + cors: + origins: + - http://localhost:8080 + - https://example.com + headers: + Access-Control-Allow-Credentials: "true" + Access-Control-Allow-Headers: Origin, Authorization, Accept, Content-Type, Access-Control-Allow-Headers, X-Client-Id, X-Session-Id + Access-Control-Max-Age: "1728000" + routes: +``` + diff --git a/docs/quickstart/healthcheck.md b/docs/quickstart/healthcheck.md index ef85dbe..a78792c 100644 --- a/docs/quickstart/healthcheck.md +++ b/docs/quickstart/healthcheck.md @@ -2,7 +2,7 @@ title: Healthcheck layout: default parent: Quickstart -nav_order: 2 +nav_order: 5 --- diff --git a/docs/quickstart/loadbalanging.md b/docs/quickstart/loadbalanging.md index ace515c..05bd477 100644 --- a/docs/quickstart/loadbalanging.md +++ b/docs/quickstart/loadbalanging.md @@ -2,7 +2,7 @@ title: Load Balancing layout: default parent: Quickstart -nav_order: 3 +nav_order: 4 --- diff --git a/docs/quickstart/route.md b/docs/quickstart/route.md index 7655d67..333a843 100644 --- a/docs/quickstart/route.md +++ b/docs/quickstart/route.md @@ -2,7 +2,7 @@ title: Route layout: default parent: Quickstart -nav_order: 1 +nav_order: 2 --- @@ -13,7 +13,7 @@ The Route allows you to match on HTTP traffic and direct it to the backend. ### Example of a route ```yaml -version: '' +version: 1.0 gateway: routes: - name: Example diff --git a/docs/quickstart/ssl.md b/docs/quickstart/ssl.md new file mode 100644 index 0000000..2eea6b4 --- /dev/null +++ b/docs/quickstart/ssl.md @@ -0,0 +1,19 @@ +--- +title: SSL Certificate +layout: default +parent: Quickstart +nav_order: 4 +--- + + +# SSL Certificate + + + +```yaml +version: 1.0 +gateway: + sslCertFile: cert.pem + sslKeyFile: key.pem +``` + diff --git a/examples/configMap.yaml b/examples/configMap.yaml index 7b82992..f005ce5 100644 --- a/examples/configMap.yaml +++ b/examples/configMap.yaml @@ -5,7 +5,7 @@ metadata: data: goma.yml: | # Goma Gateway configurations - version: 0.1.7 + version: 1.0 gateway: # Proxy write timeout writeTimeout: 15 diff --git a/examples/goma.yml b/examples/goma.yml index aac44c2..fc2b68e 100644 --- a/examples/goma.yml +++ b/examples/goma.yml @@ -1,5 +1,5 @@ # Goma Gateway configurations -version: 0.1.7 +version: 1.0 gateway: # Proxy write timeout writeTimeout: 15 diff --git a/goma.yml b/goma.yml index 6a5450c..2949f0e 100644 --- a/goma.yml +++ b/goma.yml @@ -1,4 +1,5 @@ # Goma Gateway configurations +version: 1.0 gateway: # Proxy write timeout writeTimeout: 15