Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #416

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update documentation #416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/user-guide-v1beta2.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Each `RuntimeComponent` CR must at least specify the `.spec.applicationImage` fi
| `initContainers` | The list of link:++https://v1-17.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#container-v1-core++[Init Container] definitions.
| `sidecarContainers` | The list of `sidecar` containers. These are additional containers to be added to the pods. Note: Sidecar containers should not be named `app`.
| `service.bindable` | A boolean to toggle whether the operator expose the application as a bindable service. The default value for this field is `false`.
| `service.port` | The port exposed by the container.
| `service.port` | The primary port exposed by the container. If not specified, the default is `8080`. See link:++#service-ports++[Service ports] for more info.
| `service.targetPort` | The port that the operator assigns to containers inside pods. Defaults to the value of `service.port`.
| `service.portName` | The name for the port exposed by the container.
| `service.ports` | An array consisting of service ports.
Expand Down Expand Up @@ -106,7 +106,7 @@ Each `RuntimeComponent` CR must at least specify the `.spec.applicationImage` fi
| `route.annotations` | Annotations to be added to the Route.
| `route.host` | Hostname to be used for the Route.
| `route.path` | Path to be used for Route.
| `route.pathType` | Path type to be used. Required field for Ingress. See link:++https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types++[Ingress path types].
| `route.pathType` | Path type to be used. If not specified, the default is `ImplementationSpecific`. See link:++https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types++[Ingress path types].
| `route.termination` | TLS termination policy. Can be one of `edge`, `reencrypt` and `passthrough`.
| `route.insecureEdgeTerminationPolicy` | HTTP traffic policy with TLS enabled. Can be one of `Allow`, `Redirect` and `None`.
| `route.certificateSecretRef` | A name of a secret that already contains TLS key, certificate and CA to be used in the route. It can also contain destination CA certificate. The following keys are valid in the secret: `ca.crt`, `destCA.crt`, `tls.crt`, and `tls.key`.
Expand Down