GafaelfawrIngressTemplate

pydantic model gafaelfawr.models.kubernetes.GafaelfawrIngressTemplate

Template for Ingress created from GafaelfawrIngress resource.

Parameters:

data (Any)

Show JSON schema
{
   "title": "GafaelfawrIngressTemplate",
   "description": "Template for ``Ingress`` created from ``GafaelfawrIngress`` resource.",
   "type": "object",
   "properties": {
      "metadata": {
         "$ref": "#/$defs/GafaelfawrIngressMetadata"
      },
      "spec": {
         "$ref": "#/$defs/GafaelfawrIngressSpec"
      }
   },
   "$defs": {
      "GafaelfawrIngressMetadata": {
         "description": "Metadata used to create an ``Ingress`` object.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "annotations": {
               "additionalProperties": {
                  "type": "string"
               },
               "title": "Annotations",
               "type": "object"
            },
            "labels": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Labels"
            }
         },
         "required": [
            "name"
         ],
         "title": "GafaelfawrIngressMetadata",
         "type": "object"
      },
      "GafaelfawrIngressPath": {
         "description": "A path routing rule for an ingress.",
         "properties": {
            "path": {
               "title": "Path",
               "type": "string"
            },
            "pathType": {
               "$ref": "#/$defs/PathType"
            },
            "backend": {
               "$ref": "#/$defs/GafaelfawrIngressPathBackend"
            }
         },
         "required": [
            "path",
            "pathType",
            "backend"
         ],
         "title": "GafaelfawrIngressPath",
         "type": "object"
      },
      "GafaelfawrIngressPathBackend": {
         "description": "Backend that serves a given path.",
         "properties": {
            "service": {
               "$ref": "#/$defs/GafaelfawrIngressPathService"
            }
         },
         "required": [
            "service"
         ],
         "title": "GafaelfawrIngressPathBackend",
         "type": "object"
      },
      "GafaelfawrIngressPathService": {
         "description": "Service that serves a given path.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "port": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GafaelfawrServicePortName"
                  },
                  {
                     "$ref": "#/$defs/GafaelfawrServicePortNumber"
                  }
               ],
               "title": "Port"
            }
         },
         "required": [
            "name",
            "port"
         ],
         "title": "GafaelfawrIngressPathService",
         "type": "object"
      },
      "GafaelfawrIngressRule": {
         "description": "A routing rule for an ingress.",
         "properties": {
            "host": {
               "title": "Host",
               "type": "string"
            },
            "http": {
               "$ref": "#/$defs/GafaelfawrIngressRuleHTTP"
            }
         },
         "required": [
            "host",
            "http"
         ],
         "title": "GafaelfawrIngressRule",
         "type": "object"
      },
      "GafaelfawrIngressRuleHTTP": {
         "description": "Routing rules for HTTP access.",
         "properties": {
            "paths": {
               "items": {
                  "$ref": "#/$defs/GafaelfawrIngressPath"
               },
               "title": "Paths",
               "type": "array"
            }
         },
         "required": [
            "paths"
         ],
         "title": "GafaelfawrIngressRuleHTTP",
         "type": "object"
      },
      "GafaelfawrIngressSpec": {
         "description": "Template for ``spec`` portion of ``Ingress`` resource.",
         "properties": {
            "rules": {
               "items": {
                  "$ref": "#/$defs/GafaelfawrIngressRule"
               },
               "title": "Rules",
               "type": "array"
            },
            "tls": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GafaelfawrIngressTLS"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tls"
            }
         },
         "required": [
            "rules"
         ],
         "title": "GafaelfawrIngressSpec",
         "type": "object"
      },
      "GafaelfawrIngressTLS": {
         "description": "A TLS certificate rule for an ingress.",
         "properties": {
            "hosts": {
               "items": {
                  "type": "string"
               },
               "title": "Hosts",
               "type": "array"
            },
            "secretName": {
               "title": "Secretname",
               "type": "string"
            }
         },
         "required": [
            "hosts",
            "secretName"
         ],
         "title": "GafaelfawrIngressTLS",
         "type": "object"
      },
      "GafaelfawrServicePortName": {
         "additionalProperties": false,
         "description": "Port for a service.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "name"
         ],
         "title": "GafaelfawrServicePortName",
         "type": "object"
      },
      "GafaelfawrServicePortNumber": {
         "additionalProperties": false,
         "description": "Port for a service.",
         "properties": {
            "number": {
               "title": "Number",
               "type": "integer"
            }
         },
         "required": [
            "number"
         ],
         "title": "GafaelfawrServicePortNumber",
         "type": "object"
      },
      "PathType": {
         "description": "Matching types for paths in ingress rules.",
         "enum": [
            "Exact",
            "ImplementationSpecific",
            "Prefix"
         ],
         "title": "PathType",
         "type": "string"
      }
   },
   "required": [
      "metadata",
      "spec"
   ]
}

Fields:
field metadata: GafaelfawrIngressMetadata [Required]

Template for the metadata of the created Ingress.

field spec: GafaelfawrIngressSpec [Required]

Template for the spec of the created Ingress.