From 61b3fb06ae7e97b776690aabf7ad782ccbd8841a Mon Sep 17 00:00:00 2001 From: Ian Lewis Date: Mon, 20 Nov 2023 16:35:17 +0000 Subject: [PATCH 1/2] Doc changes for new service account spec --- doc/user-guide-v1.adoc | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/user-guide-v1.adoc b/doc/user-guide-v1.adoc index 3b0bd2c61..cbca9b1f7 100755 --- a/doc/user-guide-v1.adoc +++ b/doc/user-guide-v1.adoc @@ -133,7 +133,10 @@ Each `RuntimeComponent` CR must at least specify the `.spec.applicationImage` fi | `service.portName` | The name for the port exposed by the container. | `service.targetPort` | The port that the operator assigns to containers inside pods. Defaults to the value of `service.port`. | `service.type` | The Kubernetes link:++https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types++[Service Type]. -| `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]. +| `serviceAccountName` | Deprecated. Use link:#crd-spec-serviceAccount-name[`serviceAccount.name`] instead. +| `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++[Create a service account]. +| `serviceAccount.name` | Name of the service account to use for deploying the application. +| `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. | `sidecarContainers` | The list of `sidecar` containers. These are additional containers to be added to the pods. Note: Sidecar containers should not be named `app`. | `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]. | `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) |=== * link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#reference-image-streams++[Reference image streams (`.spec.applicationImage`)] -* 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`)] +* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#create-a-service-account++[Create a service account (`.spec.serviceAccount`)] * 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`)] * link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#add-annotations++[Add annotations (`.metadata.annotations`)] * 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`)] From 5bd5ee36e68a59980c04594809ebd15440b842b7 Mon Sep 17 00:00:00 2001 From: Ian Lewis Date: Tue, 21 Nov 2023 11:06:51 +0000 Subject: [PATCH 2/2] Review comments --- doc/user-guide-v1.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/user-guide-v1.adoc b/doc/user-guide-v1.adoc index cbca9b1f7..1d05a4a74 100755 --- a/doc/user-guide-v1.adoc +++ b/doc/user-guide-v1.adoc @@ -134,7 +134,7 @@ Each `RuntimeComponent` CR must at least specify the `.spec.applicationImage` fi | `service.targetPort` | The port that the operator assigns to containers inside pods. Defaults to the value of `service.port`. | `service.type` | The Kubernetes link:++https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types++[Service Type]. | `serviceAccountName` | Deprecated. Use link:#crd-spec-serviceAccount-name[`serviceAccount.name`] instead. -| `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++[Create a service account]. +| `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]. | `serviceAccount.name` | Name of the service account to use for deploying the application. | `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. | `sidecarContainers` | The list of `sidecar` containers. These are additional containers to be added to the pods. Note: Sidecar containers should not be named `app`. @@ -282,7 +282,7 @@ Browse the `RuntimeComponent` examples to learn how to use custom resource (CR) |=== * link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#reference-image-streams++[Reference image streams (`.spec.applicationImage`)] -* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#create-a-service-account++[Create a service account (`.spec.serviceAccount`)] +* 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`)] * 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`)] * link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#add-annotations++[Add annotations (`.metadata.annotations`)] * 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`)]