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:

  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#

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.

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

Context flags

Optional flags you can pass to gck create to customize this context:

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/ee/gammaName of the Kind cluster
imageRepositorydocker.elastic.co/elasticsearch/elasticsearchelastic/elasticsearch/standaloneElasticsearch Docker image repository
imageTaglatestgravitee-io/ee/gammaDocker image tag for all Gamma and APIM components
imagePrefixgraviteeiogravitee-io/ee/gammaDocker image prefix for all Gamma and APIM components
helmVersion(empty)gravitee-io/ee/gammaHelm chart version constraint
apiUrlhttp://apim-api.gravitee.gck.localgravitee-io/ee/gammaManagement API base URL used by all UIs
consoleUrlhttp://apim-console.gravitee.gck.localgravitee-io/ee/gammaAPIM Console URL
portalUrlhttp://apim-portal.gravitee.gck.localgravitee-io/ee/gammaAPIM Portal URL
gammaConsoleUrlhttp://gamma-console.gravitee.gck.localgravitee-io/ee/gammaGamma Console URL