mesh-catalog/modules/keycloak/module.json

{
  "module": "keycloak",
  "version": "1",
  "moved": true,
  "upgrade": {
    "policy": "record",
    "why": "every person's sign-in to every site goes through it, and its new version migrates its database on start: a person takes each build, after a backup (hq ADR 0236)"
  },
  "provides": [
    {
      "name": "oidc-client",
      "scope": "mesh",
      "identity": {
        "max": 255,
        "in": "a Keycloak client id"
      }
    }
  ],
  "requires": [
    "postgres-database",
    "route"
  ],
  "contributes": {
    "postgres-database": {
      "name": "keycloak"
    },
    "route": {
      "label": "keycloak",
      "endpoint": "web"
    }
  },
  "binds": {
    "postgres-database": "${dir:state}/database.json",
    "route": "${dir:state}/route.json"
  },
  "secrets": {
    "postgres-database": "${dir:state}/database.secret"
  },
  "capabilities": [
    "container-runtime"
  ],
  "emits": [
    "user.created",
    "user.deleted",
    "password.reset",
    "client.created",
    "client.retired",
    "group.created",
    "role.created",
    "admin.repaired",
    "admin.unrepaired"
  ],
  "listens": [
    {
      "name": "web",
      "port": 8080,
      "protocol": "tcp",
      "from": "mesh",
      "why": "anything the mesh runs that authenticates a person"
    }
  ],
  "serves": {
    "oidc-client": {
      "authorization-path": "/protocol/openid-connect/auth",
      "token-path": "/protocol/openid-connect/token",
      "userinfo-path": "/protocol/openid-connect/userinfo",
      "issuer": "${config:issuer}"
    }
  },
  "receives": {
    "oidc-client": "${dir:grants}/mesh.json"
  },
  "grants": {
    "oidc-client": "${dir:grants}"
  },
  "own-secrets": {
    "admin": "${dir:state}/admin.secret"
  },
  "data": {
    "consumers": {
      "oidc-client": {
        "class": "rebuildable",
        "in": "postgres-database",
        "why": "a consumer's client is made again from its declaration, with a new secret"
      }
    }
  },
  "config": {
    "url": {
      "type": "string",
      "description": "The address the module's provider reaches Keycloak's admin API at, as a URL; empty is this machine's Keycloak on its port.",
      "trusted": true,
      "default": ""
    },
    "user": {
      "type": "string",
      "description": "The Keycloak administrator the module's provider signs in as; empty is admin.",
      "trusted": true,
      "default": ""
    },
    "realm": {
      "type": "string",
      "description": "The realm the module's provider makes its consumers' clients in; empty is master.",
      "trusted": true,
      "default": ""
    },
    "issuer": {
      "type": "string",
      "description": "The issuer Keycloak's tokens name and oidc consumers are told, as the realm's URL, such as https://keycloak.example.org/realms/Example; the operator's, with no default (novox/hq ADR 0112, ADR 0155).",
      "trusted": true,
      "required": true
    }
  },
  "resources": [
    {
      "id": "mesh-state",
      "type": "directory",
      "mode": "0700",
      "place": "mesh"
    },
    {
      "id": "state",
      "type": "directory",
      "mode": "0700",
      "place": "."
    },
    {
      "id": "grants",
      "type": "directory",
      "mode": "0700"
    },
    {
      "id": "consumers",
      "type": "file",
      "path": "${dir:state}/consumers.json",
      "mode": "0600",
      "template": "files/consumers.json"
    },
    {
      "id": "admin-env",
      "type": "file",
      "path": "${dir:state}/admin.env",
      "mode": "0600",
      "template": "files/admin.env"
    },
    {
      "id": "database-env",
      "type": "file",
      "path": "${dir:state}/database.env",
      "mode": "0600",
      "template": "files/database.env"
    },
    {
      "id": "net",
      "type": "network",
      "name": "keycloak"
    },
    {
      "id": "hostname",
      "type": "file",
      "path": "${dir:state}/hostname.env",
      "mode": "0644",
      "template": "files/hostname.env"
    },
    {
      "id": "server",
      "type": "container",
      "name": "keycloak",
      "image": "quay.io/keycloak/keycloak@sha256:ecd43971114b0c764f8a3288dddab73f98cb473daccc4feaffe4dc14adeaf866",
      "network": "keycloak",
      "args": [
        "start-dev"
      ],
      "env": {
        "KC_DB": "postgres",
        "KC_HTTP_ENABLED": "true",
        "KC_HEALTH_ENABLED": "true",
        "KC_PROXY_HEADERS": "xforwarded"
      },
      "env-file": [
        "${dir:state}/admin.env",
        "${dir:state}/database.env",
        "${dir:state}/hostname.env"
      ],
      "ports": [
        "8080"
      ],
      "secrets-in-environment": "KC_DB_PASSWORD is convertible through a generated keycloak.conf (db-password=); KEYCLOAK_ADMIN_PASSWORD is env-only before Keycloak 26; not yet converted",
      "restart-on": [
        "hostname"
      ]
    },
    {
      "id": "runtime-config",
      "type": "file",
      "path": "${dir:mesh-state}/config.json",
      "mode": "0600",
      "template": "files/config.json",
      "merge": "json",
      "takes-config": [
        "url",
        "user",
        "realm",
        "issuer"
      ]
    }
  ],
  "build": {
    "artifacts": [
      {
        "name": "code",
        "kind": "bundle",
        "language": "go",
        "system": "arch",
        "from": "cmd/keycloak-provider",
        "binary": "keycloak-provider",
        "loads": [
          "keycloak-provider"
        ],
        "env": {
          "MESH_KEYCLOAK_URL": "http://127.0.0.1:${port:8080}",
          "MESH_KEYCLOAK_CONFIG_FILE": "${dir:mesh-state}/config.json",
          "MESH_KEYCLOAK_PASSWORD_FILE": "${dir:state}/admin.secret",
          "MESH_RECEIVES": "${dir:grants}/mesh.json",
          "MESH_KEYCLOAK_CONTAINER": "keycloak",
          "MESH_CONSUMERS_FILE": "${dir:state}/consumers.json"
        }
      },
      {
        "name": "files",
        "kind": "archive",
        "from": "files"
      }
    ]
  },
  "state": [
    "bound"
  ],
  "reads": [
    "mesh-controller.assignments"
  ]
}