GafaelfawrIngressRule

pydantic model gafaelfawr.models.kubernetes.GafaelfawrIngressRule

A routing rule for an ingress.

Parameters:

data (Any)

Show JSON schema

{
   "title": "GafaelfawrIngressRule",
   "description": "A routing rule for an ingress.",
   "type": "object",
   "properties": {
      "host": {
         "title": "Host",
         "type": "string"
      },
      "http": {
         "$ref": "#/$defs/GafaelfawrIngressRuleHTTP"
      }
   },
   "$defs": {
      "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"
      },
      "GafaelfawrIngressRuleHTTP": {
         "description": "Routing rules for HTTP access.",
         "properties": {
            "paths": {
               "items": {
                  "$ref": "#/$defs/GafaelfawrIngressPath"
               },
               "title": "Paths",
               "type": "array"
            }
         },
         "required": [
            "paths"
         ],
         "title": "GafaelfawrIngressRuleHTTP",
         "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": [
      "host",
      "http"
   ]
}

Fields:

• host (str)

• http (gafaelfawr.models.kubernetes.GafaelfawrIngressRuleHTTP)

field host: str [Required]

Hostname to which to attach the rule.

field http: GafaelfawrIngressRuleHTTP [Required]

Path routing rules for this host.

to_kubernetes()

Convert to the Kubernetes API object.

Return type:

V1IngressRule