Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f14c763463 | ||
|
|
ab44ff02e1 | ||
|
|
c4c44efb1b | ||
|
|
5cc6258326 | ||
|
|
21f5301268 |
@@ -94,7 +94,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_BAZARR_URL": "http://127.0.0.1:6767",
|
"MESH_BAZARR_URL": "http://127.0.0.1:${port:6767}",
|
||||||
"MESH_BAZARR_API_KEY_FILE": "/run/secrets/api-key",
|
"MESH_BAZARR_API_KEY_FILE": "/run/secrets/api-key",
|
||||||
"MESH_BAZARR_CONFIG_FILE": "/run/config/config.json",
|
"MESH_BAZARR_CONFIG_FILE": "/run/config/config.json",
|
||||||
"MESH_BAZARR_CONFIG_DIR": "/var/lib/bazarr/config"
|
"MESH_BAZARR_CONFIG_DIR": "/var/lib/bazarr/config"
|
||||||
|
|||||||
@@ -76,7 +76,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_BOOKSHELF_URL": "http://127.0.0.1:8787",
|
"MESH_BOOKSHELF_URL": "http://127.0.0.1:${port:8787}",
|
||||||
"MESH_BOOKSHELF_CONFIG_DIR": "/var/lib/bookshelf/config"
|
"MESH_BOOKSHELF_CONFIG_DIR": "/var/lib/bookshelf/config"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
|||||||
+16
-49
@@ -5,7 +5,7 @@
|
|||||||
"alert.firing"
|
"alert.firing"
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"admin": "/var/lib/mesh/grafana/admin",
|
"admin": "/var/lib/grafana-module/admin.secret",
|
||||||
"broker": "/var/lib/mesh/grafana/broker"
|
"broker": "/var/lib/mesh/grafana/broker"
|
||||||
},
|
},
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
@@ -30,68 +30,45 @@
|
|||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/grafana-module",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "data",
|
"id": "data",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/services/grafana/data",
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "472:472"
|
"owner": "472:472"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "admin-secret",
|
"id": "server-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/admin.secret",
|
"path": "/var/lib/grafana-module/server.env",
|
||||||
"mode": "0400",
|
"mode": "0600",
|
||||||
"owner": "472:472",
|
"content": "GF_SECURITY_ADMIN_PASSWORD=${secret:admin}\n"
|
||||||
"content": "${secret:admin}"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "oidc-secret",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/oidc-client.secret",
|
|
||||||
"mode": "0400",
|
|
||||||
"owner": "472:472",
|
|
||||||
"content": "${secret:oidc-client}"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "oidc-env",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/oidc.env",
|
|
||||||
"mode": "0644",
|
|
||||||
"content": "GF_SERVER_ROOT_URL=https://${bound:route:name}\nGF_AUTH_GENERIC_OAUTH_ENABLED=true\nGF_AUTH_GENERIC_OAUTH_NAME=Keycloak\nGF_AUTH_GENERIC_OAUTH_CLIENT_ID=${bound:oidc-client:as}\nGF_AUTH_GENERIC_OAUTH_CLIENT_SECRET__FILE=/run/secrets/oidc-client\nGF_AUTH_GENERIC_OAUTH_SCOPES=openid email profile roles\nGF_AUTH_GENERIC_OAUTH_AUTH_URL=${bound:oidc-client:issuer}${bound:oidc-client:authorization-path}\nGF_AUTH_GENERIC_OAUTH_TOKEN_URL=${bound:oidc-client:issuer}${bound:oidc-client:token-path}\nGF_AUTH_GENERIC_OAUTH_API_URL=${bound:oidc-client:issuer}${bound:oidc-client:userinfo-path}\nGF_AUTH_GENERIC_OAUTH_ROLE_ATTRIBUTE_PATH=contains(roles[*], 'admin') && 'Admin' || contains(realm_access.roles[*], 'admin') && 'Admin' || 'Viewer'\nGF_AUTH_GENERIC_OAUTH_USE_PKCE=true\nGF_AUTH_GENERIC_OAUTH_ALLOW_SIGN_UP=true\nGF_AUTH_GENERIC_OAUTH_ALLOW_ASSIGN_GRAFANA_ADMIN=true\n"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "grafana",
|
"name": "grafana",
|
||||||
"image": "grafana/grafana@sha256:ac461fb352abc50da10a51c7d02462e9c05488f11f53f14b3ad79a8145f638a0",
|
"image": "grafana/grafana@sha256:f772d434e8fab0049deb2b1b30abd43342bcfca1537614aa8d36080232cf4283",
|
||||||
"ports": [
|
"ports": [
|
||||||
"3000"
|
"3000"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:data}:/var/lib/grafana",
|
"/services/grafana/data:/var/lib/grafana"
|
||||||
"${dir:state}/admin.secret:/run/secrets/admin:ro",
|
|
||||||
"${dir:state}/oidc-client.secret:/run/secrets/oidc-client:ro"
|
|
||||||
],
|
],
|
||||||
"env": {
|
|
||||||
"GF_SECURITY_ADMIN_PASSWORD__FILE": "/run/secrets/admin"
|
|
||||||
},
|
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/oidc.env"
|
"/var/lib/grafana-module/server.env"
|
||||||
],
|
],
|
||||||
"restart-on": [
|
"secrets-in-environment": "grafana honours GF_SECURITY_ADMIN_PASSWORD__FILE; convertible, awaiting a bed that exercises the admin password (assigned-grafana serves tools only)"
|
||||||
"oidc-env",
|
|
||||||
"oidc-secret"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "/var/lib/mesh/grafana/config.json",
|
"path": "/var/lib/mesh/grafana/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{\n \"user\": \"admin\",\n \"password\": \"${secret:admin}\"\n}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -105,7 +82,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_GRAFANA_URL": "http://127.0.0.1:${port:3000}",
|
"MESH_GRAFANA_URL": "http://127.0.0.1:3000",
|
||||||
"MESH_GRAFANA_CONFIG_FILE": "/run/config/config.json"
|
"MESH_GRAFANA_CONFIG_FILE": "/run/config/config.json"
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
@@ -115,26 +92,16 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requires": [
|
"requires": [
|
||||||
"route",
|
"route"
|
||||||
"oidc-client"
|
|
||||||
],
|
],
|
||||||
"contributes": {
|
"contributes": {
|
||||||
"route": {
|
"route": {
|
||||||
"label": "grafana",
|
"label": "grafana",
|
||||||
"endpoint": "web"
|
"endpoint": "web"
|
||||||
},
|
|
||||||
"oidc-client": {
|
|
||||||
"label": "grafana",
|
|
||||||
"endpoint": "web",
|
|
||||||
"callback": "/login/generic_oauth"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"route": "${dir:state}/route.json",
|
"route": "/var/lib/mesh/grafana/route.json"
|
||||||
"oidc-client": "${dir:state}/oidc.json"
|
|
||||||
},
|
|
||||||
"secrets": {
|
|
||||||
"oidc-client": "/var/lib/mesh/grafana/oidc-client"
|
|
||||||
},
|
},
|
||||||
"build": {
|
"build": {
|
||||||
"on": [
|
"on": [
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ FROM ${BUILD_BASE} AS build
|
|||||||
# resolved away.
|
# resolved away.
|
||||||
WORKDIR /app/modules/keycloak
|
WORKDIR /app/modules/keycloak
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN node /app/node_modules/typescript/bin/tsc client.ts oidc.ts index.ts provisioner/index.ts tools/index.ts \
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts \
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
FROM ${RUNTIME_BASE}
|
||||||
@@ -27,4 +27,4 @@ COPY --from=build /app/modules/keycloak/dist /app/modules/keycloak/dist
|
|||||||
# the convention novox/hq issues 060/061 settled. A container that instead ran only its
|
# the convention novox/hq issues 060/061 settled. A container that instead ran only its
|
||||||
# provisioner (`run`) served no tools and emitted no events; a container that named no command
|
# provisioner (`run`) served no tools and emitted no events; a container that named no command
|
||||||
# ran no provisioner at all.
|
# ran no provisioner at all.
|
||||||
ENV MESH_TOOL_MODULES=/app/modules/keycloak/dist/index.js,/app/modules/keycloak/dist/tools/index.js,/app/modules/keycloak/dist/provisioner/index.js
|
ENV MESH_TOOL_MODULES=/app/modules/keycloak/dist/index.js,/app/modules/keycloak/dist/tools/index.js
|
||||||
|
|||||||
@@ -12,45 +12,6 @@ function meshConfig(file?: string): Record<string, string> {
|
|||||||
catch { return {}; }
|
catch { return {}; }
|
||||||
}
|
}
|
||||||
|
|
||||||
/** A secret file's value, trailing newline trimmed; undefined when unset or unreadable. */
|
|
||||||
function secretFile(file?: string): string | undefined {
|
|
||||||
if (!file) return undefined;
|
|
||||||
try { return readFileSync(file, "utf8").replace(/\n$/, "") || undefined; }
|
|
||||||
catch { return undefined; }
|
|
||||||
}
|
|
||||||
|
|
||||||
/** A client as the admin API represents it — only the fields this module reads or writes are typed;
|
|
||||||
* the rest travel through untouched, so an update never drops what somebody else set. */
|
|
||||||
export interface ClientRepresentation {
|
|
||||||
id?: string;
|
|
||||||
clientId: string;
|
|
||||||
name?: string;
|
|
||||||
enabled?: boolean;
|
|
||||||
protocol?: string;
|
|
||||||
publicClient?: boolean;
|
|
||||||
clientAuthenticatorType?: string;
|
|
||||||
secret?: string;
|
|
||||||
rootUrl?: string;
|
|
||||||
baseUrl?: string;
|
|
||||||
redirectUris?: string[];
|
|
||||||
webOrigins?: string[];
|
|
||||||
standardFlowEnabled?: boolean;
|
|
||||||
implicitFlowEnabled?: boolean;
|
|
||||||
directAccessGrantsEnabled?: boolean;
|
|
||||||
serviceAccountsEnabled?: boolean;
|
|
||||||
attributes?: Record<string, string>;
|
|
||||||
protocolMappers?: ProtocolMapperRepresentation[];
|
|
||||||
[other: string]: unknown;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ProtocolMapperRepresentation {
|
|
||||||
id?: string;
|
|
||||||
name: string;
|
|
||||||
protocol: string;
|
|
||||||
protocolMapper: string;
|
|
||||||
config: Record<string, string>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class KeycloakClient {
|
export class KeycloakClient {
|
||||||
readonly baseUrl: string;
|
readonly baseUrl: string;
|
||||||
readonly defaultRealm: string;
|
readonly defaultRealm: string;
|
||||||
@@ -79,13 +40,8 @@ export class KeycloakClient {
|
|||||||
const cfg = meshConfig(env.MESH_KEYCLOAK_CONFIG_FILE);
|
const cfg = meshConfig(env.MESH_KEYCLOAK_CONFIG_FILE);
|
||||||
const url = cfg.url ?? env.MESH_KEYCLOAK_URL ?? `http://127.0.0.1:${env.KEYCLOAK_PORT ?? "8080"}`;
|
const url = cfg.url ?? env.MESH_KEYCLOAK_URL ?? `http://127.0.0.1:${env.KEYCLOAK_PORT ?? "8080"}`;
|
||||||
const adminUser = cfg.user ?? env.MESH_KEYCLOAK_ADMIN ?? env.KEYCLOAK_ADMIN ?? "admin";
|
const adminUser = cfg.user ?? env.MESH_KEYCLOAK_ADMIN ?? env.KEYCLOAK_ADMIN ?? "admin";
|
||||||
// The admin password reaches the runtime as a file (novox/hq ADR 0086): the module's own `admin`
|
const adminPass = cfg.password ?? env.MESH_KEYCLOAK_PASSWORD ?? env.KEYCLOAK_ADMIN_PASSWORD;
|
||||||
// secret, mounted read-only. The environment forms stay for a co-located server that has them.
|
if (!adminPass) throw new Error("no Keycloak admin password — set MESH_KEYCLOAK_PASSWORD");
|
||||||
const adminPass = cfg.password ?? secretFile(env.MESH_KEYCLOAK_PASSWORD_FILE)
|
|
||||||
?? env.MESH_KEYCLOAK_PASSWORD ?? env.KEYCLOAK_ADMIN_PASSWORD;
|
|
||||||
if (!adminPass) {
|
|
||||||
throw new Error("no Keycloak admin password — set MESH_KEYCLOAK_PASSWORD_FILE (or MESH_KEYCLOAK_PASSWORD)");
|
|
||||||
}
|
|
||||||
const realm = cfg.realm ?? env.MESH_KEYCLOAK_REALM ?? "master";
|
const realm = cfg.realm ?? env.MESH_KEYCLOAK_REALM ?? "master";
|
||||||
return new KeycloakClient(url, adminUser, adminPass, realm);
|
return new KeycloakClient(url, adminUser, adminPass, realm);
|
||||||
}
|
}
|
||||||
@@ -203,50 +159,6 @@ export class KeycloakClient {
|
|||||||
return client.id as string;
|
return client.id as string;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** The one client with exactly this clientId, or undefined. The admin API's `clientId` filter is an
|
|
||||||
* exact match unless `search=true` is asked for. */
|
|
||||||
async findClient(realm: string, clientId: string): Promise<ClientRepresentation | undefined> {
|
|
||||||
const found = await this.request<ClientRepresentation[]>(
|
|
||||||
`/${realm}/clients?clientId=${encodeURIComponent(clientId)}`);
|
|
||||||
return found.find((c) => c.clientId === clientId);
|
|
||||||
}
|
|
||||||
|
|
||||||
async createClientFrom(realm: string, rep: ClientRepresentation): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients`, { method: "POST", body: JSON.stringify(rep) });
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Replace a client's representation, addressed by its internal id. */
|
|
||||||
async updateClient(realm: string, id: string, rep: ClientRepresentation): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients/${id}`, { method: "PUT", body: JSON.stringify(rep) });
|
|
||||||
}
|
|
||||||
|
|
||||||
async deleteClientById(realm: string, id: string): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients/${id}`, { method: "DELETE" });
|
|
||||||
}
|
|
||||||
|
|
||||||
async clientSecretById(realm: string, id: string): Promise<string | undefined> {
|
|
||||||
const result = await this.request<{ value?: string }>(`/${realm}/clients/${id}/client-secret`);
|
|
||||||
return result.value;
|
|
||||||
}
|
|
||||||
|
|
||||||
async listClientMappers(realm: string, id: string): Promise<ProtocolMapperRepresentation[]> {
|
|
||||||
return this.request(`/${realm}/clients/${id}/protocol-mappers/models`);
|
|
||||||
}
|
|
||||||
|
|
||||||
async addClientMapper(realm: string, id: string, mapper: ProtocolMapperRepresentation): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients/${id}/protocol-mappers/models`, {
|
|
||||||
method: "POST",
|
|
||||||
body: JSON.stringify(mapper),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async updateClientMapper(realm: string, id: string, mapper: ProtocolMapperRepresentation): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients/${id}/protocol-mappers/models/${mapper.id}`, {
|
|
||||||
method: "PUT",
|
|
||||||
body: JSON.stringify(mapper),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async deleteClient(realm: string, clientId: string): Promise<void> {
|
async deleteClient(realm: string, clientId: string): Promise<void> {
|
||||||
await this.request(`/${realm}/clients/${await this.resolveClientId(realm, clientId)}`, { method: "DELETE" });
|
await this.request(`/${realm}/clients/${await this.resolveClientId(realm, clientId)}`, { method: "DELETE" });
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,12 +1,6 @@
|
|||||||
{
|
{
|
||||||
"module": "keycloak",
|
"module": "keycloak",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"provides": [
|
|
||||||
{
|
|
||||||
"name": "oidc-client",
|
|
||||||
"scope": "mesh"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requires": [
|
"requires": [
|
||||||
"postgres-database",
|
"postgres-database",
|
||||||
"route"
|
"route"
|
||||||
@@ -47,19 +41,6 @@
|
|||||||
"why": "anything the mesh runs that authenticates a person"
|
"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"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"receives": {
|
|
||||||
"oidc-client": "/var/lib/keycloak/grants/mesh.json"
|
|
||||||
},
|
|
||||||
"grants": {
|
|
||||||
"oidc-client": "/var/lib/keycloak/grants"
|
|
||||||
},
|
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"admin": "/var/lib/keycloak/admin.secret",
|
"admin": "/var/lib/keycloak/admin.secret",
|
||||||
"broker": "/var/lib/mesh/keycloak/broker"
|
"broker": "/var/lib/mesh/keycloak/broker"
|
||||||
@@ -77,12 +58,6 @@
|
|||||||
"path": "/var/lib/keycloak",
|
"path": "/var/lib/keycloak",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"id": "grants",
|
|
||||||
"type": "directory",
|
|
||||||
"path": "/var/lib/keycloak/grants",
|
|
||||||
"mode": "0700"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"id": "admin-env",
|
"id": "admin-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
@@ -102,13 +77,6 @@
|
|||||||
"type": "network",
|
"type": "network",
|
||||||
"name": "keycloak"
|
"name": "keycloak"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"id": "hostname",
|
|
||||||
"type": "file",
|
|
||||||
"path": "/var/lib/keycloak/hostname.env",
|
|
||||||
"mode": "0644",
|
|
||||||
"content": "KC_HOSTNAME=https://${bound:route:name}\n"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
@@ -122,20 +90,17 @@
|
|||||||
"KC_DB": "postgres",
|
"KC_DB": "postgres",
|
||||||
"KC_HTTP_ENABLED": "true",
|
"KC_HTTP_ENABLED": "true",
|
||||||
"KC_HEALTH_ENABLED": "true",
|
"KC_HEALTH_ENABLED": "true",
|
||||||
|
"KC_HOSTNAME": "https://keycloak.novox.be",
|
||||||
"KC_PROXY_HEADERS": "xforwarded"
|
"KC_PROXY_HEADERS": "xforwarded"
|
||||||
},
|
},
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"/var/lib/keycloak/admin.env",
|
"/var/lib/keycloak/admin.env",
|
||||||
"/var/lib/keycloak/database.env",
|
"/var/lib/keycloak/database.env"
|
||||||
"/var/lib/keycloak/hostname.env"
|
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"8080"
|
"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",
|
"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",
|
"id": "runtime-config",
|
||||||
@@ -152,16 +117,12 @@
|
|||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"/var/lib/mesh/keycloak/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/keycloak/broker:/run/secrets/broker:ro",
|
||||||
"/var/lib/mesh/keycloak/config.json:/run/config/config.json:ro",
|
"/var/lib/mesh/keycloak/config.json:/run/config/config.json:ro"
|
||||||
"/var/lib/keycloak/admin.secret:/run/secrets/admin:ro",
|
|
||||||
"/var/lib/keycloak/grants:/var/lib/keycloak/grants:ro"
|
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_KEYCLOAK_URL": "http://127.0.0.1:${port:8080}",
|
"MESH_KEYCLOAK_URL": "http://127.0.0.1:${port:8080}",
|
||||||
"MESH_KEYCLOAK_CONFIG_FILE": "/run/config/config.json",
|
"MESH_KEYCLOAK_CONFIG_FILE": "/run/config/config.json"
|
||||||
"MESH_KEYCLOAK_PASSWORD_FILE": "/run/secrets/admin",
|
|
||||||
"MESH_RECEIVES": "/var/lib/keycloak/grants/mesh.json"
|
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
"runtime-config"
|
"runtime-config"
|
||||||
|
|||||||
@@ -1,185 +0,0 @@
|
|||||||
// What the `oidc-client` provision means in Keycloak: one confidential OpenID Connect client per
|
|
||||||
// consumer, in the realm this module serves, under the name and secret the mesh gave both ends.
|
|
||||||
// The provisioner (provisioner/index.ts) is the sdk harness calling these; they are here, apart from
|
|
||||||
// it, so they can be exercised against a fake admin API without a broker or a contributions file.
|
|
||||||
//
|
|
||||||
// **The client id and the secret are the mesh's, not Keycloak's (novox/hq ADR 0048).** The mesh
|
|
||||||
// derives the consumer's identity (`as`, e.g. `mesh_ace_grafana`) and hands it to both ends — the
|
|
||||||
// consumer names it as its client id through `${bound:oidc-client:as}` — and mints the secret, which
|
|
||||||
// this sets as the client's secret. Keycloak generates neither.
|
|
||||||
//
|
|
||||||
// **Where the consumer's browser comes back to is the consumer's to say.** Its contribution carries
|
|
||||||
// `callback` (a path, e.g. `/login/generic_oauth`) and the `label`/`endpoint` of the endpoint it is
|
|
||||||
// reached on; the mesh composes that endpoint's names into `name` (public) and `internal-name`
|
|
||||||
// (private network) exactly as it does for a route (novox/hq ADR 0056, 0138), so the redirect URI
|
|
||||||
// registered here is built from the same names the proxy serves the consumer under.
|
|
||||||
//
|
|
||||||
// **Only what the mesh made is touched.** A client this module creates carries the attribute
|
|
||||||
// `mesh.provisioned=true`, and its id starts with the mesh's own prefix. A client with the same id
|
|
||||||
// that lacks the mark is somebody else's: it is refused, never adopted, never updated, never deleted.
|
|
||||||
|
|
||||||
import type { ClientRepresentation, KeycloakClient, ProtocolMapperRepresentation } from "./client.js";
|
|
||||||
|
|
||||||
/** The attribute marking a client as the mesh's own work. */
|
|
||||||
export const MARK = "mesh.provisioned";
|
|
||||||
|
|
||||||
/** The mapper every mesh client carries: realm roles as a flat `roles` claim in the id token, the
|
|
||||||
* access token and userinfo — what a consumer maps its own roles from (grafana's role path reads
|
|
||||||
* `roles[*]`), and what the predecessor added to its hand-made clients by hand. */
|
|
||||||
export const ROLES_MAPPER: ProtocolMapperRepresentation = {
|
|
||||||
name: "realm roles",
|
|
||||||
protocol: "openid-connect",
|
|
||||||
protocolMapper: "oidc-usermodel-realm-role-mapper",
|
|
||||||
config: {
|
|
||||||
"claim.name": "roles",
|
|
||||||
"jsonType.label": "String",
|
|
||||||
multivalued: "true",
|
|
||||||
"id.token.claim": "true",
|
|
||||||
"access.token.claim": "true",
|
|
||||||
"userinfo.token.claim": "true",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
/** One consumer, as the harness hands it over. */
|
|
||||||
export interface OidcGrant {
|
|
||||||
readonly as: string;
|
|
||||||
readonly password: string;
|
|
||||||
readonly values: Readonly<Record<string, unknown>>;
|
|
||||||
readonly consumer?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The realm named by an issuer URL — `https://id.example/realms/Novox` is realm `Novox`. The issuer is
|
|
||||||
* the one value an assignment sets (it is also what consumers are served), so the realm is read
|
|
||||||
* out of it rather than set a second time where the two could disagree. */
|
|
||||||
export function realmOf(issuer: string): string {
|
|
||||||
let path: string;
|
|
||||||
try {
|
|
||||||
path = new URL(issuer).pathname;
|
|
||||||
} catch {
|
|
||||||
throw new Error(`the issuer ${JSON.stringify(issuer)} is not a URL`);
|
|
||||||
}
|
|
||||||
const m = /\/realms\/([^/]+)\/?$/.exec(path);
|
|
||||||
if (!m) throw new Error(`the issuer ${JSON.stringify(issuer)} does not end in /realms/<realm>`);
|
|
||||||
return decodeURIComponent(m[1]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The redirect URIs a consumer's contribution asks for: its callback under each name the mesh
|
|
||||||
* composed for its endpoint. Refused when there is nothing to register — a client that accepts no
|
|
||||||
* redirect is a client nobody can log in through, and one that accepts any is worse. */
|
|
||||||
export function redirectsOf(values: Readonly<Record<string, unknown>>): { root: string; redirects: string[] } {
|
|
||||||
const callback = values.callback;
|
|
||||||
if (typeof callback !== "string" || !callback.startsWith("/")) {
|
|
||||||
throw new Error(`contributes no callback path (\`callback\`, starting with "/"): ${JSON.stringify(callback)}`);
|
|
||||||
}
|
|
||||||
const names: string[] = [];
|
|
||||||
for (const key of ["name", "internal-name"]) {
|
|
||||||
const n = values[key];
|
|
||||||
if (typeof n === "string" && n.trim() !== "" && !names.includes(n.trim())) names.push(n.trim());
|
|
||||||
}
|
|
||||||
if (names.length === 0) {
|
|
||||||
throw new Error("has no name the mesh composed (`name` / `internal-name`) — contribute a `label` and the `endpoint` it is reached on");
|
|
||||||
}
|
|
||||||
return { root: `https://${names[0]}`, redirects: names.map((n) => `https://${n}${callback}`) };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The fields the mesh owns on a client it made. Everything else on the client is left as found. */
|
|
||||||
function wanted(g: OidcGrant): ClientRepresentation {
|
|
||||||
const { root, redirects } = redirectsOf(g.values);
|
|
||||||
return {
|
|
||||||
clientId: g.as,
|
|
||||||
name: g.as,
|
|
||||||
description: `made by the mesh for ${g.consumer ? `a module on ${g.consumer}` : "a consumer"} — do not edit; it is reset`,
|
|
||||||
enabled: true,
|
|
||||||
protocol: "openid-connect",
|
|
||||||
publicClient: false,
|
|
||||||
clientAuthenticatorType: "client-secret",
|
|
||||||
secret: g.password,
|
|
||||||
rootUrl: root,
|
|
||||||
baseUrl: root,
|
|
||||||
redirectUris: redirects,
|
|
||||||
standardFlowEnabled: true,
|
|
||||||
implicitFlowEnabled: false,
|
|
||||||
directAccessGrantsEnabled: false,
|
|
||||||
serviceAccountsEnabled: false,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function sameSet(a: readonly string[] | undefined, b: readonly string[]): boolean {
|
|
||||||
const x = [...(a ?? [])].sort();
|
|
||||||
const y = [...b].sort();
|
|
||||||
return x.length === y.length && x.every((v, i) => v === y[i]);
|
|
||||||
}
|
|
||||||
|
|
||||||
function marked(c: ClientRepresentation): boolean {
|
|
||||||
return c.attributes?.[MARK] === "true";
|
|
||||||
}
|
|
||||||
|
|
||||||
export class OidcClients {
|
|
||||||
constructor(private readonly kc: KeycloakClient, readonly realm: string) {}
|
|
||||||
|
|
||||||
/** Create the consumer's client, or bring the mesh's existing one back to what the grant says.
|
|
||||||
* Returns whether it was newly created. Idempotent: applying the same grant twice changes nothing
|
|
||||||
* the second time beyond re-asserting it. */
|
|
||||||
async ensure(g: OidcGrant): Promise<"created" | "updated"> {
|
|
||||||
const want = wanted(g);
|
|
||||||
const found = await this.kc.findClient(this.realm, g.as);
|
|
||||||
if (found && !marked(found)) {
|
|
||||||
throw new Error(
|
|
||||||
`realm ${this.realm} already has a client ${g.as} the mesh did not make — left alone; ` +
|
|
||||||
`delete or rename it if the mesh should own that id`);
|
|
||||||
}
|
|
||||||
if (!found) {
|
|
||||||
await this.kc.createClientFrom(this.realm, {
|
|
||||||
...want,
|
|
||||||
attributes: { [MARK]: "true" },
|
|
||||||
protocolMappers: [ROLES_MAPPER],
|
|
||||||
});
|
|
||||||
return "created";
|
|
||||||
}
|
|
||||||
// Overlay what the mesh owns on what is there, so a field Keycloak added or an operator set on a
|
|
||||||
// field the mesh does not own survives the update.
|
|
||||||
await this.kc.updateClient(this.realm, found.id!, {
|
|
||||||
...found,
|
|
||||||
...want,
|
|
||||||
attributes: { ...(found.attributes ?? {}), [MARK]: "true" },
|
|
||||||
});
|
|
||||||
await this.ensureMapper(found.id!);
|
|
||||||
return "updated";
|
|
||||||
}
|
|
||||||
|
|
||||||
private async ensureMapper(id: string): Promise<void> {
|
|
||||||
const mappers = await this.kc.listClientMappers(this.realm, id);
|
|
||||||
const have = mappers.find((m) => m.name === ROLES_MAPPER.name);
|
|
||||||
if (!have) {
|
|
||||||
await this.kc.addClientMapper(this.realm, id, ROLES_MAPPER);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const drifted =
|
|
||||||
have.protocolMapper !== ROLES_MAPPER.protocolMapper ||
|
|
||||||
Object.entries(ROLES_MAPPER.config).some(([k, v]) => have.config?.[k] !== v);
|
|
||||||
if (drifted) {
|
|
||||||
await this.kc.updateClientMapper(this.realm, id, { ...ROLES_MAPPER, id: have.id });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Whether Keycloak still holds this consumer's client exactly as the grant says: present, the
|
|
||||||
* mesh's, enabled, confidential, with the mesh's secret and the redirects asked for. Reads only. */
|
|
||||||
async holds(g: OidcGrant): Promise<boolean> {
|
|
||||||
const want = wanted(g);
|
|
||||||
const found = await this.kc.findClient(this.realm, g.as);
|
|
||||||
if (!found || !marked(found) || found.enabled === false || found.publicClient) return false;
|
|
||||||
if (!sameSet(found.redirectUris, want.redirectUris!)) return false;
|
|
||||||
const mappers = await this.kc.listClientMappers(this.realm, found.id!);
|
|
||||||
if (!mappers.some((m) => m.name === ROLES_MAPPER.name)) return false;
|
|
||||||
return (await this.kc.clientSecretById(this.realm, found.id!)) === g.password;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Withdraw a consumer's client — only one the mesh made. Returns what happened, for the log. */
|
|
||||||
async remove(as: string): Promise<"removed" | "absent" | "not ours"> {
|
|
||||||
const found = await this.kc.findClient(this.realm, as);
|
|
||||||
if (!found) return "absent";
|
|
||||||
if (!marked(found)) return "not ours";
|
|
||||||
await this.kc.deleteClientById(this.realm, found.id!);
|
|
||||||
return "removed";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,15 +1,11 @@
|
|||||||
{
|
{
|
||||||
"name": "@novox/module-keycloak",
|
"name": "@novox/module-keycloak",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "keycloak — identity and access; provides the mesh oidc-client interface. Its admin API client, provisioner, tools and events live here (novox/hq ADR 0039).",
|
"description": "keycloak — identity and access. Its admin API client, tools and events live here (novox/hq ADR 0039).",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
|
||||||
"build": "tsc client.ts oidc.ts index.ts provisioner/index.ts tools/index.ts --module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist",
|
|
||||||
"test": "npm run build && node --test --experimental-strip-types 'test/*.test.ts'"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@novox/mesh-sdk": "^0.1.1"
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^22.0.0",
|
"@types/node": "^22.0.0",
|
||||||
|
|||||||
@@ -1,73 +0,0 @@
|
|||||||
// keycloak's provisioner — the adapter that makes keycloak a provider of the mesh `oidc-client`
|
|
||||||
// interface. The reconcile loop, the contributions file and reading the mesh's minted secret are the
|
|
||||||
// sdk harness's; this writes only the per-service half: how Keycloak creates, checks and removes a
|
|
||||||
// consumer's client (novox/hq ADR 0039/0040/0048). What a client is, and which ones are the mesh's,
|
|
||||||
// is in ../oidc.ts.
|
|
||||||
//
|
|
||||||
// The `oidc-client` interface: a consumer logs people in through the realm this module serves, as
|
|
||||||
// the confidential client `as` with the secret the mesh minted, and is redirected back to the
|
|
||||||
// callback it contributed under the names the mesh composed for its endpoint. What it is served —
|
|
||||||
// the issuer and the endpoint paths under it — is in the manifest's `serves`, settled with the
|
|
||||||
// assignment's settings.
|
|
||||||
//
|
|
||||||
// **The realm is read out of the issuer**, the one value an assignment sets (settings reach both the
|
|
||||||
// served facts and this module's config.json): a realm set in one place and an issuer in another
|
|
||||||
// would let the consumer be told one realm while its client is made in another.
|
|
||||||
|
|
||||||
import { runProvisioner, type Provision } from "@novox/mesh-sdk/provisioner";
|
|
||||||
import { emit } from "@novox/mesh-sdk/events";
|
|
||||||
import { readFileSync } from "node:fs";
|
|
||||||
import { KeycloakClient } from "../client.js";
|
|
||||||
import { OidcClients, realmOf } from "../oidc.js";
|
|
||||||
|
|
||||||
/** The issuer this assignment serves, from the settings-merged config the mesh delivers. */
|
|
||||||
function issuer(): string {
|
|
||||||
const file = process.env.MESH_KEYCLOAK_CONFIG_FILE;
|
|
||||||
let cfg: Record<string, unknown> = {};
|
|
||||||
if (file) {
|
|
||||||
try {
|
|
||||||
cfg = JSON.parse(readFileSync(file, "utf8")) as Record<string, unknown>;
|
|
||||||
} catch {
|
|
||||||
// Absent or unreadable: fall through to the environment, and refuse below if that is empty too.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const said = typeof cfg.issuer === "string" ? cfg.issuer : process.env.MESH_KEYCLOAK_ISSUER;
|
|
||||||
if (!said) throw new Error("no issuer — the module's config.json carries none and MESH_KEYCLOAK_ISSUER is unset");
|
|
||||||
return said;
|
|
||||||
}
|
|
||||||
|
|
||||||
const clients = new OidcClients(KeycloakClient.fromEnv(), realmOf(issuer()));
|
|
||||||
|
|
||||||
/** Emit a lifecycle event without letting a broker hiccup fail the provisioning itself. */
|
|
||||||
async function announce(type: string, body: Record<string, string>): Promise<void> {
|
|
||||||
try {
|
|
||||||
await emit(type, body);
|
|
||||||
} catch (err) {
|
|
||||||
console.error(`[provisioner:oidc-client] emit ${type} failed: ${err}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
runProvisioner("oidc-client", {
|
|
||||||
async create(p: Provision): Promise<void> {
|
|
||||||
const done = await clients.ensure(p);
|
|
||||||
if (done === "created") {
|
|
||||||
console.log(`[provisioner:oidc-client] created client ${p.as} in realm ${clients.realm}`);
|
|
||||||
await announce("client.created", { realm: clients.realm, clientId: p.as, consumer: p.consumer ?? "" });
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
async remove(p: { as: string }): Promise<void> {
|
|
||||||
const done = await clients.remove(p.as);
|
|
||||||
if (done === "not ours") {
|
|
||||||
console.error(`[provisioner:oidc-client] ${p.as}: a client of that id exists that the mesh did not make — left alone`);
|
|
||||||
} else if (done === "removed") {
|
|
||||||
console.log(`[provisioner:oidc-client] removed client ${p.as} from realm ${clients.realm}`);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
// Asked every minute by the harness: whether Keycloak still holds this consumer's client exactly as
|
|
||||||
// the mesh gave it, so a client deleted or edited behind the mesh's back is made again (hq issue 120).
|
|
||||||
async holds(p: Provision): Promise<boolean> {
|
|
||||||
return clients.holds(p);
|
|
||||||
},
|
|
||||||
});
|
|
||||||
@@ -1,239 +0,0 @@
|
|||||||
// What holds keycloak to the `oidc-client` provision (oidc.ts): one confidential client per consumer,
|
|
||||||
// under the id and secret the mesh gave, redirecting only to the consumer's own callback under the
|
|
||||||
// names the mesh composed; made once and brought back on every apply; and a client the mesh did not
|
|
||||||
// make — same id or not — never adopted, changed or deleted.
|
|
||||||
//
|
|
||||||
// Keycloak is a fake: the admin routes the module touches, answering with the status codes and the
|
|
||||||
// shapes Keycloak gives. Run against the compiled module (npm test builds first), the way the runtime
|
|
||||||
// loads it.
|
|
||||||
|
|
||||||
import { test, after } from "node:test";
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { createServer, type IncomingMessage, type ServerResponse } from "node:http";
|
|
||||||
import { randomUUID } from "node:crypto";
|
|
||||||
|
|
||||||
import { KeycloakClient } from "../dist/client.js";
|
|
||||||
import { MARK, OidcClients, ROLES_MAPPER, realmOf, redirectsOf } from "../dist/oidc.js";
|
|
||||||
|
|
||||||
type Client = Record<string, any>;
|
|
||||||
|
|
||||||
/** The realm's clients, by internal id, and what the fake was asked. */
|
|
||||||
const realm = "Novox";
|
|
||||||
const clients = new Map<string, Client>();
|
|
||||||
const calls: string[] = [];
|
|
||||||
|
|
||||||
function body(req: IncomingMessage): Promise<any> {
|
|
||||||
return new Promise((resolve) => {
|
|
||||||
let raw = "";
|
|
||||||
req.on("data", (c) => (raw += c));
|
|
||||||
req.on("end", () => resolve(raw ? JSON.parse(raw) : undefined));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function send(res: ServerResponse, status: number, value?: unknown): void {
|
|
||||||
res.writeHead(status, { "Content-Type": "application/json" });
|
|
||||||
res.end(value === undefined ? "" : JSON.stringify(value));
|
|
||||||
}
|
|
||||||
|
|
||||||
const server = createServer(async (req, res) => {
|
|
||||||
const url = new URL(req.url!, "http://fake");
|
|
||||||
calls.push(`${req.method} ${url.pathname}`);
|
|
||||||
if (url.pathname === "/realms/master/protocol/openid-connect/token") {
|
|
||||||
return send(res, 200, { access_token: "t", expires_in: 300 });
|
|
||||||
}
|
|
||||||
const base = `/admin/realms/${realm}/clients`;
|
|
||||||
if (!url.pathname.startsWith(base)) return send(res, 404, { error: "Realm not found." });
|
|
||||||
const rest = url.pathname.slice(base.length).split("/").filter(Boolean);
|
|
||||||
if (rest.length === 0 && req.method === "GET") {
|
|
||||||
const want = url.searchParams.get("clientId");
|
|
||||||
return send(res, 200, [...clients.values()].filter((c) => !want || c.clientId === want));
|
|
||||||
}
|
|
||||||
if (rest.length === 0 && req.method === "POST") {
|
|
||||||
const rep = await body(req);
|
|
||||||
if ([...clients.values()].some((c) => c.clientId === rep.clientId)) {
|
|
||||||
return send(res, 409, { errorMessage: `Client ${rep.clientId} already exists` });
|
|
||||||
}
|
|
||||||
const id = randomUUID();
|
|
||||||
const mappers = (rep.protocolMappers ?? []).map((m: Client) => ({ ...m, id: randomUUID() }));
|
|
||||||
clients.set(id, { ...rep, id, protocolMappers: mappers });
|
|
||||||
return send(res, 201);
|
|
||||||
}
|
|
||||||
const c = clients.get(rest[0]);
|
|
||||||
if (!c) return send(res, 404, { error: "Could not find client" });
|
|
||||||
if (rest.length === 1 && req.method === "PUT") {
|
|
||||||
// Keycloak ignores protocolMappers on a client update: they have their own endpoints.
|
|
||||||
const rep = await body(req);
|
|
||||||
clients.set(c.id, { ...rep, id: c.id, protocolMappers: c.protocolMappers });
|
|
||||||
return send(res, 204);
|
|
||||||
}
|
|
||||||
if (rest.length === 1 && req.method === "DELETE") {
|
|
||||||
clients.delete(c.id);
|
|
||||||
return send(res, 204);
|
|
||||||
}
|
|
||||||
if (rest[1] === "client-secret" && req.method === "GET") {
|
|
||||||
return send(res, 200, { type: "secret", value: c.secret });
|
|
||||||
}
|
|
||||||
if (rest[1] === "protocol-mappers") {
|
|
||||||
if (req.method === "GET") return send(res, 200, c.protocolMappers ?? []);
|
|
||||||
if (req.method === "POST") {
|
|
||||||
c.protocolMappers = [...(c.protocolMappers ?? []), { ...(await body(req)), id: randomUUID() }];
|
|
||||||
return send(res, 201);
|
|
||||||
}
|
|
||||||
if (req.method === "PUT") {
|
|
||||||
const m = await body(req);
|
|
||||||
c.protocolMappers = c.protocolMappers.map((x: Client) => (x.id === rest[4] ? m : x));
|
|
||||||
return send(res, 204);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
send(res, 405);
|
|
||||||
});
|
|
||||||
await new Promise<void>((r) => server.listen(0, "127.0.0.1", r));
|
|
||||||
after(() => server.close());
|
|
||||||
const port = (server.address() as { port: number }).port;
|
|
||||||
|
|
||||||
const oidc = new OidcClients(new KeycloakClient(`http://127.0.0.1:${port}`, "admin", "pw"), realm);
|
|
||||||
|
|
||||||
/** Grafana on ace, as the mesh hands it to the provisioner. */
|
|
||||||
function grafana(secret = "s3cret", values: Record<string, unknown> = {}) {
|
|
||||||
return {
|
|
||||||
as: "mesh_ace_grafana",
|
|
||||||
password: secret,
|
|
||||||
consumer: "ace",
|
|
||||||
values: {
|
|
||||||
label: "grafana", endpoint: "web", port: 20010, callback: "/login/generic_oauth",
|
|
||||||
name: "grafana.zurag.be", "internal-name": "grafana.ace.internal", ...values,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function only(clientId: string): Client {
|
|
||||||
const found = [...clients.values()].filter((c) => c.clientId === clientId);
|
|
||||||
assert.equal(found.length, 1, `exactly one client ${clientId}, found ${found.length}`);
|
|
||||||
return found[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
test("the realm is read out of the issuer, and an issuer that names none is refused", () => {
|
|
||||||
assert.equal(realmOf("https://keycloak.novox.be/realms/Novox"), "Novox");
|
|
||||||
assert.equal(realmOf("https://keycloak.novox.be/realms/Novox/"), "Novox");
|
|
||||||
assert.equal(realmOf("http://127.0.0.1:18500/realms/master"), "master");
|
|
||||||
assert.throws(() => realmOf("https://keycloak.novox.be"), /realms/);
|
|
||||||
assert.throws(() => realmOf("keycloak"), /not a URL/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the redirect is the consumer's callback under every name the mesh composed for it", () => {
|
|
||||||
assert.deepEqual(redirectsOf(grafana().values), {
|
|
||||||
root: "https://grafana.zurag.be",
|
|
||||||
redirects: ["https://grafana.zurag.be/login/generic_oauth", "https://grafana.ace.internal/login/generic_oauth"],
|
|
||||||
});
|
|
||||||
// A route reaching only the private network has only the internal name, and that is enough.
|
|
||||||
assert.deepEqual(redirectsOf({ callback: "/cb", "internal-name": "x.ace.internal" }).redirects,
|
|
||||||
["https://x.ace.internal/cb"]);
|
|
||||||
assert.throws(() => redirectsOf({ name: "grafana.zurag.be" }), /callback/);
|
|
||||||
assert.throws(() => redirectsOf({ name: "grafana.zurag.be", callback: "login" }), /callback/);
|
|
||||||
assert.throws(() => redirectsOf({ callback: "/cb" }), /label/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a consumer is given one confidential client, under its id and the mesh's secret", async () => {
|
|
||||||
clients.clear();
|
|
||||||
assert.equal(await oidc.ensure(grafana()), "created");
|
|
||||||
const c = only("mesh_ace_grafana");
|
|
||||||
assert.equal(c.publicClient, false);
|
|
||||||
assert.equal(c.clientAuthenticatorType, "client-secret");
|
|
||||||
assert.equal(c.secret, "s3cret");
|
|
||||||
assert.equal(c.enabled, true);
|
|
||||||
assert.equal(c.standardFlowEnabled, true);
|
|
||||||
assert.equal(c.directAccessGrantsEnabled, false);
|
|
||||||
assert.equal(c.implicitFlowEnabled, false);
|
|
||||||
assert.deepEqual(c.redirectUris, [
|
|
||||||
"https://grafana.zurag.be/login/generic_oauth", "https://grafana.ace.internal/login/generic_oauth"]);
|
|
||||||
assert.equal(c.attributes[MARK], "true");
|
|
||||||
assert.deepEqual(c.protocolMappers.map((m: Client) => m.name), [ROLES_MAPPER.name]);
|
|
||||||
assert.equal(await oidc.holds(grafana()), true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("applying the same grant again makes no second client", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(await oidc.ensure(grafana()), "updated");
|
|
||||||
assert.equal(await oidc.ensure(grafana()), "updated");
|
|
||||||
only("mesh_ace_grafana");
|
|
||||||
assert.equal(only("mesh_ace_grafana").protocolMappers.length, 1, "the roles mapper is not added twice");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a new secret or a moved name is applied in place, and what the mesh does not own survives", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
const id = only("mesh_ace_grafana").id;
|
|
||||||
// Something the mesh does not own, set on the client after it was made.
|
|
||||||
clients.get(id)!.consentRequired = true;
|
|
||||||
clients.get(id)!.attributes["post.logout.redirect.uris"] = "+";
|
|
||||||
|
|
||||||
assert.equal(await oidc.holds(grafana("rotated")), false, "a rotated secret is not held until applied");
|
|
||||||
await oidc.ensure(grafana("rotated", { name: "dash.zurag.be" }));
|
|
||||||
const c = only("mesh_ace_grafana");
|
|
||||||
assert.equal(c.id, id, "updated, not replaced");
|
|
||||||
assert.equal(c.secret, "rotated");
|
|
||||||
assert.deepEqual(c.redirectUris, [
|
|
||||||
"https://dash.zurag.be/login/generic_oauth", "https://grafana.ace.internal/login/generic_oauth"]);
|
|
||||||
assert.equal(c.rootUrl, "https://dash.zurag.be");
|
|
||||||
assert.equal(c.consentRequired, true);
|
|
||||||
assert.equal(c.attributes["post.logout.redirect.uris"], "+");
|
|
||||||
assert.equal(c.attributes[MARK], "true");
|
|
||||||
assert.equal(await oidc.holds(grafana("rotated", { name: "dash.zurag.be" })), true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a client lost or edited behind the mesh's back is not held, and is made whole again", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
const c = only("mesh_ace_grafana");
|
|
||||||
c.redirectUris = ["*"];
|
|
||||||
assert.equal(await oidc.holds(grafana()), false, "a widened redirect is not what the mesh gave");
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(await oidc.holds(grafana()), true);
|
|
||||||
|
|
||||||
only("mesh_ace_grafana").protocolMappers = [];
|
|
||||||
assert.equal(await oidc.holds(grafana()), false, "a client without its roles mapper is not held");
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(await oidc.holds(grafana()), true);
|
|
||||||
|
|
||||||
clients.clear();
|
|
||||||
assert.equal(await oidc.holds(grafana()), false);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a client of the same id the mesh did not make is refused, and left exactly as it was", async () => {
|
|
||||||
clients.clear();
|
|
||||||
clients.set("theirs", { id: "theirs", clientId: "mesh_ace_grafana", secret: "their-secret", redirectUris: ["*"] });
|
|
||||||
const before = JSON.stringify(clients.get("theirs"));
|
|
||||||
const writes = calls.length;
|
|
||||||
await assert.rejects(oidc.ensure(grafana()), /did not make/);
|
|
||||||
assert.equal(JSON.stringify(clients.get("theirs")), before);
|
|
||||||
assert.ok(calls.slice(writes).every((c) => c.startsWith("GET") || c.startsWith("POST /realms/master")),
|
|
||||||
`only reads were made: ${calls.slice(writes).join(", ")}`);
|
|
||||||
assert.equal(await oidc.holds(grafana()), false);
|
|
||||||
assert.equal(await oidc.remove("mesh_ace_grafana"), "not ours");
|
|
||||||
assert.ok(clients.has("theirs"), "a client the mesh did not make is never deleted");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the predecessor's hand-made client is never touched: the mesh's has its own id", async () => {
|
|
||||||
clients.clear();
|
|
||||||
clients.set("hal", { id: "hal", clientId: "grafana", secret: "old", redirectUris: ["https://grafana.zurag.be/*"] });
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(clients.get("hal")!.secret, "old");
|
|
||||||
only("mesh_ace_grafana");
|
|
||||||
assert.equal(await oidc.remove("grafana"), "not ours");
|
|
||||||
assert.ok(clients.has("hal"));
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a withdrawn consumer's client is removed, and an absent one is not an error", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(await oidc.remove("mesh_ace_grafana"), "removed");
|
|
||||||
assert.equal([...clients.values()].length, 0);
|
|
||||||
assert.equal(await oidc.remove("mesh_ace_grafana"), "absent");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a contribution with no callback makes no client at all", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await assert.rejects(oidc.ensure({ ...grafana(), values: { name: "grafana.zurag.be" } }), /callback/);
|
|
||||||
assert.equal(clients.size, 0);
|
|
||||||
});
|
|
||||||
@@ -8,5 +8,5 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["client.ts", "oidc.ts", "index.ts", "provisioner/index.ts", "tools/index.ts"]
|
"include": ["client.ts", "index.ts", "tools/index.ts"]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,19 @@
|
|||||||
{
|
{
|
||||||
"module": "lidarr",
|
"module": "lidarr",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
|
"provides": [
|
||||||
|
{
|
||||||
|
"name": "lidarr-api",
|
||||||
|
"scope": "mesh"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"serves": {
|
||||||
|
"lidarr-api": {
|
||||||
|
"scheme": "http",
|
||||||
|
"port": 8686,
|
||||||
|
"url-base": ""
|
||||||
|
}
|
||||||
|
},
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
@@ -75,7 +88,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_LIDARR_URL": "http://127.0.0.1:8686",
|
"MESH_LIDARR_URL": "http://127.0.0.1:${port:8686}",
|
||||||
"MESH_LIDARR_CONFIG_DIR": "/var/lib/lidarr/config"
|
"MESH_LIDARR_CONFIG_DIR": "/var/lib/lidarr/config"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
|||||||
@@ -81,7 +81,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_NZBGET_URL": "http://127.0.0.1:6789",
|
"MESH_NZBGET_URL": "http://127.0.0.1:${port:6789}",
|
||||||
"MESH_NZBGET_PASSWORD_FILE": "/run/secrets/password",
|
"MESH_NZBGET_PASSWORD_FILE": "/run/secrets/password",
|
||||||
"MESH_NZBGET_CONFIG_FILE": "/run/config/config.json",
|
"MESH_NZBGET_CONFIG_FILE": "/run/config/config.json",
|
||||||
"MESH_NZBGET_CONFIG_DIR": "/var/lib/nzbget/config"
|
"MESH_NZBGET_CONFIG_DIR": "/var/lib/nzbget/config"
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ ARG RUNTIME_BASE
|
|||||||
FROM ${BUILD_BASE} AS build
|
FROM ${BUILD_BASE} AS build
|
||||||
WORKDIR /app/modules/ombi
|
WORKDIR /app/modules/ombi
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts \
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts servarr/settings.ts servarr/index.ts \
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
FROM ${RUNTIME_BASE}
|
||||||
@@ -22,3 +22,6 @@ COPY --from=build /app/modules/ombi/dist /app/modules/ombi/dist
|
|||||||
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
# the convention novox/hq issues 060/061 settled.
|
# the convention novox/hq issues 060/061 settled.
|
||||||
ENV MESH_TOOL_MODULES=/app/modules/ombi/dist/index.js,/app/modules/ombi/dist/tools/index.js
|
ENV MESH_TOOL_MODULES=/app/modules/ombi/dist/index.js,/app/modules/ombi/dist/tools/index.js
|
||||||
|
# NOT dist/servarr/index.js: that is a step the host runs to completion, named by the `servarr`
|
||||||
|
# container's args as `mesh-tools run …` (novox/hq ADR 0052). Listed here it would run inside the
|
||||||
|
# serving sidecar too, and exit it.
|
||||||
|
|||||||
+58
-10
@@ -28,10 +28,15 @@
|
|||||||
"path": "/var/lib/mesh/ombi",
|
"path": "/var/lib/mesh/ombi",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"id": "state",
|
||||||
|
"type": "directory",
|
||||||
|
"mode": "0700",
|
||||||
|
"place": "."
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"path": "/services/ombi/config",
|
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "1000:1000"
|
"owner": "1000:1000"
|
||||||
},
|
},
|
||||||
@@ -39,7 +44,7 @@
|
|||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "ombi",
|
"name": "ombi",
|
||||||
"image": "lscr.io/linuxserver/ombi@sha256:a6f76ac521ba01eee2e9f0c23a3fed22e56630d97a04d5eeaeaa36c1e681640d",
|
"image": "lscr.io/linuxserver/ombi@sha256:22d6ebadbaaa728571353e74dc2173719e0fb02d4eaec551a7e9d2ee99ef68ac",
|
||||||
"env": {
|
"env": {
|
||||||
"PUID": "1000",
|
"PUID": "1000",
|
||||||
"PGID": "1000",
|
"PGID": "1000",
|
||||||
@@ -49,7 +54,7 @@
|
|||||||
"3579"
|
"3579"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"/services/ombi/config:/config"
|
"${dir:config}:/config"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -68,24 +73,59 @@
|
|||||||
"volumes": [
|
"volumes": [
|
||||||
"/var/lib/mesh/ombi/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/ombi/broker:/run/secrets/broker:ro",
|
||||||
"/var/lib/mesh/ombi/api-key:/run/secrets/api-key:ro",
|
"/var/lib/mesh/ombi/api-key:/run/secrets/api-key:ro",
|
||||||
"/var/lib/mesh/ombi/config.json:/run/config/config.json:ro",
|
"/var/lib/mesh/ombi/config.json:/run/config/config.json:ro"
|
||||||
"/services/ombi/config:/var/lib/ombi/config:ro"
|
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_OMBI_URL": "http://127.0.0.1:3579",
|
"MESH_OMBI_URL": "http://127.0.0.1:${port:3579}",
|
||||||
"MESH_OMBI_API_KEY_FILE": "/run/secrets/api-key",
|
"MESH_OMBI_API_KEY_FILE": "/run/secrets/api-key",
|
||||||
"MESH_OMBI_CONFIG_FILE": "/run/config/config.json",
|
"MESH_OMBI_CONFIG_FILE": "/run/config/config.json"
|
||||||
"MESH_OMBI_CONFIG_DIR": "/var/lib/ombi/config"
|
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
"runtime-config"
|
"runtime-config"
|
||||||
],
|
],
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "servarr",
|
||||||
|
"type": "container",
|
||||||
|
"name": "mesh-ombi-servarr",
|
||||||
|
"network": "host",
|
||||||
|
"run-once": true,
|
||||||
|
"volumes": [
|
||||||
|
"/var/lib/mesh/ombi/api-key:/run/secrets/api-key:ro",
|
||||||
|
"${dir:state}/sonarr-api.json:/run/servarr/sonarr-api.json:ro",
|
||||||
|
"${dir:state}/sonarr-api.secret:/run/servarr/sonarr-api.secret:ro",
|
||||||
|
"${dir:state}/radarr-api.json:/run/servarr/radarr-api.json:ro",
|
||||||
|
"${dir:state}/radarr-api.secret:/run/servarr/radarr-api.secret:ro",
|
||||||
|
"${dir:state}/lidarr-api.json:/run/servarr/lidarr-api.json:ro",
|
||||||
|
"${dir:state}/lidarr-api.secret:/run/servarr/lidarr-api.secret:ro"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"MESH_OMBI_URL": "http://127.0.0.1:${port:3579}",
|
||||||
|
"MESH_OMBI_API_KEY_FILE": "/run/secrets/api-key",
|
||||||
|
"MESH_SERVARR_DIR": "/run/servarr"
|
||||||
|
},
|
||||||
|
"args": [
|
||||||
|
"run",
|
||||||
|
"/app/modules/ombi/dist/servarr/index.js"
|
||||||
|
],
|
||||||
|
"restart-on": [
|
||||||
|
"bound-sonarr-api",
|
||||||
|
"secret-sonarr-api",
|
||||||
|
"bound-radarr-api",
|
||||||
|
"secret-radarr-api",
|
||||||
|
"bound-lidarr-api",
|
||||||
|
"secret-lidarr-api"
|
||||||
|
],
|
||||||
|
"artifact": "runtime"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requires": [
|
"requires": [
|
||||||
"route"
|
"lidarr-api",
|
||||||
|
"radarr-api",
|
||||||
|
"route",
|
||||||
|
"sonarr-api"
|
||||||
],
|
],
|
||||||
"contributes": {
|
"contributes": {
|
||||||
"route": {
|
"route": {
|
||||||
@@ -94,7 +134,15 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"route": "/var/lib/mesh/ombi/route.json"
|
"route": "${dir:state}/route.json",
|
||||||
|
"sonarr-api": "${dir:state}/sonarr-api.json",
|
||||||
|
"radarr-api": "${dir:state}/radarr-api.json",
|
||||||
|
"lidarr-api": "${dir:state}/lidarr-api.json"
|
||||||
|
},
|
||||||
|
"secrets": {
|
||||||
|
"sonarr-api": "${dir:state}/sonarr-api.secret",
|
||||||
|
"radarr-api": "${dir:state}/radarr-api.secret",
|
||||||
|
"lidarr-api": "${dir:state}/lidarr-api.secret"
|
||||||
},
|
},
|
||||||
"build": {
|
"build": {
|
||||||
"on": [
|
"on": [
|
||||||
|
|||||||
@@ -4,6 +4,11 @@
|
|||||||
"description": "ombi — media requests. Its API client, tools and events live here (novox/hq ADR 0039).",
|
"description": "ombi — media requests. Its API client, tools and events live here (novox/hq ADR 0039).",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"scripts": {
|
||||||
|
"build": "tsc client.ts index.ts tools/index.ts servarr/settings.ts servarr/index.ts --module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist",
|
||||||
|
"typecheck": "tsc -p tsconfig.json",
|
||||||
|
"test": "node --test --experimental-strip-types 'test/*.test.ts'"
|
||||||
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@novox/mesh-sdk": "^0.1.0"
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -0,0 +1,59 @@
|
|||||||
|
// ombi's Servarr step — run once by the host after ombi's server starts, and run again whenever a
|
||||||
|
// binding or pair credential it reads changes (the container's `restart-on`, novox/hq ADR 0099).
|
||||||
|
//
|
||||||
|
// **A step, not a loop**, for the reason route-adapter gives: everything it does is a function of
|
||||||
|
// files the mesh writes, and the host already knows when they change. It connects to no broker.
|
||||||
|
//
|
||||||
|
// Exits non-zero when any app could not be put right — a refused credential, an unreachable app, an
|
||||||
|
// ombi that cannot reach it — so the node reports the step failed and the host runs it again on the
|
||||||
|
// next apply. It is declared last in the manifest, so its failing gates nothing else of ombi's
|
||||||
|
// (novox/hq ADR 0136).
|
||||||
|
//
|
||||||
|
// Reads, per app, `<dir>/<provision>.json` (the binding) and `<dir>/<provision>.secret` (the pair
|
||||||
|
// credential), where <dir> is MESH_SERVARR_DIR. Never prints a key.
|
||||||
|
|
||||||
|
import { join } from "node:path";
|
||||||
|
|
||||||
|
import { APPS, ombiReady, readBinding, readIfThere, reconcileApp, type Http } from "./settings.js";
|
||||||
|
|
||||||
|
const dir = process.env.MESH_SERVARR_DIR ?? "/run/servarr";
|
||||||
|
const url = process.env.MESH_OMBI_URL ?? "http://127.0.0.1:3579";
|
||||||
|
const apiKey = (await readIfThere(process.env.MESH_OMBI_API_KEY_FILE))?.trim() ?? process.env.MESH_OMBI_API_KEY ?? "";
|
||||||
|
const waitSeconds = Number(process.env.MESH_OMBI_WAIT_SECONDS ?? "180");
|
||||||
|
|
||||||
|
const http: Http = { fetch: (u, init) => fetch(u, init) };
|
||||||
|
|
||||||
|
if (!apiKey) {
|
||||||
|
console.error("[ombi-servarr] no ombi API key — ombi's own `api-key` secret has not been accepted");
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
const ombi = { url, apiKey };
|
||||||
|
|
||||||
|
if (!(await ombiReady(http, ombi, waitSeconds * 1000))) {
|
||||||
|
console.error(`[ombi-servarr] ombi did not answer at ${url} within ${waitSeconds}s`);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
let failed = 0;
|
||||||
|
for (const spec of APPS) {
|
||||||
|
const outcome = await reconcileApp(
|
||||||
|
http,
|
||||||
|
ombi,
|
||||||
|
spec,
|
||||||
|
await readBinding(join(dir, `${spec.provision}.json`)),
|
||||||
|
await readIfThere(join(dir, `${spec.provision}.secret`)),
|
||||||
|
);
|
||||||
|
switch (outcome.result) {
|
||||||
|
case "unchanged":
|
||||||
|
console.log(`[ombi-servarr] ${outcome.app}: already as the mesh says; connection tested`);
|
||||||
|
break;
|
||||||
|
case "written":
|
||||||
|
console.log(`[ombi-servarr] ${outcome.app}: wrote ${outcome.fields.join(", ")}; connection tested`);
|
||||||
|
break;
|
||||||
|
case "refused":
|
||||||
|
failed++;
|
||||||
|
console.error(`[ombi-servarr] ${outcome.app}: ${outcome.problem}`);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
process.exitCode = failed > 0 ? 1 : 0;
|
||||||
@@ -0,0 +1,304 @@
|
|||||||
|
// Where ombi reaches Sonarr, Radarr and Lidarr — decided by the mesh, written into ombi by ombi's
|
||||||
|
// own API.
|
||||||
|
//
|
||||||
|
// **Why this exists.** ombi keeps its connection to each Servarr app in its own database
|
||||||
|
// (OmbiSettings.db), not in a file, so the mesh has nowhere to write `${bound:sonarr-api:at}` for it.
|
||||||
|
// ombi requires `sonarr-api`, `radarr-api` and `lidarr-api`; the mesh delivers, for each, a binding
|
||||||
|
// (where the app is: `at`, and what it serves: `port`, `scheme`, `url-base`) and a pair credential
|
||||||
|
// (the app's API key, accepted by the operator — a Servarr app has exactly one key and the mesh
|
||||||
|
// cannot mint it). This step reads those files and makes ombi's settings say the same thing.
|
||||||
|
//
|
||||||
|
// **Only the connection, and only when it differs.** Host, port, TLS, base path and API key. The
|
||||||
|
// quality profile, root folder, language profile, tags, "enabled" and every other choice an operator
|
||||||
|
// made in ombi's settings screen are left exactly as they are: the mesh knows where the app is, not
|
||||||
|
// what ombi should do with it. Radarr's 4K instance is a different Radarr and is not touched.
|
||||||
|
//
|
||||||
|
// **A credential the app refuses is never written.** Until the operator accepts the app's API key
|
||||||
|
// for this pair, the mesh delivers a value it minted itself, which no Servarr app will ever accept
|
||||||
|
// (novox/hq ADR 0092). Writing it would replace a working key in ombi with a dead one. So the key is
|
||||||
|
// tried against the app first; refused, nothing for that app is written and the step fails naming
|
||||||
|
// the `secret accept` that fixes it.
|
||||||
|
//
|
||||||
|
// Pure logic and a small HTTP seam, so it is tested against fake servers (test/servarr.test.ts).
|
||||||
|
|
||||||
|
import { readFile } from "node:fs/promises";
|
||||||
|
|
||||||
|
/** One Servarr app ombi connects to, and the shape of that connection in ombi's API. */
|
||||||
|
export interface ServarrApp {
|
||||||
|
/** The app, as ombi's API names it: /Settings/<app>, /Tester/<app>. */
|
||||||
|
app: "sonarr" | "radarr" | "lidarr";
|
||||||
|
/** The provision it is required as — the manifest's `requires`, `binds` and `secrets` key. */
|
||||||
|
provision: string;
|
||||||
|
/** The app's own status endpoint, which answers 401 to a wrong key. */
|
||||||
|
statusPath: string;
|
||||||
|
/**
|
||||||
|
* Where the one connection sits in ombi's settings document. Radarr's is `{radarr, radarr4K}`
|
||||||
|
* (two Radarr instances); only `radarr` is this provision's.
|
||||||
|
*/
|
||||||
|
within?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const APPS: readonly ServarrApp[] = [
|
||||||
|
{ app: "sonarr", provision: "sonarr-api", statusPath: "/api/v3/system/status" },
|
||||||
|
{ app: "radarr", provision: "radarr-api", statusPath: "/api/v3/system/status", within: "radarr" },
|
||||||
|
{ app: "lidarr", provision: "lidarr-api", statusPath: "/api/v1/system/status" },
|
||||||
|
];
|
||||||
|
|
||||||
|
/** The connection fields ombi keeps for an app — the only ones this step ever writes. */
|
||||||
|
export interface Connection {
|
||||||
|
ip: string;
|
||||||
|
port: number;
|
||||||
|
ssl: boolean;
|
||||||
|
/** ombi's name for the app's URL base; null when the app is served at the root. */
|
||||||
|
subDir: string | null;
|
||||||
|
apiKey: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** What the mesh wrote at `binds.<provision>`: the binding document (controller's boundFile). */
|
||||||
|
export interface Binding {
|
||||||
|
provision?: string;
|
||||||
|
from?: string;
|
||||||
|
at?: string;
|
||||||
|
as?: string;
|
||||||
|
serves?: Record<string, unknown>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Wanted = { ok: true; connection: Connection; from: string } | { ok: false; problem: string };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The connection the mesh says ombi should use, from the binding and the pair credential.
|
||||||
|
*
|
||||||
|
* Refused rather than guessed when the binding cannot be dialled from ombi's own container: a
|
||||||
|
* loopback `at` — what the mesh hands a machine that is not on the private network — is ombi's
|
||||||
|
* container itself, not the app.
|
||||||
|
*/
|
||||||
|
export function wanted(spec: ServarrApp, binding: Binding | undefined, credential: string | undefined): Wanted {
|
||||||
|
if (!binding) {
|
||||||
|
return { ok: false, problem: `no binding for ${spec.provision} was delivered — the mesh writes it before this step runs` };
|
||||||
|
}
|
||||||
|
const at = typeof binding.at === "string" ? binding.at.trim() : "";
|
||||||
|
const serves = binding.serves ?? {};
|
||||||
|
const port = Number(serves.port);
|
||||||
|
if (!at) {
|
||||||
|
return { ok: false, problem: `the ${spec.provision} binding names no host (at)` };
|
||||||
|
}
|
||||||
|
if (isLoopback(at)) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
problem:
|
||||||
|
`the ${spec.provision} binding says ${spec.app} is at ${at}, which from ombi's own container is ` +
|
||||||
|
`ombi itself. The mesh hands loopback to a machine that is not on the private network; put it ` +
|
||||||
|
`on the private network so ${spec.app} has an address ombi can dial`,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (!Number.isInteger(port) || port <= 0 || port > 65535) {
|
||||||
|
return { ok: false, problem: `the ${spec.provision} binding serves no usable port (${String(serves.port)})` };
|
||||||
|
}
|
||||||
|
const scheme = typeof serves.scheme === "string" && serves.scheme ? serves.scheme : "http";
|
||||||
|
if (scheme !== "http" && scheme !== "https") {
|
||||||
|
return { ok: false, problem: `the ${spec.provision} binding serves scheme ${scheme}, which ombi cannot dial` };
|
||||||
|
}
|
||||||
|
const key = (credential ?? "").trim();
|
||||||
|
if (!key) {
|
||||||
|
return { ok: false, problem: `the ${spec.provision} credential is empty or was not delivered` };
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
from: typeof binding.from === "string" ? binding.from : "",
|
||||||
|
connection: { ip: at, port, ssl: scheme === "https", subDir: subDirOf(serves["url-base"]), apiKey: key },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/** ombi's `subDir`: the URL base with its slashes trimmed, null when there is none. */
|
||||||
|
export function subDirOf(urlBase: unknown): string | null {
|
||||||
|
const trimmed = typeof urlBase === "string" ? urlBase.trim().replace(/^\/+|\/+$/g, "") : "";
|
||||||
|
return trimmed === "" ? null : trimmed;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isLoopback(host: string): boolean {
|
||||||
|
const h = host.toLowerCase();
|
||||||
|
return h === "localhost" || h === "::1" || h === "[::1]" || /^127\./.test(h);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Which connection fields differ between what ombi holds and what the mesh says. Names only. */
|
||||||
|
export function differing(current: Record<string, unknown> | undefined, want: Connection): (keyof Connection)[] {
|
||||||
|
const now = current ?? {};
|
||||||
|
const out: (keyof Connection)[] = [];
|
||||||
|
if (String(now.ip ?? "") !== want.ip) out.push("ip");
|
||||||
|
if (Number(now.port ?? 0) !== want.port) out.push("port");
|
||||||
|
if (Boolean(now.ssl) !== want.ssl) out.push("ssl");
|
||||||
|
if (subDirOf(now.subDir) !== want.subDir) out.push("subDir");
|
||||||
|
if (String(now.apiKey ?? "") !== want.apiKey) out.push("apiKey");
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** ombi's settings for the app with the connection laid over them and nothing else changed. */
|
||||||
|
export function withConnection(current: Record<string, unknown> | undefined, want: Connection): Record<string, unknown> {
|
||||||
|
return { ...(current ?? {}), ip: want.ip, port: want.port, ssl: want.ssl, subDir: want.subDir, apiKey: want.apiKey };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The app's base URL as the step dials it — the same host and port ombi will be given. */
|
||||||
|
export function appUrl(want: Connection): string {
|
||||||
|
const scheme = want.ssl ? "https" : "http";
|
||||||
|
const host = want.ip.includes(":") && !want.ip.startsWith("[") ? `[${want.ip}]` : want.ip;
|
||||||
|
return `${scheme}://${host}:${want.port}${want.subDir ? `/${want.subDir}` : ""}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** How one app came out. */
|
||||||
|
export type Outcome =
|
||||||
|
| { app: string; result: "unchanged" }
|
||||||
|
| { app: string; result: "written"; fields: string[] }
|
||||||
|
| { app: string; result: "refused"; problem: string };
|
||||||
|
|
||||||
|
/** The HTTP the step needs, so a test can stand fakes in for ombi and the apps. */
|
||||||
|
export interface Http {
|
||||||
|
fetch(url: string, init?: { method?: string; headers?: Record<string, string>; body?: string }): Promise<{
|
||||||
|
status: number;
|
||||||
|
text(): Promise<string>;
|
||||||
|
}>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Ombi {
|
||||||
|
url: string;
|
||||||
|
apiKey: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function ombiCall(http: Http, ombi: Ombi, method: string, path: string, body?: unknown): Promise<unknown> {
|
||||||
|
const res = await http.fetch(`${ombi.url.replace(/\/$/, "")}/api/v1${path}`, {
|
||||||
|
method,
|
||||||
|
headers: {
|
||||||
|
ApiKey: ombi.apiKey,
|
||||||
|
Accept: "application/json",
|
||||||
|
...(body !== undefined ? { "Content-Type": "application/json" } : {}),
|
||||||
|
},
|
||||||
|
body: body !== undefined ? JSON.stringify(body) : undefined,
|
||||||
|
});
|
||||||
|
const text = await res.text();
|
||||||
|
if (res.status < 200 || res.status >= 300) {
|
||||||
|
// The body is ombi's error, never a request echo, so it carries no key.
|
||||||
|
throw new Error(`ombi ${method} ${path} answered ${res.status}${text ? `: ${text.slice(0, 200)}` : ""}`);
|
||||||
|
}
|
||||||
|
return text ? (JSON.parse(text) as unknown) : undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Does the app take this key? `true` it does, `false` it refused it (401/403), and a thrown error
|
||||||
|
* when it could not be asked — unreachable, or answering something that is neither.
|
||||||
|
*/
|
||||||
|
export async function appTakes(http: Http, spec: ServarrApp, want: Connection): Promise<boolean> {
|
||||||
|
const res = await http.fetch(`${appUrl(want)}${spec.statusPath}`, {
|
||||||
|
method: "GET",
|
||||||
|
headers: { "X-Api-Key": want.apiKey, Accept: "application/json" },
|
||||||
|
});
|
||||||
|
if (res.status === 401 || res.status === 403) return false;
|
||||||
|
if (res.status >= 200 && res.status < 300) return true;
|
||||||
|
throw new Error(`${spec.app} answered ${res.status} at ${spec.statusPath}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The remedy for a refused key, in the controller's own words (ADR 0092). */
|
||||||
|
export function acceptRemedy(spec: ServarrApp, from: string): string {
|
||||||
|
return (
|
||||||
|
`${spec.app} refuses the ${spec.provision} credential the mesh delivered, so it was not written ` +
|
||||||
|
`into ombi. A Servarr app has one API key and the mesh cannot make it: accept ${spec.app}'s own ` +
|
||||||
|
`key for this pair — \`secret accept <this node> ombi ${spec.provision} --provider ${from || "<its node>"} ` +
|
||||||
|
`--from <file holding ${spec.app}'s ApiKey>\``
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Bring ombi's connection to one app in line with the mesh: check the key against the app, compare,
|
||||||
|
* write only the connection fields when they differ, then have ombi test the connection from its own
|
||||||
|
* container. Never throws: every failure is an outcome with a reason.
|
||||||
|
*/
|
||||||
|
export async function reconcileApp(
|
||||||
|
http: Http,
|
||||||
|
ombi: Ombi,
|
||||||
|
spec: ServarrApp,
|
||||||
|
binding: Binding | undefined,
|
||||||
|
credential: string | undefined,
|
||||||
|
): Promise<Outcome> {
|
||||||
|
const w = wanted(spec, binding, credential);
|
||||||
|
// `in`, not `!w.ok`: the Dockerfile compiles without strict, where a boolean discriminant does not
|
||||||
|
// narrow.
|
||||||
|
if ("problem" in w) return { app: spec.app, result: "refused", problem: w.problem };
|
||||||
|
const want = w.connection;
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (!(await appTakes(http, spec, want))) {
|
||||||
|
return { app: spec.app, result: "refused", problem: acceptRemedy(spec, w.from) };
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
return {
|
||||||
|
app: spec.app,
|
||||||
|
result: "refused",
|
||||||
|
problem: `${spec.app} could not be asked whether it takes the key at ${want.ip}:${want.port}: ${message(err)}`,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const document = (await ombiCall(http, ombi, "GET", `/Settings/${spec.app}`)) as Record<string, unknown> | undefined;
|
||||||
|
const current = spec.within ? (document?.[spec.within] as Record<string, unknown> | undefined) : document;
|
||||||
|
const fields = differing(current, want);
|
||||||
|
if (fields.length > 0) {
|
||||||
|
const next = withConnection(current, want);
|
||||||
|
const body = spec.within ? { ...(document ?? {}), [spec.within]: next } : next;
|
||||||
|
const saved = await ombiCall(http, ombi, "POST", `/Settings/${spec.app}`, body);
|
||||||
|
if (saved === false) {
|
||||||
|
return { app: spec.app, result: "refused", problem: `ombi declined to save its ${spec.app} settings` };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// ombi's own test, from ombi's own container — the path the step's check above did not take.
|
||||||
|
const tested = (await ombiCall(http, ombi, "POST", `/Tester/${spec.app}`, withConnection(current, want))) as
|
||||||
|
| { isValid?: boolean; expectedSubDir?: string | null }
|
||||||
|
| undefined;
|
||||||
|
if (!tested?.isValid) {
|
||||||
|
const hint = tested?.expectedSubDir ? ` (ombi expected the base path ${tested.expectedSubDir})` : "";
|
||||||
|
return {
|
||||||
|
app: spec.app,
|
||||||
|
result: "refused",
|
||||||
|
problem:
|
||||||
|
`ombi cannot reach ${spec.app} at ${want.ip}:${want.port} from its own container${hint}` +
|
||||||
|
(fields.length > 0 ? `; its settings were written (${fields.join(", ")})` : ""),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return fields.length > 0 ? { app: spec.app, result: "written", fields } : { app: spec.app, result: "unchanged" };
|
||||||
|
} catch (err) {
|
||||||
|
return { app: spec.app, result: "refused", problem: message(err) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Wait for ombi to answer, because the step runs right after its container starts. */
|
||||||
|
export async function ombiReady(http: Http, ombi: Ombi, waitMs: number, pauseMs = 2000): Promise<boolean> {
|
||||||
|
const until = Date.now() + waitMs;
|
||||||
|
for (;;) {
|
||||||
|
try {
|
||||||
|
const res = await http.fetch(`${ombi.url.replace(/\/$/, "")}/api/v1/Status`, { method: "GET" });
|
||||||
|
if (res.status === 200) return true;
|
||||||
|
} catch {
|
||||||
|
// not listening yet
|
||||||
|
}
|
||||||
|
if (Date.now() >= until) return false;
|
||||||
|
await new Promise((r) => setTimeout(r, pauseMs));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A file the mesh wrote, or undefined when it is not there. */
|
||||||
|
export async function readIfThere(path: string | undefined): Promise<string | undefined> {
|
||||||
|
if (!path) return undefined;
|
||||||
|
return readFile(path, "utf8").catch(() => undefined);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A binding file parsed, or undefined when absent or not JSON. */
|
||||||
|
export async function readBinding(path: string | undefined): Promise<Binding | undefined> {
|
||||||
|
const raw = await readIfThere(path);
|
||||||
|
if (raw === undefined) return undefined;
|
||||||
|
try {
|
||||||
|
return JSON.parse(raw) as Binding;
|
||||||
|
} catch {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function message(err: unknown): string {
|
||||||
|
return err instanceof Error ? err.message : String(err);
|
||||||
|
}
|
||||||
@@ -0,0 +1,147 @@
|
|||||||
|
// What holds ombi's Servarr step (servarr/settings.ts): the connection ombi keeps for each app is
|
||||||
|
// made to say what the mesh bound — host, port, TLS, base path, key — and nothing else it keeps is
|
||||||
|
// touched; nothing is written when nothing differs; Radarr's 4K instance is left alone; and a key the
|
||||||
|
// app refuses (the mesh's own minted value, before the operator accepts the app's key) is never
|
||||||
|
// written, with the `secret accept` that fixes it named.
|
||||||
|
//
|
||||||
|
// ombi and the apps are fakes: the routes the step touches, answering as the real ones do (checked
|
||||||
|
// against lscr.io/linuxserver/ombi 4.53.10 and the catalogue's pinned sonarr/radarr/lidarr).
|
||||||
|
|
||||||
|
import { test } from "node:test";
|
||||||
|
import assert from "node:assert/strict";
|
||||||
|
|
||||||
|
import { APPS, differing, reconcileApp, subDirOf, wanted, type Binding, type Http, type ServarrApp } from "../servarr/settings.ts";
|
||||||
|
|
||||||
|
const SONARR = APPS.find((a) => a.app === "sonarr") as ServarrApp;
|
||||||
|
const RADARR = APPS.find((a) => a.app === "radarr") as ServarrApp;
|
||||||
|
const LIDARR = APPS.find((a) => a.app === "lidarr") as ServarrApp;
|
||||||
|
const THE_KEY = "the-apps-own-key";
|
||||||
|
|
||||||
|
function binding(provision: string, port: number, at = "ace.internal"): Binding {
|
||||||
|
return { binding: 1, provision, from: "ace", at, as: "mesh_ace_ombi", serves: { scheme: "http", port, "url-base": "" } } as Binding;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Call {
|
||||||
|
method: string;
|
||||||
|
url: string;
|
||||||
|
body?: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** ombi's settings store and the apps' key check, behind one fetch. */
|
||||||
|
function fakes(settings: Record<string, unknown>, opts: { appKey?: string; reachable?: boolean } = {}) {
|
||||||
|
const calls: Call[] = [];
|
||||||
|
const appKey = opts.appKey ?? THE_KEY;
|
||||||
|
const http: Http = {
|
||||||
|
async fetch(url, init) {
|
||||||
|
const method = init?.method ?? "GET";
|
||||||
|
const body = init?.body ? (JSON.parse(init.body) as unknown) : undefined;
|
||||||
|
calls.push({ method, url, body });
|
||||||
|
const reply = (status: number, value?: unknown) => ({
|
||||||
|
status,
|
||||||
|
text: async () => (value === undefined ? "" : JSON.stringify(value)),
|
||||||
|
});
|
||||||
|
const u = new URL(url);
|
||||||
|
if (u.pathname.endsWith("/system/status")) {
|
||||||
|
if (opts.reachable === false) throw new Error("connect ECONNREFUSED");
|
||||||
|
return init?.headers?.["X-Api-Key"] === appKey ? reply(200, { version: "4" }) : reply(401);
|
||||||
|
}
|
||||||
|
if (init?.headers?.ApiKey !== "ombi-key") return reply(401);
|
||||||
|
const m = u.pathname.match(/^\/api\/v1\/(Settings|Tester)\/(\w+)$/);
|
||||||
|
if (!m) return reply(404);
|
||||||
|
const [, kind, app] = m;
|
||||||
|
if (kind === "Settings" && method === "GET") return reply(200, settings[app]);
|
||||||
|
if (kind === "Settings" && method === "POST") {
|
||||||
|
settings[app] = body;
|
||||||
|
return reply(200, true);
|
||||||
|
}
|
||||||
|
const tried = body as { apiKey?: string };
|
||||||
|
return reply(200, { isValid: tried.apiKey === appKey, expectedSubDir: null });
|
||||||
|
},
|
||||||
|
};
|
||||||
|
return { http, calls, settings };
|
||||||
|
}
|
||||||
|
|
||||||
|
const OMBI = { url: "http://127.0.0.1:3579", apiKey: "ombi-key" };
|
||||||
|
|
||||||
|
const operatorSonarr = () => ({
|
||||||
|
enabled: true, apiKey: "old-key", qualityProfile: "3", seasonFolders: true, rootPath: "10",
|
||||||
|
qualityProfileAnime: "7", rootPathAnime: "9", languageProfile: 1, ssl: false, subDir: null,
|
||||||
|
ip: "sonarr", port: 8989, id: 5,
|
||||||
|
});
|
||||||
|
|
||||||
|
test("it writes the connection the mesh bound, and keeps every other setting ombi had", async () => {
|
||||||
|
const f = fakes({ sonarr: operatorSonarr() });
|
||||||
|
const out = await reconcileApp(f.http, OMBI, SONARR, binding("sonarr-api", 20101), `${THE_KEY}\n`);
|
||||||
|
assert.deepEqual(out, { app: "sonarr", result: "written", fields: ["ip", "port", "apiKey"] });
|
||||||
|
assert.deepEqual(f.settings.sonarr, {
|
||||||
|
...operatorSonarr(), ip: "ace.internal", port: 20101, apiKey: THE_KEY, ssl: false, subDir: null,
|
||||||
|
});
|
||||||
|
// Checked against the app itself, at the bound address, before anything was written.
|
||||||
|
assert.equal(f.calls[0].url, "http://ace.internal:20101/api/v3/system/status");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("nothing is written when ombi already says what the mesh says", async () => {
|
||||||
|
const f = fakes({ sonarr: { ...operatorSonarr(), ip: "ace.internal", port: 20101, apiKey: THE_KEY } });
|
||||||
|
const out = await reconcileApp(f.http, OMBI, SONARR, binding("sonarr-api", 20101), THE_KEY);
|
||||||
|
assert.deepEqual(out, { app: "sonarr", result: "unchanged" });
|
||||||
|
assert.equal(f.calls.filter((c) => c.method === "POST" && c.url.includes("/Settings/")).length, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a key the app refuses is never written, and the accept that fixes it is named", async () => {
|
||||||
|
const f = fakes({ sonarr: operatorSonarr() });
|
||||||
|
const out = await reconcileApp(f.http, OMBI, SONARR, binding("sonarr-api", 20101), "a-value-the-mesh-minted");
|
||||||
|
assert.equal(out.result, "refused");
|
||||||
|
assert.match((out as { problem: string }).problem, /secret accept <this node> ombi sonarr-api --provider ace/);
|
||||||
|
assert.doesNotMatch((out as { problem: string }).problem, /a-value-the-mesh-minted/);
|
||||||
|
assert.deepEqual(f.settings.sonarr, operatorSonarr(), "ombi's working settings were left alone");
|
||||||
|
assert.equal(f.calls.some((c) => c.url.includes("/api/v1/")), false, "ombi was not even asked");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an app it cannot reach is reported, and ombi is left alone", async () => {
|
||||||
|
const f = fakes({ sonarr: operatorSonarr() }, { reachable: false });
|
||||||
|
const out = await reconcileApp(f.http, OMBI, SONARR, binding("sonarr-api", 20101), THE_KEY);
|
||||||
|
assert.equal(out.result, "refused");
|
||||||
|
assert.match((out as { problem: string }).problem, /could not be asked.*ECONNREFUSED/);
|
||||||
|
assert.deepEqual(f.settings.sonarr, operatorSonarr());
|
||||||
|
});
|
||||||
|
|
||||||
|
test("radarr's connection is written inside its combined document, and the 4K instance is untouched", async () => {
|
||||||
|
const fourK = { enabled: true, apiKey: "4k-key", ip: "radarr4k", port: 7879, defaultQualityProfile: "9", id: 7 };
|
||||||
|
const f = fakes({ radarr: { radarr: { enabled: true, apiKey: "old", ip: "radarr", port: 7878, defaultRootPath: "/movies", id: 6 }, radarr4K: fourK } });
|
||||||
|
const out = await reconcileApp(f.http, OMBI, RADARR, binding("radarr-api", 20102), THE_KEY);
|
||||||
|
assert.equal(out.result, "written");
|
||||||
|
const doc = f.settings.radarr as { radarr: Record<string, unknown>; radarr4K: unknown };
|
||||||
|
assert.deepEqual(doc.radarr4K, fourK);
|
||||||
|
assert.equal(doc.radarr.ip, "ace.internal");
|
||||||
|
assert.equal(doc.radarr.port, 20102);
|
||||||
|
assert.equal(doc.radarr.defaultRootPath, "/movies");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("lidarr is checked on its own API version", async () => {
|
||||||
|
const f = fakes({ lidarr: { enabled: true, apiKey: null, ip: null, port: 0, id: 0 } });
|
||||||
|
const out = await reconcileApp(f.http, OMBI, LIDARR, binding("lidarr-api", 20103), THE_KEY);
|
||||||
|
assert.equal(out.result, "written");
|
||||||
|
assert.equal(f.calls[0].url, "http://ace.internal:20103/api/v1/system/status");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a loopback binding is refused: from ombi's container it is ombi itself", () => {
|
||||||
|
const w = wanted(SONARR, binding("sonarr-api", 20101, "127.0.0.1"), THE_KEY);
|
||||||
|
assert.equal(w.ok, false);
|
||||||
|
assert.match((w as { problem: string }).problem, /private network/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the base path is ombi's subDir, slashes trimmed; empty is none", () => {
|
||||||
|
assert.equal(subDirOf(""), null);
|
||||||
|
assert.equal(subDirOf("/sonarr/"), "sonarr");
|
||||||
|
assert.deepEqual(
|
||||||
|
differing({ ip: "h", port: 1, ssl: false, subDir: "", apiKey: "k" }, { ip: "h", port: 1, ssl: false, subDir: null, apiKey: "k" }),
|
||||||
|
[],
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an https binding sets ombi's ssl flag", () => {
|
||||||
|
const b = binding("sonarr-api", 443);
|
||||||
|
(b.serves as Record<string, unknown>).scheme = "https";
|
||||||
|
const w = wanted(SONARR, b, THE_KEY);
|
||||||
|
assert.equal(w.ok && w.connection.ssl, true);
|
||||||
|
});
|
||||||
@@ -8,5 +8,5 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["client.ts", "index.ts", "tools/index.ts"]
|
"include": ["client.ts", "index.ts", "tools/index.ts", "servarr/settings.ts", "servarr/index.ts"]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -82,7 +82,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_QBITTORRENT_URL": "http://127.0.0.1:8080",
|
"MESH_QBITTORRENT_URL": "http://127.0.0.1:${port:8080}",
|
||||||
"MESH_QBITTORRENT_PASSWORD_FILE": "/run/secrets/password",
|
"MESH_QBITTORRENT_PASSWORD_FILE": "/run/secrets/password",
|
||||||
"MESH_QBITTORRENT_CONFIG_FILE": "/run/config/config.json",
|
"MESH_QBITTORRENT_CONFIG_FILE": "/run/config/config.json",
|
||||||
"MESH_QBITTORRENT_CONFIG_DIR": "/var/lib/qbittorrent/config"
|
"MESH_QBITTORRENT_CONFIG_DIR": "/var/lib/qbittorrent/config"
|
||||||
|
|||||||
@@ -1,6 +1,19 @@
|
|||||||
{
|
{
|
||||||
"module": "radarr",
|
"module": "radarr",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
|
"provides": [
|
||||||
|
{
|
||||||
|
"name": "radarr-api",
|
||||||
|
"scope": "mesh"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"serves": {
|
||||||
|
"radarr-api": {
|
||||||
|
"scheme": "http",
|
||||||
|
"port": 7878,
|
||||||
|
"url-base": ""
|
||||||
|
}
|
||||||
|
},
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
@@ -75,7 +88,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_RADARR_URL": "http://127.0.0.1:7878",
|
"MESH_RADARR_URL": "http://127.0.0.1:${port:7878}",
|
||||||
"MESH_RADARR_CONFIG_DIR": "/var/lib/radarr/config"
|
"MESH_RADARR_CONFIG_DIR": "/var/lib/radarr/config"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
|||||||
@@ -100,7 +100,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_SEARXNG_URL": "http://127.0.0.1:8080",
|
"MESH_SEARXNG_URL": "http://127.0.0.1:${port:8080}",
|
||||||
"MESH_SEARXNG_CONFIG_FILE": "/run/config/config.json"
|
"MESH_SEARXNG_CONFIG_FILE": "/run/config/config.json"
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
|
|||||||
@@ -1,6 +1,19 @@
|
|||||||
{
|
{
|
||||||
"module": "sonarr",
|
"module": "sonarr",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
|
"provides": [
|
||||||
|
{
|
||||||
|
"name": "sonarr-api",
|
||||||
|
"scope": "mesh"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"serves": {
|
||||||
|
"sonarr-api": {
|
||||||
|
"scheme": "http",
|
||||||
|
"port": 8989,
|
||||||
|
"url-base": ""
|
||||||
|
}
|
||||||
|
},
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
@@ -80,7 +93,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_SONARR_URL": "http://127.0.0.1:8989",
|
"MESH_SONARR_URL": "http://127.0.0.1:${port:8989}",
|
||||||
"MESH_SONARR_CONFIG_DIR": "/var/lib/sonarr/config"
|
"MESH_SONARR_CONFIG_DIR": "/var/lib/sonarr/config"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
|||||||
Reference in New Issue
Block a user