values.schema.json

{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "title": "Values",
  "description": "Values for K2HDKC DBaaS Helm",
  "type": "object",

  "properties": {
    "nameOverride": {
      "description": "[optional] Override release part of fully name, if not specified fullnameOverride value.",
      "type": "string"
    },
    "fullnameOverride": {
      "description": "[optional] Override fully chart/release name",
      "type": "string"
    },

    "serviceAccount": {
      "description": "[optional] Service account setting.",
      "type": "object",
      "properties": {
        "create": {
          "description": "[optional] Specifies whether to create a service account, default is true.",
          "type": "boolean"
        },
        "annotations": {
          "description": "[optional] Annotations to add to the service account, default is empty.",
          "type": "object"
        },
        "name": {
          "description": "[optional] Specifies Service account name, default is empty. If not set and create is true, a name is generated using the fullname template.",
          "type": "string"
        }
      },
      "required": [
        "create",
        "annotations",
        "name"
      ]
    },

    "antpickax": {
      "description": "[optional] Common application settings for AntPickax products.",
      "type": "object",
      "properties": {
        "configDir": {
          "description": "[optional] Configration directory path for AntPickax products, default is /etc/antpickax.",
          "type": "string"
        },
        "certPeriodYear": {
          "description": "[optional] Period years for self signed certificates using in pods, default is 5(year).",
          "type": "number",
          "exclusiveMinimum": 0
        }
      },
      "required": [
        "configDir",
        "certPeriodYear"
      ]
    },

    "dbaas": {
      "description": "[optional] K2HDKC cluster settings.",
      "type": "object",
      "properties": {
        "clusterName": {
          "description": "[optional] Specify a cluster name for K2HDKC, default is empty. If not set, a name is Release name(.Release.Name).",
          "type": "string"
        },
        "startManual": {
          "description": "[optional] Specifies whether to boot the k2hdkc processes manually. This is a flag for debugging.",
          "type": "boolean"
        },
        "baseDomain": {
          "description": "[optional] Specifies the base domain name for the k2hr3 cluster. The default is empty, if empty k8s.domain is used.",
          "type": "string"
        },

        "server": {
          "description": "[optional] The setting for the servers of the K2HDKC cluster.",
          "type": "object",
          "properties": {
            "count": {
              "description": "[optional] Specify the server count in K2HKDC cluster, default is 2.",
              "type": "number",
              "exclusiveMinimum": 0
            },
            "port": {
              "description": "[optional] Specify the port number for K2HDKC servers, default is 8020.",
              "type": "number",
              "exclusiveMinimum": 0
            },
            "ctlport": {
              "description": "[optional] Specify the control port number for K2HDKC servers, default is 8021.",
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "required": [
            "count",
            "port",
            "ctlport"
          ]
        },

        "slave": {
          "description": "[optional] The setting for the slaves of the K2HDKC cluster.",
          "type": "object",
          "properties": {
            "count": {
              "description": "[optional] Specify the slave count in K2HKDC cluster, default is 2.",
              "type": "number",
              "exclusiveMinimum": 0
            },
            "ctlport": {
              "description": "[optional] Specify the control port number for K2HDKC slaves, default is 8022.",
              "type": "number",
              "exclusiveMinimum": 0
            },
            "image": {
              "description": "[optional] Specifies the docker image for k2hdkc slave container. If empty, antpickax/k2hdkc:1.0.3 is set as default.",
              "type": "string"
            },
            "command": {
              "description": "[optional] Specifies the command for k2hdkc slave container. If empty, /bin/sh is set as default.",
              "type": "array"
            },
            "args": {
              "description": "[optional] Specifies the args for k2hdkc slave container. If empty, dbaas-k2hdkc-dummyslave.sh is set as default.",
              "type": "array"
            },
            "files": {
              "description": "[optional] Specifies additional files in configmap. The files must be under chart directory, if not, could not load file contents.",
              "type": "array"
            },
            "expandFiles": {
              "description": "[optional] Specifies additional files and its contents(string) in configmap. Each value must have key and content subkey.",
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "description": "[required] Specify the filename.",
                    "type": "string",
                    "minLength": 1
                  },
                  "contents": {
                    "description": "[required] Specify the file contents(string) to upload.",
                    "type": "string",
                    "minLength": 1
                  }
                },
                "required": [
                  "key",
                  "contents"
                ]
              }
            }
          },
          "required": [
            "count",
            "ctlport"
          ]
        },

        "env": {
          "description": "[optional] The environments for the K2HDKC cluster.",
          "type": "object",
          "properties": {
            "httpProxy": {
              "description": "[optional] Specify the HTTP PROXY environment(ex. http://proxy.local:8080) for the K2HDKC cluster, default is empty.",
              "type": "string",
              "maxLength": 255
            },
            "httpsProxy": {
              "description": "[optional] Specify the HTTPS PROXY environment(ex. http://proxy.local:8080) for the K2HDKC cluster, default is empty.",
              "type": "string",
              "maxLength": 255
            },
            "noProxy": {
              "description": "[optional] Specify the NO PROXY environment(ex. internal,127.1.1.1) for the K2HDKC cluster, default is empty.",
              "type": "string",
              "maxLength": 2047
            }
          },
          "required": [
            "httpProxy",
            "httpsProxy",
            "noProxy"
          ]
        }
      },
      "required": [
        "clusterName",
        "startManual",
        "baseDomain",
        "server",
        "slave"
      ]
    },

    "k2hr3": {
      "description": "[optional] Settings for the K2HR3 system used by the K2HDKC cluster.",
      "type": "object",
      "properties": {
        "clusterName": {
          "description": "[optional] Specify a cluster name for K2HR3 system, default is empty. If not set, a name is k2hr3.",
          "type": "string"
        },
        "baseDomain": {
          "description": "[optional] Specifies the base domain name for the K2HR3 system, default is empty. If not set, it is set the domain name for K2HDKC cluster.",
          "type": "string"
        },
        "unscopedToken": {
          "description": "[required] Specifies the Unscoped Token for K2HR3 system, this token is used for setting information for K2HDKC cluster.",
          "type": "string",
          "minLength": 1
        },

        "api": {
          "description": "[optional] The setting for the K2HR3 REST API in K2HR3 system.",
          "type": "object",
          "properties": {
            "baseName": {
              "description": "[optional] Specify the base name for K2HR3 REST API, default is empty in which case r3api will be used.",
              "type": "string"
            },
            "intPort": {
              "description": "[optional] Specify the internal port number for K2HR3 REST API slaves, default is 443.",
              "type": "number",
              "exclusiveMinimum": 0
            }
          },
          "required": [
            "baseName",
            "intPort"
          ]
        }
      },
      "required": [
        "clusterName",
        "baseDomain",
        "unscopedToken",
        "api"
      ]
    },

    "images": {
      "description": "[optional] Specify the organization and version of the image used by the pods deployed.",
      "type": "object",
      "properties": {
        "dkc": {
          "description": "[optional] Specify the K2HDKC image organization and version.",
          "type": "object",
          "properties": {
            "fullImageName": {
              "description": "[optional] Specify the image full name(organaization/name/version) for K2HDKC image, default is empty in which case antpickax will be used.",
              "type": "string"
            },
            "organization": {
              "description": "[optional] Specify the organaization for the K2HDKC image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            },
            "imageName": {
              "description": "[optional] Specify the image name for K2HDKC image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            },
            "version": {
              "description": "[optional] Specify the version for the K2HDKC image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            }
          }
        },

        "chmpx": {
          "description": "[optional] Specify the CHMPX image organization and version.",
          "type": "object",
          "properties": {
            "fullImageName": {
              "description": "[optional] Specify the image full name(organaization/name/version) for CHMPX image, default is empty in which case antpickax will be used.",
              "type": "string"
            },
            "organization": {
              "description": "[optional] Specify the organaization for the CHMPX image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            },
            "imageName": {
              "description": "[optional] Specify the image name for CHMPX image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            },
            "version": {
              "description": "[optional] Specify the version for the CHMPX image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            }
          }
        },

        "init": {
          "description": "[optional] Specify the organization and name and version of the container initialization/setup image.",
          "type": "object",
          "properties": {
            "fullImageName": {
              "description": "[optional] Specify the image full name(organaization/name/version) for the container initialization/setup image, default is empty.",
              "type": "string"
            },
            "organization": {
              "description": "[optional] Specify the organization of the container initialization/setup image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            },
            "imageName": {
              "description": "[optional] Specify the image name for the container initialization/setup image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            },
            "version": {
              "description": "[optional] Specify the version of the container initialization/setup image, default is empty. (valid only if fullImageName is empty)",
              "type": "string"
            }
          }
        }
      },
      "required": [
        "dkc",
        "chmpx",
        "init"
      ]
    },

    "mountPoint": {
      "description": "[optional] Specify the directory path in each pods to mount the configmap and secret.",
      "type": "object",
      "properties": {
        "configMap": {
          "description": "[optional] Specify the directory path in each pods to mount the configmap, default is /configmap.",
          "type": "string"
        },
        "ca": {
          "description": "[optional] Specify the directory path in each pods to mount the secret which has CA self signed certificates, default is /secret-ca.",
          "type": "string"
        },
        "k2hr3Token": {
          "description": "[optional] Specify the directory path in each pods to mount the K2HR3 Unscoped Token file, default is /secret-k2hr3-token.",
          "type": "string"
        }
      },
      "required": [
        "configMap",
        "ca",
        "k2hr3Token"
      ]
    },

    "k8s": {
      "description": "[optional] Set the information for the kubernetes cluster in which will be deployed the K2HDKC cluster.",
      "type": "object",
      "properties": {
        "namespace": {
          "description": "[optional] Specify the kubernetes namespace to deploy K2HDKC cluster, default is empty. If not set, use Release.Namespace.",
          "type": "string"
        },
        "domain": {
          "description": "[optional] Specify the domain name of the kubernetes cluster to deploy K2HDKC cluster, default is svc.cluster.local.",
          "type": "string"
        }
      },
      "required": [
        "namespace",
        "domain"
      ]
    },

    "unconvertedFiles": {
      "description": "[optional] Specify the files(unconverted) to be placed in configmap.",
      "type": "object",
      "properties": {
        "dbaas": {
          "description": "[optional] Specify an array of files(unconverted) for K2HDKC cluster.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "description": "[required] Specify the filename.",
                "type": "string",
                "minLength": 1
              },
              "path": {
                "description": "[required] Specify the path of the file to upload.",
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "path"
            ]
          }
        }
      },
      "required": [
        "dbaas"
      ]
    }
  },
  "required": [
    "antpickax",
    "dbaas",
    "k2hr3",
    "mountPoint",
    "k8s",
    "unconvertedFiles"
  ]
}