Skip to content

Commit 21f3bc4

Browse files
rjeberhardrjeberhard
authored
Clarify distinction between adminServer adminService and serverService (#2288)
* Clarify distinction between adminServer adminService and serverService * Remove duplicated word
1 parent 5582842 commit 21f3bc4

File tree

10 files changed

+68
-64
lines changed

10 files changed

+68
-64
lines changed

‎documentation/3.2/content/userguide/managing-domains/domain-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ Elements related to specifying and overriding WebLogic domain configuration:
210210
Elements related to Kubernetes Pod and Service generation:
211211

212212
* `serverPod`: Customization affecting the generation of Pods for WebLogic Server instances.
213-
* `serverService`: Customization affecting the generation of Kubernetes Services for WebLogic Server instances.
213+
* `serverService`: Customization affecting the generation of ClusterIP Services for WebLogic Server instances.
214214

215215
Sub-sections related to the Administration Server, specific clusters, or specific Managed Servers:
216216

‎documentation/domains/Domain.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
]
1515
},
1616
"serverService": {
17-
"description": "Customization affecting the generation of Kubernetes Services for WebLogic Server instances.",
17+
"description": "Customization affecting the generation of ClusterIP Services for WebLogic Server instances.",
1818
"$ref": "#/definitions/ServerService"
1919
},
2020
"serverPod": {
@@ -31,7 +31,7 @@
3131
]
3232
},
3333
"adminService": {
34-
"description": "Customization affecting the generation of the Kubernetes Service for the Administration Server. These settings can also specify the creation of a second NodePort Service to expose specific channels or network access points outside the Kubernetes cluster.",
34+
"description": "Customization affecting the generation of a NodePort Service for the Administration Server used to expose specific channels or network access points outside the Kubernetes cluster. See also `domains.spec.adminServer.serverService` for configuration affecting the generation of the ClusterIP Service.",
3535
"$ref": "#/definitions/AdminService"
3636
},
3737
"restartVersion": {
@@ -51,14 +51,14 @@
5151
}
5252
},
5353
"annotations": {
54-
"description": "Annotations to associate with the Administration Server\u0027s Service(s).",
54+
"description": "Annotations to associate with the Administration Server\u0027s NodePort Service, if it is created.",
5555
"additionalProperties": {
5656
"type": "string"
5757
},
5858
"$ref": "#/definitions/Map"
5959
},
6060
"labels": {
61-
"description": "Labels to associate with the Administration Server\u0027s Service(s).",
61+
"description": "Labels to associate with the Administration Server\u0027s NodePort Service, if it is created.",
6262
"additionalProperties": {
6363
"type": "string"
6464
},
@@ -94,7 +94,7 @@
9494
]
9595
},
9696
"serverService": {
97-
"description": "Customization affecting the generation of Kubernetes Services for WebLogic Server instances.",
97+
"description": "Customization affecting the generation of ClusterIP Services for WebLogic Server instances.",
9898
"$ref": "#/definitions/ServerService"
9999
},
100100
"maxUnavailable": {
@@ -296,7 +296,7 @@
296296
"type": "string"
297297
},
298298
"serverService": {
299-
"description": "Customization affecting the generation of Kubernetes Services for WebLogic Server instances.",
299+
"description": "Customization affecting the generation of ClusterIP Services for WebLogic Server instances.",
300300
"$ref": "#/definitions/ServerService"
301301
},
302302
"domainHome": {
@@ -524,7 +524,7 @@
524524
]
525525
},
526526
"serverService": {
527-
"description": "Customization affecting the generation of Kubernetes Services for WebLogic Server instances.",
527+
"description": "Customization affecting the generation of ClusterIP Services for WebLogic Server instances.",
528528
"$ref": "#/definitions/ServerService"
529529
},
530530
"serverName": {
@@ -810,7 +810,7 @@
810810
"type": "object",
811811
"properties": {
812812
"precreateService": {
813-
"description": "If true, the operator will create Services even for Managed Server instances without running Pods.",
813+
"description": "If true, the operator will create ClusterIP Services even for WebLogic Server instances without running Pods.",
814814
"type": "boolean"
815815
},
816816
"annotations": {

‎documentation/domains/Domain.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The specification of the operation of the WebLogic domain. Required.
4141
| `replicas` | number | The default number of cluster member Managed Server instances to start for each WebLogic cluster in the domain configuration, unless `replicas` is specified for that cluster under the `clusters` field. For each cluster, the operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as "managed-server10" come after "managed-server9". The operator will then start Managed Servers from the sorted list, up to the `replicas` count, unless specific Managed Servers are specified as starting in their entry under the `managedServers` field. In that case, the specified Managed Servers will be started and then additional cluster members will be started, up to the `replicas` count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their entries under `managedServers`, then a cluster may have more cluster members running than its `replicas` count. Defaults to 0. |
4242
| `restartVersion` | string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
4343
| `serverPod` | [Server Pod](#server-pod) | Customization affecting the generation of Pods for WebLogic Server instances. |
44-
| `serverService` | [Server Service](#server-service) | Customization affecting the generation of Kubernetes Services for WebLogic Server instances. |
44+
| `serverService` | [Server Service](#server-service) | Customization affecting the generation of ClusterIP Services for WebLogic Server instances. |
4545
| `serverStartPolicy` | string | The strategy for deciding whether to start a WebLogic Server instance. Legal values are ADMIN_ONLY, NEVER, or IF_NEEDED. Defaults to IF_NEEDED. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers. |
4646
| `serverStartState` | string | The WebLogic runtime state in which the server is to be started. Use ADMIN if the server should start in the admin state. Defaults to RUNNING. |
4747
| `webLogicCredentialsSecret` | [Secret Reference](k8s1.13.5.md#secret-reference) | Reference to a Kubernetes Secret that contains the user name and password needed to boot a WebLogic Server under the `username` and `password` fields. |
@@ -65,10 +65,10 @@ The current status of the operation of the WebLogic domain. Updated automaticall
6565

6666
| Name | Type | Description |
6767
| --- | --- | --- |
68-
| `adminService` | [Admin Service](#admin-service) | Customization affecting the generation of the Kubernetes Service for the Administration Server. These settings can also specify the creation of a second NodePort Service to expose specific channels or network access points outside the Kubernetes cluster. |
68+
| `adminService` | [Admin Service](#admin-service) | Customization affecting the generation of a NodePort Service for the Administration Server used to expose specific channels or network access points outside the Kubernetes cluster. See also `domains.spec.adminServer.serverService` for configuration affecting the generation of the ClusterIP Service. |
6969
| `restartVersion` | string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
7070
| `serverPod` | [Server Pod](#server-pod) | Customization affecting the generation of Pods for WebLogic Server instances. |
71-
| `serverService` | [Server Service](#server-service) | Customization affecting the generation of Kubernetes Services for WebLogic Server instances. |
71+
| `serverService` | [Server Service](#server-service) | Customization affecting the generation of ClusterIP Services for WebLogic Server instances. |
7272
| `serverStartPolicy` | string | The strategy for deciding whether to start a WebLogic Server instance. Legal values are ALWAYS, NEVER, or IF_NEEDED. Defaults to IF_NEEDED. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers. |
7373
| `serverStartState` | string | The WebLogic runtime state in which the server is to be started. Use ADMIN if the server should start in the admin state. Defaults to RUNNING. |
7474

@@ -85,7 +85,7 @@ The current status of the operation of the WebLogic domain. Updated automaticall
8585
| `replicas` | number | The number of cluster member Managed Server instances to start for this WebLogic cluster. The operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as "managed-server10" come after "managed-server9". The operator will then start Managed Server instances from the sorted list, up to the `replicas` count, unless specific Managed Servers are specified as starting in their entry under the `managedServers` field. In that case, the specified Managed Server instances will be started and then additional cluster members will be started, up to the `replicas` count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their related entries under `managedServers`, then this cluster may have more cluster members running than its `replicas` count. Defaults to `spec.replicas`, which defaults 0. |
8686
| `restartVersion` | string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
8787
| `serverPod` | [Server Pod](#server-pod) | Customization affecting the generation of Pods for WebLogic Server instances. |
88-
| `serverService` | [Server Service](#server-service) | Customization affecting the generation of Kubernetes Services for WebLogic Server instances. |
88+
| `serverService` | [Server Service](#server-service) | Customization affecting the generation of ClusterIP Services for WebLogic Server instances. |
8989
| `serverStartPolicy` | string | The strategy for deciding whether to start a WebLogic Server instance. Legal values are NEVER, or IF_NEEDED. Defaults to IF_NEEDED. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers. |
9090
| `serverStartState` | string | The WebLogic runtime state in which the server is to be started. Use ADMIN if the server should start in the admin state. Defaults to RUNNING. |
9191

@@ -108,7 +108,7 @@ The current status of the operation of the WebLogic domain. Updated automaticall
108108
| `restartVersion` | string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
109109
| `serverName` | string | The name of the Managed Server. This name must match the name of a Managed Server instance or of a dynamic cluster member name from a server template already defined in the WebLogic domain configuration. Required. |
110110
| `serverPod` | [Server Pod](#server-pod) | Customization affecting the generation of Pods for WebLogic Server instances. |
111-
| `serverService` | [Server Service](#server-service) | Customization affecting the generation of Kubernetes Services for WebLogic Server instances. |
111+
| `serverService` | [Server Service](#server-service) | Customization affecting the generation of ClusterIP Services for WebLogic Server instances. |
112112
| `serverStartPolicy` | string | The strategy for deciding whether to start a WebLogic Server instance. Legal values are ALWAYS, NEVER, or IF_NEEDED. Defaults to IF_NEEDED. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers. |
113113
| `serverStartState` | string | The WebLogic runtime state in which the server is to be started. Use ADMIN if the server should start in the admin state. Defaults to RUNNING. |
114114

@@ -154,7 +154,7 @@ The current status of the operation of the WebLogic domain. Updated automaticall
154154
| --- | --- | --- |
155155
| `annotations` | Map | The annotations to be added to generated resources. |
156156
| `labels` | Map | The labels to be added to generated resources. The label names must not start with "weblogic.". |
157-
| `precreateService` | Boolean | If true, the operator will create Services even for Managed Server instances without running Pods. |
157+
| `precreateService` | Boolean | If true, the operator will create ClusterIP Services even for WebLogic Server instances without running Pods. |
158158

159159
### Cluster Status
160160

@@ -193,9 +193,9 @@ The current status of the operation of the WebLogic domain. Updated automaticall
193193

194194
| Name | Type | Description |
195195
| --- | --- | --- |
196-
| `annotations` | Map | Annotations to associate with the Administration Server's Service(s). |
196+
| `annotations` | Map | Annotations to associate with the Administration Server's NodePort Service, if it is created. |
197197
| `channels` | array of [Channel](#channel) | Specifies which of the Administration Server's WebLogic channels should be exposed outside the Kubernetes cluster via a NodePort Service, along with the port for each channel. If not specified, the Administration Server's NodePort Service will not be created. |
198-
| `labels` | Map | Labels to associate with the Administration Server's Service(s). |
198+
| `labels` | Map | Labels to associate with the Administration Server's NodePort Service, if it is created. |
199199

200200
### Kubernetes Resource
201201

‎documentation/staging/content/userguide/managing-domains/domain-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ Elements related to specifying and overriding WebLogic domain configuration:
210210
Elements related to Kubernetes Pod and Service generation:
211211

212212
* `serverPod`: Customization affecting the generation of Pods for WebLogic Server instances.
213-
* `serverService`: Customization affecting the generation of Kubernetes Services for WebLogic Server instances.
213+
* `serverService`: Customization affecting the generation of ClusterIP Services for WebLogic Server instances.
214214

215215
Sub-sections related to the Administration Server, specific clusters, or specific Managed Servers:
216216

0 commit comments

Comments
 (0)