AM

gravitee-io/am

Gravitee Access Management with your choice of datasource

Deploys a full Gravitee Access Management stack (Console UI, Gateway, and Management API). AM stores its data in PostgreSQL over JDBC unless you pick another datasource with a --use-* flag.

Install gck#

go install github.com/gravitee-io-labs/gck@latest

For other installation methods, see Installation .

Usage#

Create#

gck create --from gravitee-io/am

Pick another datasource with --use-jdbc-mysql or --use-mongodb; the Context flags table lists every option and its default. For example, AM on MongoDB:

gck create --from gravitee-io/am --use-mongodb

Cleanup#

gck delete

Quick Start#

Sign in to the Console at http://localhost:30090 with the default admin account (admin / adminadmin).

gck create ends by printing how to reach the datasource you picked. With the default PostgreSQL:

PGPASSWORD=postgres psql -h localhost -p 30432 -U postgres -d am

To configure your first identity provider, follow the Gravitee AM 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/am --set licenseFile=/path/to/license.key

Versions#

imagePrefix and imageTag pick the AM images, helmChartLocator and helmVersion the chart. They are declared by gravitee-io/am/base, so scope them to that path:

gck create --from gravitee-io/am \
  --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/am \
  --set gravitee-io.am.base.helmChartLocator=oci://registry.example.com/helm/am \
  --set gravitee-io.am.base.helmVersion='4.*'

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
AM Consolehttp://localhost:30090gravitee-io/am/base
AM Gatewayhttp://localhost:30092gravitee-io/am/base
AM APIhttp://localhost:30093gravitee-io/am/base
PostgreSQLlocalhost:30432with --use-jdbc-postgrespostgresql/standalone
MySQLlocalhost:30306with --use-jdbc-mysqlmysql/standalone
MongoDBlocalhost:30017with --use-mongodb no authenticationmongodb/standalone

Components

What gck create deploys, and which context flags change it.

ComponentDeployed
postgresqlwith --use-jdbc-postgres
licensealways
tls-serveralways
amalways
am-nodeportsalways
mysqlwith --use-jdbc-mysql
mongodbwith --use-mongodb

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
--use-jdbc-mysql
datasource
Store AM data in MySQL over JDBC
--use-jdbc-postgres
datasource
Store AM data in PostgreSQL over JDBC default
--use-mongodb
datasource
Store AM data in MongoDB
--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/am/baseName of the Kind cluster
imageRepositorypostgrespostgresql/standalonewith --use-jdbc-postgres PostgreSQL Docker image repository
imageTaglatestgravitee-io/am/baseDocker image tag for all AM components
postgresDatabasegraviteepostgresql/standalonewith --use-jdbc-postgres Database to create on first startup
imagePrefixgraviteeiogravitee-io/am/baseDocker image prefix for all AM components
helmVersion(empty)gravitee-io/am/baseHelm chart version constraint
helmChartLocatorgraviteeio/amgravitee-io/am/baseHelm 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
jdbcDriverpostgresqlgravitee-io/amwith --use-jdbc-postgres JDBC driver identifier
jdbcHostpostgresqlgravitee-io/amwith --use-jdbc-postgres Database hostname
jdbcPort5432gravitee-io/amwith --use-jdbc-postgres Database port
jdbcDatabaseamgravitee-io/amnot with --use-mongodb Database name
jdbcUsernamepostgresgravitee-io/amwith --use-jdbc-postgres JDBC username
jdbcPasswordpostgresgravitee-io/amwith --use-jdbc-postgres JDBC password
imageRepositorymysqlmysql/standalonewith --use-jdbc-mysql MySQL Docker image repository
mysqlDatabasegraviteemysql/standalonewith --use-jdbc-mysql Database to create on first startup
jdbcDrivermysqlgravitee-io/amwith --use-jdbc-mysql JDBC driver identifier
jdbcHostmysqlgravitee-io/amwith --use-jdbc-mysql Database hostname
jdbcPort3306gravitee-io/amwith --use-jdbc-mysql Database port
jdbcUsernamerootgravitee-io/amwith --use-jdbc-mysql JDBC username
jdbcPasswordmysqlgravitee-io/amwith --use-jdbc-mysql JDBC password
imageRepositorymongomongodb/standalonewith --use-mongodb MongoDB Docker image repository