Skip to content

Add chart values schema for documenting properties type #4

@petruki

Description

@petruki

Under ojp-server chart add values.schema.json using the file structure below as example:

{
    "$schema": "https://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "app": {
            "type": "object",
            "properties": {
                "affinity": {
                    "type": "object"
                },
                "autoscaling": {
                    "type": "object",
                    "properties": {
                        "enabled": {
                            "type": "boolean"
                        },
                        "maxReplicas": {
                            "type": "integer"
                        },
                        "minReplicas": {
                            "type": "integer"
                        },
                        "targetCPUUtilizationPercentage": {
                            "type": "integer"
                        }
                    }
                },
                "env": {
                    "type": "object",
                    "properties": {
                        [OJP_SERVER_PROPERTIES]
                    }
                },
                "envFrom": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "configMapRef": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    }
                },
                "fullnameOverride": {
                    "type": "string"
                },
                "image": {
                    "type": "object",
                    "properties": {
                        "pullPolicy": {
                            "type": "string"
                        },
                        "repository": {
                            "type": "string"
                        },
                        "tag": {
                            "type": "string"
                        }
                    }
                },
                "imagePullSecrets": {
                    "type": "array"
                },
                "nameOverride": {
                    "type": "string"
                },
                "nodeSelector": {
                    "type": "object"
                },
                "podAnnotations": {
                    "type": "object"
                },
                "port": {
                    "type": "integer"
                },
                "replicaCount": {
                    "type": "integer"
                },
                "resources": {
                    "type": "object"
                },
                "service": {
                    "type": "object",
                    "properties": {
                        "port": {
                            "type": "integer"
                        },
                        "type": {
                            "type": "string"
                        }
                    }
                },
                "tolerations": {
                    "type": "array"
                }
            }
        }
    }
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions