Files
dc-kc/schemas/serving.knative.dev/domainmapping_v1beta1.json
2025-04-08 22:07:34 +01:00

161 lines
7.4 KiB
JSON

{
"description": "DomainMapping is a mapping from a custom hostname to an Addressable.",
"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": "Spec is the desired state of the DomainMapping.\nMore info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
"properties": {
"ref": {
"description": "Ref specifies the target of the Domain Mapping.\n\nThe object identified by the Ref must be an Addressable with a URL of the\nform `{name}.{namespace}.{domain}` where `{domain}` is the cluster domain,\nand `{name}` and `{namespace}` are the name and namespace of a Kubernetes\nService.\n\nThis contract is satisfied by Knative types such as Knative Services and\nKnative Routes, and by Kubernetes Services.",
"properties": {
"address": {
"description": "Address points to a specific Address Name.",
"type": "string"
},
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"group": {
"description": "Group of the API, without the version of the group. This can be used as an alternative to the APIVersion, and then resolved using ResolveGroup.\nNote: This API is EXPERIMENTAL and might break anytime. For more details: https://github.com/knative/eventing/issues/5086",
"type": "string"
},
"kind": {
"description": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/\nThis is optional field, it gets defaulted to the object holding it if left out.",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object",
"additionalProperties": false
},
"tls": {
"description": "TLS allows the DomainMapping to terminate TLS traffic with an existing secret.",
"properties": {
"secretName": {
"description": "SecretName is the name of the existing secret used to terminate TLS traffic.",
"type": "string"
}
},
"required": [
"secretName"
],
"type": "object",
"additionalProperties": false
}
},
"required": [
"ref"
],
"type": "object",
"additionalProperties": false
},
"status": {
"description": "Status is the current state of the DomainMapping.\nMore info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
"properties": {
"address": {
"description": "Address holds the information needed for a DomainMapping to be the target of an event.",
"properties": {
"CACerts": {
"description": "CACerts is the Certification Authority (CA) certificates in PEM format\naccording to https://www.rfc-editor.org/rfc/rfc7468.",
"type": "string"
},
"audience": {
"description": "Audience is the OIDC audience for this address.",
"type": "string"
},
"name": {
"description": "Name is the name of the address.",
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object",
"additionalProperties": false
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is additional Status fields for the Resource to save some\nadditional State as well as convey more information to the user. This is\nroughly akin to Annotations on any k8s resource, just the reconciler conveying\nricher information outwards.",
"type": "object"
},
"conditions": {
"description": "Conditions the latest available observations of a resource's current state.",
"items": {
"description": "Condition defines a readiness condition for a Knative resource.\nSee: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties",
"properties": {
"lastTransitionTime": {
"description": "LastTransitionTime is the last time the condition transitioned from one status to another.\nWe use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic\ndifferences (all other things held constant).",
"type": "string"
},
"message": {
"description": "A human readable message indicating details about the transition.",
"type": "string"
},
"reason": {
"description": "The reason for the condition's last transition.",
"type": "string"
},
"severity": {
"description": "Severity with which to treat failures of this type of condition.\nWhen this is not specified, it defaults to Error.",
"type": "string"
},
"status": {
"description": "Status of the condition, one of True, False, Unknown.",
"type": "string"
},
"type": {
"description": "Type of condition.",
"type": "string"
}
},
"required": [
"status",
"type"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"observedGeneration": {
"description": "ObservedGeneration is the 'Generation' of the Service that\nwas last processed by the controller.",
"format": "int64",
"type": "integer"
},
"url": {
"description": "URL is the URL of this DomainMapping.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object"
}