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:

  1. Open the AM Console at http://am-console.gravitee.gck.local and create a service account token.
  2. Head to the platform module in the Gamma Console at http://gamma-console.gravitee.gck.local .
  3. Use http://am-api.gravitee.gck.local as 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.

ServiceURLNotesFrom
MongoDBlocalhost:30017no authenticationmongodb/standalone
AM Consolehttp://am-console.gravitee.gck.localgravitee-io/gamma
AM Gatewayhttp://am-gateway.gravitee.gck.localgravitee-io/gamma
AM APIhttp://am-api.gravitee.gck.localgravitee-io/gamma
Elasticsearchhttp://localhost:30920security disabledelastic/elasticsearch/standalone
Gamma Consolehttp://gamma-console.gravitee.gck.localgravitee-io/gamma
APIM Consolehttp://apim-console.gravitee.gck.localgravitee-io/gamma
APIM Portalhttp://apim-portal.gravitee.gck.localgravitee-io/gamma
APIM Gatewayhttp://apim-gateway.gravitee.gck.localgravitee-io/gamma
APIM APIhttp://apim-api.gravitee.gck.localgravitee-io/gamma
Edge Gatewayhttp://edge.gravitee.gck.localgravitee-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.

FlagDescription
--disable-uiDisable the AM Console UI
--enable-otel-collectorExport gateway OpenTelemetry traces to a composed otel-collector
--enable-tlsEnable 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.

VariableDefaultOriginDescription
clusterNamegraviteegravitee-io/gammaName of the Kind cluster
imageRepositorydocker.elastic.co/elasticsearch/elasticsearchelastic/elasticsearch/standaloneElasticsearch Docker image repository
imageTaglatestgravitee-io/gammaDocker image tag for all Gamma and APIM components
imagePrefixgraviteeiogravitee-io/gammaDocker image prefix for all Gamma and APIM components
helmVersion(empty)gravitee-io/gammaHelm chart version constraint
helmChartLocatorgraviteeio/apimgravitee-io/gammaHelm 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.keygravitee-io/am/baseGravitee license key file, mounted into the AM gateway and management API when it exists
apiUrlhttp://apim-api.gravitee.gck.localgravitee-io/gammaManagement API base URL used by all UIs
consoleUrlhttp://apim-console.gravitee.gck.localgravitee-io/gammaAPIM Console URL
portalUrlhttp://apim-portal.gravitee.gck.localgravitee-io/gammaAPIM Portal URL
gammaConsoleUrlhttp://gamma-console.gravitee.gck.localgravitee-io/gammaGamma Console URL