Skip to content

feat: define basic validation of helm values #11

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
Djaytan merged 1 commit into from
Jun 19, 2025
Merged

feat: define basic validation of helm values #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
100 changes: 100 additions & 0 deletions src/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
{
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "PaperMC-server Helm Chart Values Schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Optional name override for the server. Defaults to the Helm release name if not set."
},
"namespace": {
"type": "string",
"description": "Kubernetes namespace for the deployment."
},
"eula": {
"type": "boolean",
"description": "Must be set to true to accept Minecraft's EULA."
},
"container": {
"type": "object",
"description": "Container configuration.",
"properties": {
"image": {
"type": "string",
"description": "Container image to use for the server."
},
"resources": {
"type": "object",
"description": "Resource requests and limits.",
"properties": {
"requests": {
"type": "object",
"properties": {
"ephemeralStorage": { "type": "string" },
"cpu": { "type": "integer", "minimum": 1 },
"memory": { "type": "string" }
},
"required": ["ephemeralStorage", "cpu", "memory"]
},
"limits": {
"type": "object",
"required": ["ephemeralStorage", "cpu", "memory"],
"properties": {
"ephemeralStorage": { "type": "string" },
"cpu": { "type": "integer", "minimum": 1 },
"memory": { "type": "string" }
}
}
},
"required": ["requests", "limits"]
}
},
"required": ["image", "resources"]
},
"service": {
"type": "object",
"properties": {
"ports": {
"type": "object",
"properties": {
"nodePort": {
"type": "integer",
"minimum": 30000,
"maximum": 32767,
"description": "NodePort to expose the Minecraft server on."
}
},
"required": ["nodePort"]
}
},
"required": ["ports"]
},
"healthcheck": {
"type": "object",
"description": "Health check configuration to restart the server if it becomes unhealthy.",
"properties": {
"checkInterval": {
"type": "integer",
"minimum": 1,
"description": "Time interval in seconds between consecutive health checks."
},
"failureThreshold": {
"type": "object",
"properties": {
"startup": {
"type": "integer",
"description": "Threshold in seconds to declare the server unhealthy during startup."
},
"liveness": {
"type": "integer",
"description": "Threshold in seconds to declare the server unhealthy during normal operation."
}
},
"required": ["startup", "liveness"]
}
},
"required": ["checkInterval", "failureThreshold"]
}
},
"required": ["namespace", "eula", "container", "service", "healthcheck"]
}