Gamma
gravitee-io/gamma
Gravitee Gamma with Access Management and MongoDB backend
Deploys a full Gravitee Gamma stack alongside Access Management, backed by MongoDB for persistence and Elasticsearch for analytics.
Install gck#
go install github.com/gravitee-io-labs/gck@latest
For other installation methods, see Installation .
This context uses DNS for service routing. After creating the cluster, run the
one-time OS setup so *.gck.local hostnames resolve on your machine (may require
sudo):
gck setup dns
See the Networking guide for details.
Usage#
Create#
gck create --from gravitee-io/gamma
Cleanup#
gck delete
Quick Start#
Sign in to the Gamma Console at http://gamma-console.gravitee.gck.local
with the default admin account (admin / admin).
The APIM Console is available at http://apim-console.gravitee.gck.local
with the same credentials, and the AM Console at
http://am-console.gravitee.gck.local
(admin / adminadmin).
To connect Gamma to Access Management:
- Open the AM Console at http://am-console.gravitee.gck.local and create a service account token.
- Head to the platform module in the Gamma Console at http://gamma-console.gravitee.gck.local .
- Use
http://am-api.gravitee.gck.localas the AM URL and paste the token.
To get started with Gravitee API Management, follow the APIM quick start guide .
License#
Place your Gravitee license key at $HOME/opt/gravitee/license.key and gck
mounts it into the cluster; without it, everything that does not need a
license runs as usual. Licensed features (flags marked as such) refuse to
start without the file. To use another path, set it at creation time:
gck create --from gravitee-io/gamma --set licenseFile=/path/to/license.key
Versions#
imagePrefix and imageTag pick the Gamma and APIM images, helmChartLocator
and helmVersion the chart. AM is composed from gravitee-io/am/base, so its
vars are scoped to that path. Pin both products to a release:
gck create --from gravitee-io/gamma \
--set gravitee-io.gamma.imageTag=4.12.20 --set gravitee-io.gamma.helmVersion=4.12.20 \
--set gravitee-io.am.base.imageTag=4.12.7 --set gravitee-io.am.base.helmVersion=4.12.7
To install a chart from somewhere other than helm.gravitee.io, such as an OCI
registry, set helmChartLocator. Always give an explicit helmVersion with
it: an empty one means the highest tag in the registry, whatever pushed it.
gck create --from gravitee-io/gamma \
--set gravitee-io.gamma.helmChartLocator=oci://registry.example.com/helm/apim \
--set gravitee-io.gamma.helmVersion='4.*'
Composition chain
This context is composed from the following base contexts:
Endpoints
Services this context exposes on your machine after gck create, including the ones it inherits from the contexts it composes. Rows marked with a flag only exist when you pass it; rows marked with an alternative only exist when it is selected, and rows marked not with one disappear when it is.
| Service | URL | Notes | From |
|---|---|---|---|
| MongoDB | localhost:30017 | no authentication | mongodb/standalone |
| AM Console | http://am-console.gravitee.gck.local | gravitee-io/gamma | |
| AM Gateway | http://am-gateway.gravitee.gck.local | gravitee-io/gamma | |
| AM API | http://am-api.gravitee.gck.local | gravitee-io/gamma | |
| Elasticsearch | http://localhost:30920 | security disabled | elastic/elasticsearch/standalone |
| Gamma Console | http://gamma-console.gravitee.gck.local | gravitee-io/gamma | |
| APIM Console | http://apim-console.gravitee.gck.local | gravitee-io/gamma | |
| APIM Portal | http://apim-portal.gravitee.gck.local | gravitee-io/gamma | |
| APIM Gateway | http://apim-gateway.gravitee.gck.local | gravitee-io/gamma | |
| APIM API | http://apim-api.gravitee.gck.local | gravitee-io/gamma | |
| Edge Gateway | http://edge.gravitee.gck.local | gravitee-io/gamma |
Context flags
Flags you can pass to gck create to customize this context. Flags tagged with a group are mutually exclusive: pass at most one per group, the default applies otherwise.
| Flag | Description |
|---|---|
--disable-ui | Disable the AM Console UI |
--enable-otel-collector | Export gateway OpenTelemetry traces to a composed otel-collector |
--enable-tls | Enable TLS on the AM gateway |
Variables
Template variables overridable with --set. Use --set path.segments.var=value to target a specific context in the composition chain.
| Variable | Default | Origin | Description |
|---|---|---|---|
clusterName | gravitee | gravitee-io/gamma | Name of the Kind cluster |
imageRepository | docker.elastic.co/elasticsearch/elasticsearch | elastic/elasticsearch/standalone | Elasticsearch Docker image repository |
imageTag | latest | gravitee-io/gamma | Docker image tag for all Gamma and APIM components |
imagePrefix | graviteeio | gravitee-io/gamma | Docker image prefix for all Gamma and APIM components |
helmVersion | (empty) | gravitee-io/gamma | Helm chart version constraint |
helmChartLocator | graviteeio/apim | gravitee-io/gamma | Helm chart reference: repo/chart, oci://registry/path/chart, a path or a URL. An OCI chart needs an explicit helmVersion |
licenseFile | {{ env "HOME" }}/opt/gravitee/license.key | gravitee-io/am/base | Gravitee license key file, mounted into the AM gateway and management API when it exists |
apiUrl | http://apim-api.gravitee.gck.local | gravitee-io/gamma | Management API base URL used by all UIs |
consoleUrl | http://apim-console.gravitee.gck.local | gravitee-io/gamma | APIM Console URL |
portalUrl | http://apim-portal.gravitee.gck.local | gravitee-io/gamma | APIM Portal URL |
gammaConsoleUrl | http://gamma-console.gravitee.gck.local | gravitee-io/gamma | Gamma Console URL |