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.
| Service | URL | Notes | From |
|---|---|---|---|
| AM Console | http://localhost:30090 | gravitee-io/am/base | |
| AM Gateway | http://localhost:30092 | gravitee-io/am/base | |
| AM API | http://localhost:30093 | gravitee-io/am/base | |
| PostgreSQL | localhost:30432 | with --use-jdbc-postgres | postgresql/standalone |
| MySQL | localhost:30306 | with --use-jdbc-mysql | mysql/standalone |
| MongoDB | localhost:30017 | with --use-mongodb
no authentication | mongodb/standalone |
Components
What gck create deploys, and which context flags change it.
| Component | Deployed |
|---|---|
postgresql | with --use-jdbc-postgres |
license | |
tls-server | |
am | |
am-nodeports | |
mysql | with --use-jdbc-mysql |
mongodb | with --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.
| Flag | Description |
|---|---|
--use-jdbc-mysql | Store AM data in MySQL over JDBC |
--use-jdbc-postgres | Store AM data in PostgreSQL over JDBC |
--use-mongodb | Store AM data in MongoDB |
--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/am/base | Name of the Kind cluster |
imageRepository | postgres | postgresql/standalone | with --use-jdbc-postgres
PostgreSQL Docker image repository |
imageTag | latest | gravitee-io/am/base | Docker image tag for all AM components |
postgresDatabase | gravitee | postgresql/standalone | with --use-jdbc-postgres
Database to create on first startup |
imagePrefix | graviteeio | gravitee-io/am/base | Docker image prefix for all AM components |
helmVersion | (empty) | gravitee-io/am/base | Helm chart version constraint |
helmChartLocator | graviteeio/am | gravitee-io/am/base | 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 |
jdbcDriver | postgresql | gravitee-io/am | with --use-jdbc-postgres
JDBC driver identifier |
jdbcHost | postgresql | gravitee-io/am | with --use-jdbc-postgres
Database hostname |
jdbcPort | 5432 | gravitee-io/am | with --use-jdbc-postgres
Database port |
jdbcDatabase | am | gravitee-io/am | not with --use-mongodb
Database name |
jdbcUsername | postgres | gravitee-io/am | with --use-jdbc-postgres
JDBC username |
jdbcPassword | postgres | gravitee-io/am | with --use-jdbc-postgres
JDBC password |
imageRepository | mysql | mysql/standalone | with --use-jdbc-mysql
MySQL Docker image repository |
mysqlDatabase | gravitee | mysql/standalone | with --use-jdbc-mysql
Database to create on first startup |
jdbcDriver | mysql | gravitee-io/am | with --use-jdbc-mysql
JDBC driver identifier |
jdbcHost | mysql | gravitee-io/am | with --use-jdbc-mysql
Database hostname |
jdbcPort | 3306 | gravitee-io/am | with --use-jdbc-mysql
Database port |
jdbcUsername | root | gravitee-io/am | with --use-jdbc-mysql
JDBC username |
jdbcPassword | mysql | gravitee-io/am | with --use-jdbc-mysql
JDBC password |
imageRepository | mongo | mongodb/standalone | with --use-mongodb
MongoDB Docker image repository |