Skip to content

feat(diagnostics): Add diagnostics buckets setup #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrewazores merged 2 commits into from
Oct 3, 2025
Merged

feat(diagnostics): Add diagnostics buckets setup #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9421d61
Add diagnostics buckets setup
Josh-Matsuoka Oct 3, 2025
29d3867
readme
andrewazores Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions charts/cryostat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,8 @@ certificate issuance and rotation.
| `storage.buckets.names.archivedReports` | the name of the storage bucket containing the Automated Analysis Report for archived Flight Recordings | `archivedreports` |
| `storage.buckets.names.eventTemplates` | the name of the storage bucket containing Custom Event Templates | `eventtemplates` |
| `storage.buckets.names.jmcAgentProbeTemplates` | the name of the storage bucket containing JMC Agent Probe Templates | `probes` |
| `storage.buckets.names.threadDumps` | the name of the storage bucket containing archived Thread Dumps | `threaddumps` |
| `storage.buckets.names.heapDumps` | the name of the storage bucket containing archived Heap Dumps | `heapdumps` |
| `storage.buckets.names.metadata` | the name of the storage bucket containing files' metadata. Only used if storage.provider.metadata.storageMode is set to 'bucket'. | `metadata` |
| `storage.encryption.enabled` | Enable at-rest encryption of stored objects. The storage container will generate a secret key for each stored object and use this key to encrypt and decrypt objects transparently. The key is written to the object metadata, so in the default storage container configuration this only adds a small layer of additional security | `true` |
| `storage.podAnnotations` | Annotations to be applied to the Storage Pods | `{}` |
Expand Down
4 changes: 4 additions & 0 deletions charts/cryostat/templates/cryostat_deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ spec:
value: {{ .Values.storage.buckets.names.eventTemplates }}
- name: STORAGE_BUCKETS_PROBE_TEMPLATES_NAME
value: {{ .Values.storage.buckets.names.jmcAgentProbeTemplates }}
- name: STORAGE_BUCKETS_THREAD_DUMPS_NAME
value: {{ .Values.storage.buckets.names.threadDumps }}
- name: STORAGE_BUCKETS_HEAP_DUMPS_NAME
value: {{ .Values.storage.buckets.names.heapDumps }}
- name: STORAGE_BUCKETS_METADATA_NAME
value: {{ .Values.storage.buckets.names.metadata }}
- name: CRYOSTAT_SERVICES_REPORTS_STORAGE_CACHE_NAME
Expand Down
14 changes: 14 additions & 0 deletions charts/cryostat/tests/cryostat_deployment_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ tests:
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat')].env[?(@.name=='STORAGE_BUCKETS_PROBE_TEMPLATES_NAME')].value
value: "probes"
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat')].env[?(@.name=='STORAGE_BUCKETS_THREAD_DUMPS_NAME')].value
value: "threaddumps"
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat')].env[?(@.name=='STORAGE_BUCKETS_HEAP_DUMPS_NAME')].value
value: "heapdumps"
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat')].env[?(@.name=='STORAGE_BUCKETS_METADATA_NAME')].value
value: "metadata"
Expand Down Expand Up @@ -207,6 +213,8 @@ tests:
eventTemplates: c
jmcAgentProbeTemplates: d
metadata: e
threadDumps: f
heapDumps: g
asserts:
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat')].env[?(@.name=='STORAGE_METADATA_STORAGE_MODE')].value
Expand All @@ -226,6 +234,12 @@ tests:
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat')].env[?(@.name=='STORAGE_BUCKETS_METADATA_NAME')].value
value: "e"
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat')].env[?(@.name=='STORAGE_BUCKETS_THREAD_DUMPS_NAME')].value
value: "f"
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat')].env[?(@.name=='STORAGE_BUCKETS_HEAP_DUMPS_NAME')].value
value: "g"

- it: should allow disabling S3 TLS validation
set:
Expand Down
6 changes: 4 additions & 2 deletions charts/cryostat/tests/storage_deployment_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ tests:
value: "Always"
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat-storage')].env[?(@.name=='CRYOSTAT_BUCKETS')].value
value: "archivedrecordings,archivedreports,eventtemplates,metadata,probes"
value: "archivedrecordings,archivedreports,eventtemplates,heapdumps,metadata,probes,threaddumps"
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat-storage')].env[?(@.name=='CRYOSTAT_ACCESS_KEY')].valueFrom.secretKeyRef
value:
Expand Down Expand Up @@ -147,10 +147,12 @@ tests:
archivedReports: c
eventTemplates: d
jmcAgentProbeTemplates: e
threadDumps: f
heapDumps: g
asserts:
- equal:
path: spec.template.spec.containers[?(@.name=='cryostat-storage')].env[?(@.name=='CRYOSTAT_BUCKETS')].value
value: "a,b,c,d,e"
value: "a,b,c,d,e,f,g"

- it: should allow disabling at-rest encryption
set:
Expand Down
10 changes: 10 additions & 0 deletions charts/cryostat/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,6 +739,16 @@
"description": "the name of the storage bucket containing JMC Agent Probe Templates",
"default": "probes"
},
"threadDumps": {
"type": "string",
"description": "the name of the storage bucket containing archived Thread Dumps",
"default": "threaddumps"
},
"heapDumps": {
"type": "string",
"description": "the name of the storage bucket containing archived Heap Dumps",
"default": "heapdumps"
},
"metadata": {
"type": "string",
"description": "the name of the storage bucket containing files' metadata. Only used if storage.provider.metadata.storageMode is set to 'bucket'.",
Expand Down
4 changes: 4 additions & 0 deletions charts/cryostat/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,10 @@ storage:
eventTemplates: eventtemplates
## @param storage.buckets.names.jmcAgentProbeTemplates the name of the storage bucket containing JMC Agent Probe Templates
jmcAgentProbeTemplates: probes
## @param storage.buckets.names.threadDumps the name of the storage bucket containing archived Thread Dumps
threadDumps: threaddumps
## @param storage.buckets.names.heapDumps the name of the storage bucket containing archived Heap Dumps
heapDumps: heapdumps
## @param storage.buckets.names.metadata the name of the storage bucket containing files' metadata. Only used if storage.provider.metadata.storageMode is set to 'bucket'.
metadata: metadata
encryption:
Expand Down