Skip to content

Commit 505ef6f

Browse files
authored
Doc changes for new service account spec (#597)
1 parent 56a37cb commit 505ef6f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/user-guide-v1.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,10 @@ Each `RuntimeComponent` CR must at least specify the `.spec.applicationImage` fi
133133
| `service.portName` | The name for the port exposed by the container.
134134
| `service.targetPort` | The port that the operator assigns to containers inside pods. Defaults to the value of `service.port`.
135135
| `service.type` | The Kubernetes link:++https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types++[Service Type].
136-
| `serviceAccountName` | The name of the Red Hat OpenShift service account to be used during deployment. If a service account name is not specified, a service account is automatically created. For examples, see link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#create-a-service-account++[Create a service account].
136+
| `serviceAccountName` | Deprecated. Use link:#crd-spec-serviceAccount-name[`serviceAccount.name`] instead.
137+
| `serviceAccount`| [[crd-spec-serviceAccount-name]] The service account to use for application deployment. If a service account name is not specified, a service account is automatically created. For examples, see link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#create-a-service-account++[Configure a service account].
138+
| `serviceAccount.name` | Name of the service account to use for deploying the application.
139+
| `serviceAccount.mountToken` | A Boolean to toggle whether the service account's token should be mounted in the application pods. If unset or `true`, the token will be mounted.
137140
| `sidecarContainers` | The list of `sidecar` containers. These are additional containers to be added to the pods. Note: Sidecar containers should not be named `app`.
138141
| `statefulSet` | The wanted state and cycle of stateful applications. For examples, see link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#persist-resources++[Persist resources].
139142
| `statefulSet.annotations` | Annotations to be added only to the StatefulSet and resources owned by the StatefulSet.
@@ -279,7 +282,7 @@ Browse the `RuntimeComponent` examples to learn how to use custom resource (CR)
279282
|===
280283

281284
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#reference-image-streams++[Reference image streams (`.spec.applicationImage`)]
282-
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#create-a-service-account++[Create a service account (`.spec.serviceAccountName`)]
285+
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#create-a-service-account++[Configure a service account (`.spec.serviceAccount`)]
283286
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#add-or-change-labels++[Add or change labels (`.metadata.labels`)]
284287
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#add-annotations++[Add annotations (`.metadata.annotations`)]
285288
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#set-environment-variables-for-an-application-container++[Set environment variables for an application container (`.spec.env` or `.spec.envFrom`)]

0 commit comments

Comments
 (0)