connection_v1alpha1.json

{
  "description": "Connection is the Schema for the connections API. It is used to configure connection strings for the applications connecting to MariaDB.",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "ConnectionSpec defines the desired state of Connection",
      "properties": {
        "database": {
          "description": "Database to use when configuring the Connection.",
          "type": "string"
        },
        "healthCheck": {
          "description": "HealthCheck to be used in the Connection.",
          "properties": {
            "interval": {
              "description": "Interval used to perform health checks.",
              "type": "string"
            },
            "retryInterval": {
              "description": "RetryInterval is the interval used to perform health check retries.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "host": {
          "description": "Host to connect to. If not provided, it defaults to the MariaDB host or to the MaxScale host.",
          "type": "string"
        },
        "mariaDbRef": {
          "description": "MariaDBRef is a reference to the MariaDB to connect to. Either MariaDBRef or MaxScaleRef must be provided.",
          "properties": {
            "name": {
              "type": "string"
            },
            "namespace": {
              "type": "string"
            },
            "waitForIt": {
              "default": true,
              "description": "WaitForIt indicates whether the controller using this reference should wait for MariaDB to be ready.",
              "type": "boolean"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "maxScaleRef": {
          "description": "MaxScaleRef is a reference to the MaxScale to connect to. Either MariaDBRef or MaxScaleRef must be provided.",
          "properties": {
            "name": {
              "type": "string"
            },
            "namespace": {
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "params": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Params to be used in the Connection.",
          "type": "object"
        },
        "passwordSecretKeyRef": {
          "description": "PasswordSecretKeyRef is a reference to the password to use for configuring the Connection.\nEither passwordSecretKeyRef or tlsClientCertSecretRef must be provided as client credentials.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the password.",
          "properties": {
            "key": {
              "type": "string"
            },
            "name": {
              "default": "",
              "type": "string"
            }
          },
          "required": [
            "key"
          ],
          "type": "object",
          "x-kubernetes-map-type": "atomic",
          "additionalProperties": false
        },
        "port": {
          "description": "Port to connect to. If not provided, it defaults to the MariaDB port or to the first MaxScale listener.",
          "format": "int32",
          "type": "integer"
        },
        "secretName": {
          "description": "SecretName to be used in the Connection.",
          "type": "string"
        },
        "secretTemplate": {
          "description": "SecretTemplate to be used in the Connection.",
          "properties": {
            "databaseKey": {
              "description": "DatabaseKey to be used in the Secret.",
              "type": "string"
            },
            "format": {
              "description": "Format to be used in the Secret.",
              "type": "string"
            },
            "hostKey": {
              "description": "HostKey to be used in the Secret.",
              "type": "string"
            },
            "key": {
              "description": "Key to be used in the Secret.",
              "type": "string"
            },
            "metadata": {
              "description": "Metadata to be added to the Secret object.",
              "properties": {
                "annotations": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "description": "Annotations to be added to children resources.",
                  "type": "object"
                },
                "labels": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "description": "Labels to be added to children resources.",
                  "type": "object"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "passwordKey": {
              "description": "PasswordKey to be used in the Secret.",
              "type": "string"
            },
            "portKey": {
              "description": "PortKey to be used in the Secret.",
              "type": "string"
            },
            "usernameKey": {
              "description": "UsernameKey to be used in the Secret.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "serviceName": {
          "description": "ServiceName to be used in the Connection.",
          "type": "string"
        },
        "tlsClientCertSecretRef": {
          "description": "TLSClientCertSecretRef is a reference to a Kubernetes TLS Secret used as authentication when checking the connection health.\nEither passwordSecretKeyRef or tlsClientCertSecretRef must be provided as client credentials.\nIf not provided, the client certificate provided by the referred MariaDB is used if TLS is enabled.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the client certificate.",
          "properties": {
            "name": {
              "default": "",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "username": {
          "description": "Username to use for configuring the Connection.",
          "type": "string"
        }
      },
      "required": [
        "username"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "ConnectionStatus defines the observed state of Connection",
      "properties": {
        "conditions": {
          "description": "Conditions for the Connection object.",
          "items": {
            "description": "Condition contains details for one aspect of the current state of this API Resource.",
            "properties": {
              "lastTransitionTime": {
                "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.",
                "format": "date-time",
                "type": "string"
              },
              "message": {
                "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
                "maxLength": 32768,
                "type": "string"
              },
              "observedGeneration": {
                "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
                "format": "int64",
                "minimum": 0,
                "type": "integer"
              },
              "reason": {
                "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
                "maxLength": 1024,
                "minLength": 1,
                "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
                "type": "string"
              },
              "status": {
                "description": "status of the condition, one of True, False, Unknown.",
                "enum": [
                  "True",
                  "False",
                  "Unknown"
                ],
                "type": "string"
              },
              "type": {
                "description": "type of condition in CamelCase or in foo.example.com/CamelCase.",
                "maxLength": 316,
                "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
                "type": "string"
              }
            },
            "required": [
              "lastTransitionTime",
              "message",
              "reason",
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}