-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathhermes-operator.clusterserviceversion.yaml
More file actions
659 lines (617 loc) · 22.3 KB
/
Copy pathhermes-operator.clusterserviceversion.yaml
File metadata and controls
659 lines (617 loc) · 22.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
apiVersion: operators.coreos.com/v1alpha1
kind: ClusterServiceVersion
metadata:
name: hermes-operator.v0.1.10
namespace: placeholder
annotations:
capabilities: Auto Pilot
categories: AI/Machine Learning, Developer Tools, Application Runtime
containerImage: ghcr.io/paperclipinc/hermes-operator:v0.1.10
createdAt: '2026-05-12T00:00:00Z'
support: paperclipinc
repository: https://github.com/paperclipinc/hermes-operator
description: >-
A production-grade Kubernetes operator for deploying and managing
nousresearch/hermes-agent: a Python-based self-improving multi-platform AI
agent.
alm-examples: |-
[
{
"apiVersion": "hermes.agent/v1",
"kind": "HermesInstance",
"metadata": { "name": "demo", "namespace": "default" },
"spec": {
"image": { "repository": "ghcr.io/paperclipinc/hermes-agent", "tag": "1.0.0" },
"storage": { "persistence": { "enabled": true, "size": "10Gi" } },
"envFrom": [{ "secretRef": { "name": "hermes-api-keys" } }]
}
},
{
"apiVersion": "hermes.agent/v1",
"kind": "HermesInstance",
"metadata": { "name": "production", "namespace": "hermes" },
"spec": {
"image": { "repository": "ghcr.io/paperclipinc/hermes-agent", "tag": "1.0.0" },
"resources": {
"requests": { "cpu": "500m", "memory": "1Gi" },
"limits": { "cpu": "2", "memory": "4Gi" }
},
"storage": { "persistence": { "enabled": true, "size": "50Gi" } },
"gateways": {
"telegram": { "enabled": true, "tokenSecretRef": { "name": "tg-token" } },
"slack": { "enabled": true, "tokenSecretRef": { "name": "slack-token" } }
},
"profileStore": { "enabled": true, "persistence": { "size": "5Gi" } },
"selfConfigure": {
"enabled": true,
"protectedKeys": ["image", "storage", "security", "networking"]
},
"observability": { "serviceMonitor": { "enabled": true } },
"backup": {
"s3": {
"bucket": "hermes-backups",
"endpoint": "s3.amazonaws.com",
"region": "us-east-1",
"credentialsSecretRef": { "name": "hermes-s3-creds" }
},
"schedule": "0 3 * * *",
"onDelete": true,
"historyLimit": 30
},
"autoUpdate": {
"enabled": true,
"source": { "registry": "ghcr.io/paperclipinc/hermes-agent", "channel": "1.x" },
"rollback": { "enabled": true, "probeFailureThreshold": 3 }
}
}
},
{
"apiVersion": "hermes.agent/v1",
"kind": "HermesSelfConfig",
"metadata": { "name": "install-finance-skill", "namespace": "default" },
"spec": {
"instanceRef": "production",
"addSkills": [{ "source": "git+https://github.com/foo/finance-skill@v1.2.0" }],
"patchConfig": { "schedules": { "morning-brief": "0 8 * * *" } },
"addEnvVars": [{ "name": "FINANCE_TZ", "value": "Europe/Berlin" }]
}
},
{
"apiVersion": "hermes.agent/v1",
"kind": "HermesClusterDefaults",
"metadata": { "name": "cluster" },
"spec": {
"image": { "repository": "ghcr.io/paperclipinc/hermes-agent", "tag": "1.0.0" },
"storage": { "storageClassName": "gp3", "size": "10Gi" },
"observability": { "serviceMonitor": { "enabled": true } },
"networking": { "networkPolicy": { "enabled": true } }
}
}
]
features.operators.openshift.io/disconnected: 'false'
features.operators.openshift.io/fips-compliant: 'false'
features.operators.openshift.io/proxy-aware: 'false'
features.operators.openshift.io/tls-profiles: 'false'
features.operators.openshift.io/token-auth-aws: 'false'
features.operators.openshift.io/token-auth-azure: 'false'
features.operators.openshift.io/token-auth-gcp: 'false'
spec:
icon:
- base64data: PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMjggMTI4IiByb2xlPSJpbWciIGFyaWEtbGFiZWw9Ikhlcm1lcyBPcGVyYXRvciI+CiAgPHJlY3Qgd2lkdGg9IjEyOCIgaGVpZ2h0PSIxMjgiIHJ4PSIyNCIgZmlsbD0iIzBCMTAyMCIvPgogIDxwYXRoIGQ9Ik00NCAzNnY1Nk04NCAzNnY1Nk00NCA2NGg0MCIgc3Ryb2tlPSIjNUI4REVGIiBzdHJva2Utd2lkdGg9IjEwIiBzdHJva2UtbGluZWNhcD0icm91bmQiLz4KICA8cGF0aCBkPSJNMzAgNTBjLTEwLTYtMjAtNi0yNi0yIDggMiAxNCA2IDE4IDEyek05OCA1MGMxMC02IDIwLTYgMjYtMi04IDItMTQgNi0xOCAxMnoiIGZpbGw9IiM3Q0UwQzMiLz4KPC9zdmc+Cg==
mediatype: image/svg+xml
displayName: Hermes Operator
description: >
## Hermes Kubernetes Operator
A production-grade Kubernetes operator for deploying and managing
[nousresearch/hermes-agent](https://github.com/nousresearch/hermes-agent):
a Python-based, self-improving, multi-platform AI agent.
### What is hermes-agent?
hermes-agent fronts multiple messaging platforms (Telegram, Discord, Slack,
WhatsApp, Signal), self-improves through a built-in learning loop, persists
session memory via FTS5, models users via Honcho dialectic profiles, and
runs
scheduled automations via a native cron scheduler.
### Key Capabilities
- **Declarative Deployment**: every aspect of an agent's runtime, gateways,
storage, networking, observability, and security through a single
`HermesInstance` resource.
- **Self-Configuration with Audit**: the agent persists learned skills, env
vars, config patches, and workspace files via `HermesSelfConfig` CRs that
the operator validates against an explicit allowlist, then applies via
Server-Side Apply (no GitOps flap).
- **Cluster Defaults**: `HermesClusterDefaults` (cluster-scoped singleton)
supplies organization-wide defaults for image, storage class, IRSA, etc.
- **Auto-Update with Rollback**: OCI registry polling with pre-update backup
and probe-driven rollback.
- **Backup / Restore**: S3-compatible (R2, MinIO, AWS), backup-on-delete
finalizer, declarative restore from snapshot.
- **OpenClaw Migration**: one-shot `spec.migration.fromOpenClaw` invokes
hermes-agent's built-in importer.
- **Honcho Profile Store**: optional companion Deployment with persistence
for dialectic user profiles.
- **Multi-Platform Gateways**: first-class config for Telegram, Discord,
Slack, WhatsApp, Signal: each with isolated secret rotation.
### Default Security Posture
All containers run as non-root, drop ALL Linux capabilities, use
RuntimeDefault seccomp, mount a read-only root filesystem with explicit
writable subPaths, and apply default-deny NetworkPolicies. PVCs are
immutable post-create; finalizer-driven backup-on-delete is configurable.
### Managed Resources
For each HermesInstance the operator creates and manages:
StatefulSet, Service, ServiceAccount, ConfigMap (workspace), ConfigMap
(gateway-derived), PVC, Role, RoleBinding, NetworkPolicy,
PodDisruptionBudget, optionally Ingress, ServiceMonitor, HPA, Honcho
Deployment + PVC + Service, and migration / backup Jobs. All resources are
owned by the CR and garbage-collected on deletion (with the
`hermes.agent/backup-on-delete` finalizer holding deletion until the
backup Job completes).
### Getting Started
1. Install the operator via OLM or `helm install`.
2. Create a Secret with your AI provider keys and platform tokens.
3. Create a `HermesInstance` referencing the Secret.
4. The operator handles the rest: deployment, networking, security,
lifecycle.
### Prerequisites
- Kubernetes 1.28+
maturity: alpha
version: 0.1.10
minKubeVersion: 1.28.0
keywords:
- ai
- agent
- hermes
- nousresearch
- llm
- kubernetes
- ai-agent
- chatbot
- telegram
- discord
- slack
- whatsapp
- signal
- honcho
- self-improving
- python
maintainers:
- name: Jannes Stubbemann
email: jannes@paperclip.inc
provider:
name: paperclipinc
url: https://github.com/paperclipinc/hermes-operator
links:
- name: GitHub Repository
url: https://github.com/paperclipinc/hermes-operator
- name: API Reference
url: >-
https://github.com/paperclipinc/hermes-operator/blob/main/docs/api-reference.md
- name: Changelog
url: https://github.com/paperclipinc/hermes-operator/blob/main/CHANGELOG.md
installModes:
- type: OwnNamespace
supported: true
- type: SingleNamespace
supported: true
- type: MultiNamespace
supported: false
- type: AllNamespaces
supported: true
relatedImages:
- name: hermes-operator
image: ghcr.io/paperclipinc/hermes-operator:v0.1.0
- name: hermes-agent
image: ghcr.io/paperclipinc/hermes-agent:v2026.5.29.2
customresourcedefinitions:
owned:
- name: hermesinstances.hermes.agent
version: v1
kind: HermesInstance
displayName: Hermes Instance
description: >-
Represents a managed hermes-agent instance with security, networking,
gateways, storage, and observability.
specDescriptors:
- path: image.repository
displayName: Image Repository
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- path: image.tag
displayName: Image Tag
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- path: storage.persistence.enabled
displayName: Persistent Storage
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: storage.persistence.size
displayName: Storage Size
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- path: resources
displayName: Resource Requirements
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:resourceRequirements
- path: gateways.telegram.enabled
displayName: Telegram Gateway
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: gateways.discord.enabled
displayName: Discord Gateway
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: gateways.slack.enabled
displayName: Slack Gateway
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: gateways.whatsapp.enabled
displayName: WhatsApp Gateway
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: gateways.signal.enabled
displayName: Signal Gateway
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: profileStore.enabled
displayName: Honcho Profile Store
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: selfConfigure.enabled
displayName: Agent Self-Configuration
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: observability.serviceMonitor.enabled
displayName: Prometheus ServiceMonitor
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: autoUpdate.enabled
displayName: Auto Update
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: backup.s3.bucket
displayName: Backup S3 Bucket
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- path: networking.ingress.enabled
displayName: Ingress
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: networking.networkPolicy.enabled
displayName: NetworkPolicy
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- path: suspended
displayName: Suspended (scale-to-zero)
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
statusDescriptors:
- path: phase
displayName: Phase
x-descriptors:
- urn:alm:descriptor:io.kubernetes.phase
- path: conditions
displayName: Conditions
x-descriptors:
- urn:alm:descriptor:io.kubernetes.conditions
- path: observedGeneration
displayName: Observed Generation
x-descriptors:
- urn:alm:descriptor:text
- path: lastBackupTime
displayName: Last Backup
x-descriptors:
- urn:alm:descriptor:text
- path: lastBackupPath
displayName: Last Backup Path
x-descriptors:
- urn:alm:descriptor:text
- path: autoUpdate.latestVersion
displayName: Latest Available Version
x-descriptors:
- urn:alm:descriptor:text
- path: migrationCompleted
displayName: Migration Completed
x-descriptors:
- urn:alm:descriptor:text
resources:
- kind: StatefulSet
version: v1
- kind: Service
version: v1
- kind: ServiceAccount
version: v1
- kind: ConfigMap
version: v1
- kind: PersistentVolumeClaim
version: v1
- kind: NetworkPolicy
version: v1
- kind: PodDisruptionBudget
version: v1
- kind: Ingress
version: v1
- kind: Role
version: v1
- kind: RoleBinding
version: v1
- kind: ServiceMonitor
version: v1
- kind: Job
version: v1
- kind: HorizontalPodAutoscaler
version: v2
- name: hermesselfconfigs.hermes.agent
version: v1
kind: HermesSelfConfig
displayName: Hermes SelfConfig
description: >-
Agent-initiated mutation request, validated against the parent
instance's selfConfigure policy and applied via Server-Side Apply.
specDescriptors:
- path: instanceRef
displayName: Instance Reference
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- path: addSkills
displayName: Skills to Add
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:fieldGroup:Mutations
statusDescriptors:
- path: phase
displayName: Phase
x-descriptors:
- urn:alm:descriptor:io.kubernetes.phase
- path: conditions
displayName: Conditions
x-descriptors:
- urn:alm:descriptor:io.kubernetes.conditions
- path: appliedAt
displayName: Applied At
x-descriptors:
- urn:alm:descriptor:text
- path: denyReason
displayName: Deny Reason
x-descriptors:
- urn:alm:descriptor:text
- name: hermesclusterdefaults.hermes.agent
version: v1
kind: HermesClusterDefaults
displayName: Hermes Cluster Defaults
description: >-
Cluster-scoped singleton that fills nil fields on every
HermesInstance. Name must be 'cluster'.
specDescriptors:
- path: image.repository
displayName: Default Image Repository
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- path: storage.storageClassName
displayName: Default StorageClass
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
statusDescriptors:
- path: conditions
displayName: Conditions
x-descriptors:
- urn:alm:descriptor:io.kubernetes.conditions
install:
strategy: deployment
spec:
clusterPermissions:
- serviceAccountName: hermes-operator-controller-manager
rules:
- apiGroups:
- ''
resources:
- configmaps
- events
- persistentvolumeclaims
- secrets
- serviceaccounts
- services
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- ''
resources:
- pods
verbs:
- get
- list
- watch
- apiGroups:
- apps
resources:
- deployments
- statefulsets
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- autoscaling
resources:
- horizontalpodautoscalers
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- batch
resources:
- cronjobs
- jobs
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- hermes.agent
resources:
- hermesclusterdefaults
verbs:
- get
- list
- patch
- update
- watch
- apiGroups:
- hermes.agent
resources:
- hermesclusterdefaults/status
- hermesinstances/status
- hermesselfconfigs/status
verbs:
- get
- patch
- update
- apiGroups:
- hermes.agent
resources:
- hermesinstances
- hermesselfconfigs
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- hermes.agent
resources:
- hermesinstances/finalizers
- hermesselfconfigs/finalizers
verbs:
- update
- apiGroups:
- monitoring.coreos.com
resources:
- prometheusrules
- servicemonitors
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- networking.k8s.io
resources:
- ingresses
- networkpolicies
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- openclaw.rocks
resources:
- openclawinstances
verbs:
- get
- list
- watch
- apiGroups:
- policy
resources:
- poddisruptionbudgets
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- rbac.authorization.k8s.io
resources:
- rolebindings
- roles
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
deployments:
- name: hermes-operator-controller-manager
spec:
replicas: 1
selector:
matchLabels:
control-plane: controller-manager
template:
metadata:
annotations:
kubectl.kubernetes.io/default-container: manager
labels:
control-plane: controller-manager
spec:
securityContext:
runAsNonRoot: true
seccompProfile:
type: RuntimeDefault
serviceAccountName: hermes-operator-controller-manager
terminationGracePeriodSeconds: 10
containers:
- name: manager
image: ghcr.io/paperclipinc/hermes-operator:v0.1.0
command:
- /manager
args:
- '--leader-elect'
- '--health-probe-bind-address=:8081'
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
readOnlyRootFilesystem: true
runAsNonRoot: true
livenessProbe:
httpGet:
path: /healthz
port: 8081
initialDelaySeconds: 15
periodSeconds: 20
readinessProbe:
httpGet:
path: /readyz
port: 8081
initialDelaySeconds: 5
periodSeconds: 10
resources:
limits:
cpu: 500m
memory: 256Mi
requests:
cpu: 100m
memory: 128Mi