Skip to content

Commit b898c18

Browse files
authored
Additional Knative documentation (#396)
1 parent 2a08963 commit b898c18

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

internal/doc/draft-user-guide-v1.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -555,8 +555,13 @@ By setting the `.spec.createKnativeService` field, the operator creates a Knativ
555555

556556
The CRD fields which are used to populate the Knative service resource include `.spec.applicationImage`, `.spec.serviceAccountName`, `.spec.probes.liveness`, `.spec.probes.readiness`, `.spec.service.Port`, `.spec.volumes`, `.spec.volumeMounts`, `.spec.env`, `.spec.envFrom`, `.spec.pullSecret` and `.spec.pullPolicy`. Startup probe is not fully supported by Knative, hence `.spec.probes.startup` will not apply when Knative service is enabled.
557557

558+
When using private registries with Knative / OpenShift Serverless `.spec.pullSecret` must be specified. OpenShift global
559+
pull secret can not be used to provide registry credentials to Knative Services.
560+
558561
For more details on how to configure Knative for tasks such as enabling HTTPS connections and setting up a custom domain, checkout link:++https://knative.dev/docs/serving/++[Knative Documentation].
559562

563+
_Knative Serving sidecar container can only connect to the application's container over HTTP connection. Application must be listening on HTTP port to use Knative._
564+
560565
_Autoscaling related fields in `RuntimeComponent` are not used to configure Knative Pod Autoscaler (KPA). To learn more about how to configure KPA, see link:++https://knative.dev/docs/serving/configuring-the-autoscaler/++[Configuring the Autoscaler]._
561566

562567
_This feature is only available if you have Knative installed on your cluster._

internal/doc/troubleshooting.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,6 @@ available, but actual CRD (Knative Service) is not present.
143143

144144
Version 0.5.0 of operator can crash when creating Ingress with `spec.expose` is set to `true` and `spec.route` is not provided or set (nil).
145145
Possible fixes are to set `spec.route` to `{}` or disable Ingress if not used by setting `spec.expose` to `false`.
146+
147+
Knative Serving / OpenShift Serverless sidecar container can only connect to the application's container over HTTP connection. Application
148+
must be listening on HTTP port to use Knative.

0 commit comments

Comments
 (0)