-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b…
….tgz gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/README.md gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/main.yaml gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/values.schema.json
- Loading branch information
1 parent
722ef19
commit eddd389
Showing
5 changed files
with
231 additions
and
1 deletion.
There are no files selected for viewing
Binary file added
BIN
+2.53 KB
gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz
Binary file not shown.
101 changes: 101 additions & 0 deletions
101
...ay-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| [](https://dl.circleci.com/status-badge/redirect/gh/giantswarm/gateway-api-config-app/tree/main) | ||
|
|
||
| # gateway-api-config chart | ||
|
|
||
| Giant Swarm offers a `gateway-api-config` App, which can be installed in workload clusters together with [envoy-gateway-app](https://github.com/giantswarm/envoy-gateway-app). | ||
|
|
||
| Here, we define the `gateway-api-config` chart with its templates and default configuration. | ||
|
|
||
| **What is this app?** | ||
|
|
||
| Gateway API Config is a Giant Swarm App that provides a default configuration for the Envoy Gateway App. It is a optional dependency for the Envoy Gateway App to have a default gateway configuration. | ||
|
|
||
| **Why did we add it?** | ||
|
|
||
| Since the default [envoy-gateway-app](https://github.com/giantswarm/envoy-gateway-app) only deploys the Envoy Gateway, it does not provide a default configuration for the gateway. This gives the user the flexibility to configure the gateway as needed to have a quick start. | ||
|
|
||
| **Who can use it?** | ||
|
|
||
| Any platform user who wants to have a default configuration for the Envoy Gateway App. | ||
|
|
||
| ## Installing | ||
|
|
||
| There are several ways to install this app onto a workload cluster. | ||
|
|
||
| - [Using GitOps to instantiate the App](https://docs.giantswarm.io/advanced/gitops/apps/) | ||
| - [Using our web interface](https://docs.giantswarm.io/platform-overview/web-interface/app-platform/#installing-an-app). | ||
| - By creating an [App resource](https://docs.giantswarm.io/use-the-api/management-api/crd/apps.application.giantswarm.io/) in the management cluster as explained in [Getting started with App Platform](https://docs.giantswarm.io/getting-started/app-platform/). | ||
|
|
||
| ## Configuring | ||
|
|
||
| ### values.yaml | ||
|
|
||
| **This is an example of a values file you could upload using our web interface.** | ||
|
|
||
| Configure the gateway name, class and host to your needs. | ||
|
|
||
| ```yaml | ||
| # values.yaml | ||
| gateway: | ||
| name: default | ||
| class: default | ||
| host: test.gaws.gigantic.io | ||
| ``` | ||
| ### Sample App CR and ConfigMap for the management cluster | ||
| If you have access to the platform API on the management cluster, you could create the App CR and ConfigMap directly. | ||
| Here is an example that would install the app to workload cluster `abc12`: | ||
|
|
||
| ```yaml | ||
| # appCR.yaml | ||
| apiVersion: application.giantswarm.io/v1alpha1 | ||
| kind: App | ||
| metadata: | ||
| labels: | ||
| giantswarm.io/cluster: abc12 | ||
| name: gateway-api-config | ||
| namespace: org-giantswarm | ||
| spec: | ||
| catalog: giantswarm | ||
| extraconfigs: | ||
| - name: gateway-api-config-user-values | ||
| namespace: org-giantswarm | ||
| kubeConfig: | ||
| inCluster: false | ||
| name: gateway-api-config | ||
| namespace: giantswarm | ||
| version: 0.1.0 | ||
| ``` | ||
|
|
||
| ```yaml | ||
| # user-values-configmap.yaml | ||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: gateway-api-config-user-values | ||
| namespace: org-giantswarm | ||
| data: | ||
| values: | | ||
| gateway: | ||
| name: default | ||
| class: default | ||
| host: mycluster.gaws.gigantic.io | ||
| ``` | ||
|
|
||
| See our [full reference on configuring apps](https://docs.giantswarm.io/getting-started/app-platform/app-configuration/) for more details. | ||
|
|
||
| ## Compatibility | ||
|
|
||
| This app has been tested to work with the following workload cluster release versions: | ||
|
|
||
| - 0.1.0 | ||
|
|
||
| ## Limitations | ||
|
|
||
| None | ||
|
|
||
| ## Credit | ||
|
|
||
| - [Giant Swarm Catalog](https://github.com/giantswarm/giantswarm-catalog) |
11 changes: 11 additions & 0 deletions
11
gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/main.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| annotations: | ||
| application.giantswarm.io/metadata: https://giantswarm.github.io/giantswarm-test-catalog/gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/main.yaml | ||
| application.giantswarm.io/readme: https://giantswarm.github.io/giantswarm-test-catalog/gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/README.md | ||
| application.giantswarm.io/team: team-cabbage | ||
| application.giantswarm.io/values-schema: https://giantswarm.github.io/giantswarm-test-catalog/gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/values.schema.json | ||
| chartApiVersion: v2 | ||
| chartFile: gateway-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz | ||
| dateCreated: '2025-02-05T10:51:19.514061Z' | ||
| digest: 844f66f4856b8edf2b22182ef4e7dcfadc30f954c6aac7ad3cc8d76ec1f0ff5f | ||
| home: https://github.com/giantswarm/gateway-api-config-app | ||
| icon: https://s.giantswarm.io/app-icons/gateway-api/1/light.svg |
102 changes: 102 additions & 0 deletions
102
...way-api-config-0.0.0-58d837eba23ae44db14d051465fc6f26959d033b.tgz-meta/values.schema.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/schema#", | ||
| "type": "object", | ||
| "properties": { | ||
| "baseDomain": { | ||
| "type": "string" | ||
| }, | ||
| "gatewayClasses": { | ||
| "type": "object", | ||
| "properties": { | ||
| "giantswarm-default": { | ||
| "type": "object", | ||
| "properties": { | ||
| "enabled": { | ||
| "type": "boolean" | ||
| }, | ||
| "name": { | ||
| "type": "string" | ||
| }, | ||
| "overrideExternalDnsHostname": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "gateways": { | ||
| "type": "object", | ||
| "properties": { | ||
| "giantswarm-default": { | ||
| "type": "object", | ||
| "properties": { | ||
| "className": { | ||
| "type": "string" | ||
| }, | ||
| "enabled": { | ||
| "type": "boolean" | ||
| }, | ||
| "listeners": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "allowedRoutes": { | ||
| "type": "object", | ||
| "properties": { | ||
| "namespaces": { | ||
| "type": "object", | ||
| "properties": { | ||
| "from": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "name": { | ||
| "type": "string" | ||
| }, | ||
| "port": { | ||
| "type": "integer" | ||
| }, | ||
| "protocol": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "name": { | ||
| "type": "string" | ||
| }, | ||
| "service": { | ||
| "type": "object", | ||
| "properties": { | ||
| "annotations": { | ||
| "type": "object" | ||
| } | ||
| } | ||
| }, | ||
| "tlsIssuer": { | ||
| "type": "object", | ||
| "properties": { | ||
| "email": { | ||
| "type": "string" | ||
| }, | ||
| "enabled": { | ||
| "type": "boolean" | ||
| }, | ||
| "gateway": { | ||
| "type": "string" | ||
| }, | ||
| "name": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters