Skip to content

Commit b6dcab2

Browse files
authored
Merge pull request #1263 from NanaKhadija1980j/cleanup/1222-remove-duplicate-crds
cleanup: remove duplicate sample CRDs (#1222)
2 parents 275dc9d + 9a56ee5 commit b6dcab2

4 files changed

Lines changed: 13 additions & 107 deletions

File tree

charts/stellar-operator/UPGRADE_GUIDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ helm get values stellar-operator -n stellar-system > backup-values.yaml
2323
# Backup CRD definitions
2424
kubectl get crd stellarnodes.stellar.org -o yaml > backup-stellarnode-crd.yaml
2525
kubectl get crd stellarbenchmarks.stellar.org -o yaml > backup-benchmark-crd.yaml
26+
kubectl get crd benchmarkreports.stellar.org -o yaml > backup-benchmarkreport-crd.yaml
2627

2728
# Backup all StellarNode resources
2829
kubectl get stellarnodes --all-namespaces -o yaml > backup-stellarnodes.yaml

charts/stellar-operator/templates/crd.yaml

Lines changed: 0 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -340,109 +340,3 @@ spec:
340340
- name: Age
341341
type: date
342342
jsonPath: .metadata.creationTimestamp
343-
344-
---
345-
# StellarBenchmark CRD
346-
apiVersion: apiextensions.k8s.io/v1
347-
kind: CustomResourceDefinition
348-
metadata:
349-
name: stellarbenchmarks.stellar.org
350-
labels: {{- include "stellar-operator.labels" . | nindent 4 }}
351-
spec:
352-
group: stellar.org
353-
names:
354-
kind: StellarBenchmark
355-
listKind: StellarBenchmarkList
356-
plural: stellarbenchmarks
357-
singular: stellarbenchmark
358-
shortNames:
359-
- sbench
360-
scope: Namespaced
361-
versions:
362-
- name: v1alpha1
363-
served: true
364-
storage: true
365-
subresources:
366-
status: {}
367-
additionalPrinterColumns:
368-
- name: Phase
369-
type: string
370-
jsonPath: .status.phase
371-
- name: Target
372-
type: string
373-
jsonPath: .spec.targetEndpoint
374-
- name: Duration
375-
type: integer
376-
jsonPath: .spec.durationSeconds
377-
- name: Age
378-
type: date
379-
jsonPath: .metadata.creationTimestamp
380-
schema:
381-
openAPIV3Schema:
382-
type: object
383-
properties:
384-
spec:
385-
type: object
386-
required:
387-
- targetEndpoint
388-
x-kubernetes-preserve-unknown-fields: true
389-
status:
390-
type: object
391-
x-kubernetes-preserve-unknown-fields: true
392-
393-
---
394-
# BenchmarkReport CRD
395-
apiVersion: apiextensions.k8s.io/v1
396-
kind: CustomResourceDefinition
397-
metadata:
398-
name: benchmarkreports.stellar.org
399-
labels: {{- include "stellar-operator.labels" . | nindent 4 }}
400-
spec:
401-
group: stellar.org
402-
names:
403-
kind: BenchmarkReport
404-
listKind: BenchmarkReportList
405-
plural: benchmarkreports
406-
singular: benchmarkreport
407-
shortNames:
408-
- br
409-
scope: Namespaced
410-
versions:
411-
- name: v1alpha1
412-
served: true
413-
storage: true
414-
subresources:
415-
status: {}
416-
additionalPrinterColumns:
417-
- name: Benchmark
418-
type: string
419-
jsonPath: .spec.benchmarkRef
420-
- name: PeakTPS
421-
type: number
422-
jsonPath: .spec.metrics.peakTps
423-
- name: AvgLedgerMs
424-
type: number
425-
jsonPath: .spec.metrics.avgLedgerCloseMs
426-
- name: P99LatencyMs
427-
type: number
428-
jsonPath: .spec.metrics.p99ApiLatencyMs
429-
- name: Age
430-
type: date
431-
jsonPath: .metadata.creationTimestamp
432-
schema:
433-
openAPIV3Schema:
434-
type: object
435-
properties:
436-
spec:
437-
type: object
438-
required:
439-
- benchmarkRef
440-
- startedAt
441-
- completedAt
442-
- targetEndpoint
443-
- config
444-
- metrics
445-
x-kubernetes-preserve-unknown-fields: true
446-
status:
447-
type: object
448-
x-kubernetes-preserve-unknown-fields: true

config/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,13 @@ and package metadata) is committed.
131131
kubectl apply -f config/crd/
132132
```
133133

134+
Benchmark workloads require the canonical benchmark CRDs (not bundled in the Helm chart):
135+
136+
```bash
137+
kubectl apply -f config/crd/stellarbenchmark-crd.yaml
138+
kubectl apply -f config/crd/stellarbenchmarkreport-crd.yaml
139+
```
140+
134141
### Apply Sample Resources
135142

136143
```bash

config/samples/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,13 @@ This directory contains ready-to-apply sample manifests for testing and developm
1717
## Quick Start
1818

1919
```bash
20-
# Install the CRD first
20+
# Install the StellarNode CRD (required)
2121
kubectl apply -f ../crd/stellarnode-crd.yaml
2222

23+
# For benchmark samples, also install canonical benchmark CRDs:
24+
kubectl apply -f ../crd/stellarbenchmark-crd.yaml
25+
kubectl apply -f ../crd/stellarbenchmarkreport-crd.yaml
26+
2327
# Apply the minimal sample
2428
kubectl apply -f minimal-validator.yaml
2529
```

0 commit comments

Comments
 (0)