Gamma
gravitee-io/ee/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/ee/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#
This is an Enterprise Edition (EE) context. Place your Gravitee license
key at $HOME/opt/gravitee/license.key and gck will automatically mount
it into the cluster. If the file is missing, the license component is
silently skipped (onMissing: ignore).
To use a different path, override it in your gck.yaml:
components:
- name: license
k8s:
secrets:
- name: gravitee-license
fromFile: '/custom/path/to/license.key'
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.
| Service | URL | Notes | From |
|---|---|---|---|
| MongoDB | localhost:30017 | no authentication | mongodb/standalone |
| AM Console | http://am-console.gravitee.gck.local | gravitee-io/ee/gamma | |
| AM Gateway | http://am-gateway.gravitee.gck.local | gravitee-io/ee/gamma | |
| AM API | http://am-api.gravitee.gck.local | gravitee-io/ee/gamma | |
| Elasticsearch | http://localhost:30920 | security disabled | elastic/elasticsearch/standalone |
| Gamma Console | http://gamma-console.gravitee.gck.local | gravitee-io/ee/gamma | |
| APIM Console | http://apim-console.gravitee.gck.local | gravitee-io/ee/gamma | |
| APIM Portal | http://apim-portal.gravitee.gck.local | gravitee-io/ee/gamma | |
| APIM Gateway | http://apim-gateway.gravitee.gck.local | gravitee-io/ee/gamma | |
| APIM API | http://apim-api.gravitee.gck.local | gravitee-io/ee/gamma | |
| Edge Gateway | http://edge.gravitee.gck.local | gravitee-io/ee/gamma |
Context flags
Optional flags you can pass to gck create to customize this context:
| 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/ee/gamma | Name of the Kind cluster |
imageRepository | docker.elastic.co/elasticsearch/elasticsearch | elastic/elasticsearch/standalone | Elasticsearch Docker image repository |
imageTag | latest | gravitee-io/ee/gamma | Docker image tag for all Gamma and APIM components |
imagePrefix | graviteeio | gravitee-io/ee/gamma | Docker image prefix for all Gamma and APIM components |
helmVersion | (empty) | gravitee-io/ee/gamma | Helm chart version constraint |
apiUrl | http://apim-api.gravitee.gck.local | gravitee-io/ee/gamma | Management API base URL used by all UIs |
consoleUrl | http://apim-console.gravitee.gck.local | gravitee-io/ee/gamma | APIM Console URL |
portalUrl | http://apim-portal.gravitee.gck.local | gravitee-io/ee/gamma | APIM Portal URL |
gammaConsoleUrl | http://gamma-console.gravitee.gck.local | gravitee-io/ee/gamma | Gamma Console URL |