diff --git a/docs/reference/serving.md b/docs/reference/serving.md index d92edeb6dc2..dadfac2f1b3 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -156,6 +156,17 @@ string load balances over the pods referenced by the ScaleTargetRef.
+ProtocolType
+
+github.com/knative/serving/pkg/apis/networking.ProtocolType
+
+The application-layer protocol. Matches ProtocolType inferred from the revision spec.
ProtocolType
+
+github.com/knative/serving/pkg/apis/networking.ProtocolType
+
+The application-layer protocol. Matches ProtocolType inferred from the revision spec.
conditions
+observedGeneration
-
-github.com/knative/pkg/apis/duck/v1alpha1.Conditions
-
+int64
Conditions communicates information about ongoing/complete -reconciliation processes that bring the “spec” inline with the observed -state of the world.
+ObservedGeneration is the ‘Generation’ of the Service that +was last processed by the controller.
observedGeneration
+conditions
-int64
+
+github.com/knative/pkg/apis/duck/v1alpha1.Conditions
+
ObservedGeneration is the ‘Generation’ of the PodAutoscaler that -was last processed by the controller. The observed generation is updated -even if the controller failed to process the spec.
+Conditions the latest available observations of a resource’s current state.
+
Certificate is responsible for provisioning a SSL certificate for the +given hosts. It is a Knative abstraction for various SSL certificate +provisioning solutions (such as cert-manager or self-signed SSL certificate).
+ +| Field | +Description | +||||
|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+networking.internal.knative.dev/v1alpha1
+
+ |
+||||
+kind
+string
+ |
+Certificate |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+ Standard object’s metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of the +metadata field.
+ |
+||||
+spec
+
+
+CertificateSpec
+
+
+ |
+
+(Optional)
+ Spec is the desired state of the Certificate. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status ++ +
|
+||||
+status
+
+
+CertificateStatus
+
+
+ |
+
+(Optional)
+ Status is the current state of the Certificate. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + |
+
ClusterIngress is a collection of rules that allow inbound connections to reach the -endpoints defined by a backend. An ClusterIngress can be configured to give services -externally-reachable urls, load balance traffic offer name based virtual hosting etc.
+endpoints defined by a backend. A ClusterIngress can be configured to give services +externally-reachable URLs, load balance traffic, offer name based virtual hosting, etc.This is heavily based on K8s Ingress https://godoc.org/k8s.io/api/extensions/v1beta1#Ingress which some highlighted modifications.
@@ -421,8 +552,8 @@ not be used - use metadata.generationTLS configuration. Currently the ClusterIngress only supports a single TLS -port, 443. If multiple members of this list specify different hosts, they +
TLS configuration. Currently ClusterIngress only supports a single TLS +port: 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
@@ -475,6 +606,221 @@ More info: ServerlessService + ++
ServerlessService is a proxy for the K8s service objects containing the +endpoints for the revision, whether those are endpoints of the activator or +revision pods. +See: https://knative.page.link/naxz for details.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+networking.internal.knative.dev/v1alpha1
+
+ |
+||||||
+kind
+string
+ |
+ServerlessService |
+||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+ Standard object’s metadata. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of the +metadata field.
+ |
+||||||
+spec
+
+
+ServerlessServiceSpec
+
+
+ |
+
+(Optional)
+ Spec is the desired state of the ServerlessService. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status ++ +
|
+||||||
+status
+
+
+ServerlessServiceStatus
+
+
+ |
+
+(Optional)
+ Status is the current state of the ServerlessService. +More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status + |
+
+(Appears on: +Certificate) +
++
CertificateSpec defines the desired state of a Certificate.
| Field | +Description | +
|---|---|
+dnsNames
+
+[]string
+
+ |
+
+ DNSNames is a list of DNS names the Certificate could support. +The wildcard format of DNSNames (e.g. *.default.example.com) is supported. + |
+
+secretName
+
+string
+
+ |
+
+ SecretName is the name of the secret resource to store the SSL certificate in. + |
+
+(Appears on: +Certificate) +
++
CertificateStatus defines the observed state of a Certificate.
| Field | +Description | +
|---|---|
+Status
+
+
+github.com/knative/pkg/apis/duck/v1alpha1.Status
+
+
+ |
+
+
+(Members of |
+
+notAfter
+
+
+Kubernetes meta/v1.Time
+
+
+ |
+
+(Optional)
+ The expiration time of the TLS certificate stored in the secret named +by this resource in spec.secretName. + |
+
@@ -535,7 +881,7 @@ k8s.io/apimachinery/pkg/util/intstr.IntOrString HTTPClusterIngressPath)
-
ClusterIngressBackend describes all endpoints for a given service and port.
+ClusterIngressBackendSplit describes all endpoints for a given service and port.
|
(Optional)
- Hosts are a list of hosts included in the TLS certificate. The values in + Hosts is a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this ClusterIngress, if left unspecified. @@ -723,7 +1069,7 @@ Defaults totls.key.
HTTPClusterIngressRuleValue)
- HTTPClusterIngressPath associates a path regex with a backend. Incoming urls matching + HTTPClusterIngressPath associates a path regex with a backend. Incoming URLs matching the path are forwarded to the backend.
IngressVisibility @@ -1113,20 +1448,121 @@ bool |
-(Optional)
- MeshOnly is set if the ClusterIngress is only load-balanced through a Service mesh. +(Optional) +MeshOnly is set if the ClusterIngress is only load-balanced through a Service mesh. + |
+
+
+
+(Appears on: +IngressStatus) +
++
LoadBalancerStatus represents the status of a load-balancer.
+ +| Field | +Description | +
|---|---|
+ingress
+
+
+[]LoadBalancerIngressStatus
+
+
+ |
+
+(Optional)
+ Ingress is a list containing ingress points for the load-balancer. +Traffic intended for the service should be sent to these ingress points. + |
+
string alias)+(Appears on: +ServerlessServiceSpec) +
++
ServerlessServiceOperationMode is an enumeration of the modes of operation +for the ServerlessService.
+ ++(Appears on: +ServerlessService) +
++
ServerlessServiceSpec describes the ServerlessService.
+ +| Field | +Description | +
|---|---|
+mode
+
+
+ServerlessServiceOperationMode
+
+
+ |
+
+ Mode describes the mode of operation of the ServerlessService. + |
+
+selector
+
+map[string]string
+
+ |
+
+ Selector describes the pod labels for selection of pods for the +revision. Same as K8s service selector. +See: https://kubernetes.io/docs/concepts/services-networking/service/. + |
+
+ProtocolType
+
+github.com/knative/serving/pkg/apis/networking.ProtocolType
+
+ |
+
+ The application-layer protocol. Matches |
(Appears on: -IngressStatus) +ServerlessService)
-
LoadBalancerStatus represents the status of a load-balancer.
+ServerlessServiceStatus describes the current state of the ServerlessService.
-ingress
+Status
-
-[]LoadBalancerIngressStatus
+
+github.com/knative/pkg/apis/duck/v1alpha1.Status
|
+
+(Members of |
+
+serviceName
+
+string
+
+ |
+
(Optional)
- Ingress is a list containing ingress points for the load-balancer. -Traffic intended for the service should be sent to these ingress points. +ServiceName holds the name of a core K8s Service resource that +load balances over the pods backing this Revision (activator or revision). |
-conditions
+Status
-
-github.com/knative/pkg/apis/duck/v1alpha1.Conditions
+
+github.com/knative/pkg/apis/duck/v1alpha1.Status
|
-(Optional)
- Conditions communicates information about ongoing/complete -reconciliation processes that bring the “spec” inline with the observed -state of the world. +
+(Members of |
-latestReadyRevisionName
+ConfigurationStatusFields
-string
+
+ConfigurationStatusFields
+
|
-(Optional)
- LatestReadyRevisionName holds the name of the latest Revision stamped out -from this Configuration that has had its “Ready” condition become “True”. +
+(Members of |
+(Appears on: +ConfigurationStatus, +ServiceStatus) +
++
ConfigurationStatusFields holds all of the non-duckv1alpha1.Status status fields of a Route. +These are defined outline so that we can also inline them into Service, and more easily +copy them.
+ +| Field | +Description | +
|---|---|
-latestCreatedRevisionName
+latestReadyRevisionName
string
|
(Optional)
- LatestCreatedRevisionName is the last revision that was created from this -Configuration. It might not be ready yet, for that use LatestReadyRevisionName. +LatestReadyRevisionName holds the name of the latest Revision stamped out +from this Configuration that has had its “Ready” condition become “True”. |
-observedGeneration
+latestCreatedRevisionName
-int64
+string
|
(Optional)
- ObservedGeneration is the ‘Generation’ of the Configuration that -was last processed by the controller. The observed generation is updated -even if the controller failed to process the spec and create the Revision. +LatestCreatedRevisionName is the last revision that was created from this +Configuration. It might not be ready yet, for that use LatestReadyRevisionName. |
-serviceName
-
-string
-
- |
-
-(Optional)
- ServiceName holds the name of a core Kubernetes Service resource that -load balances over the pods backing this Revision. When the Revision -is Active, this service would be an appropriate ingress target for -targeting the revision. - |
-
-conditions
+Status
-
-github.com/knative/pkg/apis/duck/v1alpha1.Conditions
+
+github.com/knative/pkg/apis/duck/v1alpha1.Status
|
-(Optional)
- Conditions communicates information about ongoing/complete -reconciliation processes that bring the “spec” inline with the observed -state of the world. +
+(Members of |
-observedGeneration
+serviceName
-int64
+string
|
(Optional)
- ObservedGeneration is the ‘Generation’ of the Configuration that -was last processed by the controller. The observed generation is updated -even if the controller failed to process the spec and create the Revision. +ServiceName holds the name of a core Kubernetes Service resource that +load balances over the pods backing this Revision. When the Revision +is Active, this service would be an appropriate ingress target for +targeting the revision. |
+Status
+
+
+github.com/knative/pkg/apis/duck/v1alpha1.Status
+
+
+ |
+
+
+(Members of |
+
+RouteStatusFields
+
+
+RouteStatusFields
+
+
+ |
+
+
+(Members of |
+
+(Appears on: +RouteStatus, +ServiceStatus) +
++
RouteStatusFields holds all of the non-duckv1alpha1.Status status fields of a Route. +These are defined outline so that we can also inline them into Service, and more easily +copy them.
+ +| Field | +Description | +
|---|---|
domain
string
@@ -2788,36 +3290,6 @@ When ConfigurationName appears in the spec, this will hold the
LatestReadyRevisionName that we last observed.
|
|
-conditions
-
-
-github.com/knative/pkg/apis/duck/v1alpha1.Conditions
-
-
- |
-
-(Optional)
- Conditions communicates information about ongoing/complete -reconciliation processes that bring the “spec” inline with the observed -state of the world. - |
-
-observedGeneration
-
-int64
-
- |
-
-(Optional)
- ObservedGeneration is the ‘Generation’ of the Configuration that -was last processed by the controller. The observed generation is updated -even if the controller failed to process the spec and create the Revision. - |
-
conditions
+Status
-
-github.com/knative/pkg/apis/duck/v1alpha1.Conditions
+
+github.com/knative/pkg/apis/duck/v1alpha1.Status
domain
-
-string
-
-From RouteStatus. -Domain holds the top-level domain that will distribute traffic over the provided targets. -It generally has the form {route-name}.{route-namespace}.{cluster-level-suffix}
-domainInternal
-
-string
-
-From RouteStatus. -DeprecatedDomainInternal holds the top-level domain that will distribute traffic over the provided -targets from inside the cluster. It generally has the form -{route-name}.{route-namespace}.svc.{cluster-domain-name} -DEPRECATED: Use Address instead.
+
+(Members of Status are embedded into this type.)
+
address
+RouteStatusFields
-
-github.com/knative/pkg/apis/duck/v1alpha1.Addressable
+
+RouteStatusFields
Address holds the information needed for a Route to be the target of an event.
+
+(Members of RouteStatusFields are embedded into this type.)
+
traffic
+ConfigurationStatusFields
-
-[]TrafficTarget
+
+ConfigurationStatusFields
From RouteStatus. -Traffic holds the configured traffic distribution. -These entries will always contain RevisionName references. -When ConfigurationName appears in the spec, this will hold the -LatestReadyRevisionName that we last observed.
-latestReadyRevisionName
-
-string
-
-From ConfigurationStatus. -LatestReadyRevisionName holds the name of the latest Revision stamped out -from this Service’s Configuration that has had its “Ready” condition become “True”.
-latestCreatedRevisionName
-
-string
-
-From ConfigurationStatus. -LatestCreatedRevisionName is the last revision that was created from this Service’s -Configuration. It might not be ready yet, for that use LatestReadyRevisionName.
-observedGeneration
-
-int64
-
-ObservedGeneration is the ‘Generation’ of the Service that -was last processed by the controller.
+
+(Members of ConfigurationStatusFields are embedded into this type.)
+
(Appears on: RouteSpec, -RouteStatus, -ServiceStatus) +RouteStatusFields)
TrafficTarget holds a single entry of the routing table for a Route.
@@ -3162,10 +3562,23 @@ int This defaults to zero if unspecified.url
+
+string
+
+URL displays the URL for accessing named traffic targets. URL is displayed in +status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and +a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)
+
Generated with gen-crd-api-reference-docs
-on git commit b3c82dc7.
+on git commit 0be6e873.