Skip to content

Commit 7bcd24c

Browse files
authored
Merge pull request #786 from oracle/edits
clean-up odds and ends
2 parents 38eeb0a + 54b79b7 commit 7bcd24c

File tree

10 files changed

+23
-22
lines changed

10 files changed

+23
-22
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Oracle is finding ways for organizations using WebLogic Server to run important
1818
* Scale WebLogic domains by starting and stopping Managed Servers on demand, or by integrating with a REST API to initiate scaling based on WLDF, Prometheus, Grafana, or other rules.
1919
* Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana.
2020

21-
The fastest way to experience the operator is to follow the [Quick start guide](site/quickstart.md), or you can peruse our [documentation](site), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples](kubernetes/samples/README.md).
21+
The fastest way to experience the operator is to follow the [Quick Start guide](site/quickstart.md), or you can peruse our [documentation](site), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples](kubernetes/samples/README.md).
2222

2323
```diff
2424
+ The current release of the operator is 2.0-rc2, a release candidate for our 2.0 release.
@@ -54,7 +54,7 @@ maintained for one release after a replacement is available.
5454
This documentation includes sections targeted to different audiences. To help you find what you are looking for more easily,
5555
please consult this table of contents:
5656

57-
* The [Quick start guide](site/quickstart.md) explains how to quickly get the operator running, using the defaults, nothing special.
57+
* The [Quick Start guide](site/quickstart.md) explains how to quickly get the operator running, using the defaults, nothing special.
5858
* The [User guide](site/user-guide.md) contains detailed usage information, including how to install and configure the operator,
5959
and how to use it to create and manage WebLogic domains.
6060
* The [Samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform

kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ A PV and PVC can be shared by multiple WebLogic domains or dedicated to a partic
66

77
## Prerequisites
88

9-
Please read this guide before proceeding.
10-
* [Persistent Volumes](../../../../site/persistent-volumes.md)
9+
Please read the [Persistent Volumes](../../../../site/persistent-volumes.md) guide before proceeding.
1110

1211
## Using the scripts to create a PV and PVC
1312

kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The sample scripts demonstrate the creation of a WebLogic domain home in a Docke
44

55
## Prerequisites
66

7-
Before you begin, read this guide, [Domain Resource](../../../../../site/domain-resource.md)
7+
Before you begin, read this guide, [Domain Resource](../../../../../site/domain-resource.md).
88

99
The following prerequisites must be handled prior to running the create domain script:
1010
* The WDT sample requires that `JAVA_HOME` is set to a Java JDK version 1.8 or later.
@@ -306,7 +306,7 @@ Spec:
306306
Name: JAVA_OPTIONS
307307
Value: -Dweblogic.StdoutDebugEnabled=false
308308
Name: USER_MEM_ARGS
309-
Value: -Xms64m -Xmx256m
309+
Value: -Xms64m -Xmx256m
310310
Labels:
311311
Liveness Probe:
312312
Node Selector:

kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The sample scripts demonstrate the creation of a WebLogic domain home on an exis
44

55
## Prerequisites
66

7-
Before you begin, read this guide, [Domain Resource](../../../../../site/domain-resource.md)
7+
Before you begin, read this guide, [Domain Resource](../../../../../site/domain-resource.md).
88

99
The following prerequisites must be handled prior to running the create domain script:
1010
* Make sure the WebLogic operator is running.
@@ -280,7 +280,7 @@ Spec:
280280
Name: JAVA_OPTIONS
281281
Value: -Dweblogic.StdoutDebugEnabled=false
282282
Name: USER_MEM_ARGS
283-
Value: -Xms64m -Xmx256m
283+
Value: -Xms64m -Xmx256m
284284
Labels:
285285
Liveness Probe:
286286
Node Selector:

site/domain-resource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Domain resource
22

3-
In this guide, we outline how to set up and configure your own domain resource which can be used to configure your WLS domain. Then, you can use the domain resource to start the Kubernetes artifacts of the corresponding domain.
3+
In this guide, we outline how to set up and configure your own domain resource which can be used to configure your WLS domain. Then, you can use the domain resource to start the Kubernetes artifacts of the corresponding domain.
44

55
Swagger documentation is available [here](https://oracle.github.io/weblogic-kubernetes-operator/domains/index.html).
66

@@ -15,7 +15,7 @@ The following prerequisites must be fulfilled before proceeding with the creatio
1515

1616
Domain resources are defined using the domain resource YAML files. For each WLS domain you want to create and configure, you should create one domain resource YAML file and apply it. In the example below, you will find a domain resource YAML file template that you can use as a basis. Copy the template and override the default settings so that it matches all the WLS domain parameters that define your WLS domain.
1717

18-
For sample YAML templates, see the [Domain resource example](../kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/README.md)
18+
For sample YAML templates, see the [Domain resource example](../kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/README.md).
1919

2020
# Kubernetes resources
2121

site/domains.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ running in Kubernetes.
8080
administration port or a T3 channel to allow WLST access, you need to ensure that you allocate each channel a
8181
unique port number across the entire Kubernetes cluster. If you expose the administration port in each WebLogic domain in
8282
the Kubernetes cluster, then each one must have a different port. This is required because `NodePorts` are used to
83-
expose channels outside the Kubernetes cluster. **IMPORTANT:** Exposing admin, RMI, or T3 capable channels via a node port
83+
expose channels outside the Kubernetes cluster.
84+
85+
**IMPORTANT:** Exposing admin, RMI, or T3 capable channels via a node port
8486
can create an insecure configuration; in general only HTTP protocols should be made available externally and this exposure
8587
is usually accomplished by setting up an external load balancer that can access internal (non-NodePort) services.
8688
* _Host Path Persistent Volumes:_ If using a `hostPath` persistent volume, then it must be available on all worker nodes in the cluster and have read/write/many permissions for all container/pods in the WebLogic Server deployment. Be aware
@@ -118,7 +120,7 @@ More information about the Domain resource can be found [here](domain-resource.m
118120
### Managing lifecycle operations including shutting down and deleting domains
119121

120122
In Operator 2.0, you can perform lifecycle operations on WebLogic servers, clusters, or domains.
121-
See [Starting, stopping and restarting servers](server-lifecycle.md).
123+
See [Starting, stopping, and restarting servers](server-lifecycle.md).
122124

123125
### Scaling clusters
124126

site/helm-charts.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,15 +81,15 @@ The script takes the subject alternative names that should be added to the certi
8181
$ kubernetes/samples/scripts/rest/generate-external-rest-identity.sh "DNS:${HOSTNAME},DNS:localhost,IP:127.0.0.1" >> custom-values.yaml
8282
```
8383

84-
## Optional: ELK (Elasticsearch, Logstash and Kibana) integration
84+
## Optional: Elastic Stack (Elasticsearch, Logstash, and Kibana) integration
8585

86-
The operator Helm chart includes the option of installing the necessary Kubernetes resources for ELK integration.
86+
The operator Helm chart includes the option of installing the necessary Kubernetes resources for Elastic Stack integration.
8787

8888
You are responsible for configuring Kibana and Elasticsearch, then configuring the operator Helm chart to send events to Elasticsearch. In turn, the operator Helm chart configures Logstash in the operator deployment to send the operator's log contents to that Elasticsearch location.
8989

90-
### ELK per-operator configuration
90+
### Elastic Stack per-operator configuration
9191

92-
As part of the ELK integration, Logstash configuration occurs for each deployed operator instance. You can use the following configuration values to configure the integration:
92+
As part of the Elastic Stack integration, Logstash configuration occurs for each deployed operator instance. You can use the following configuration values to configure the integration:
9393

9494
* Set `elkIntegrationEnabled` is `true` to enable the integration.
9595
* Set `logStashImage` to override the default version of Logstash to be used (`logstash:6.2`).
@@ -268,11 +268,11 @@ domainNamespaces: [ "namespace1", "namespace2" ]
268268

269269
**NOTE**: These examples show two valid YAML syntax options for arrays.
270270

271-
### ELK integration
271+
### Elastic Stack integration
272272

273273
#### `elkIntegrationEnabled`
274274

275-
Specifies whether or not ELK integration is enabled.
275+
Specifies whether or not Elastic Stack integration is enabled.
276276

277277
Defaults to `false`.
278278

site/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Quick start guide
1+
# Quick Start guide
22

3-
Use this quick start guide to create a WebLogic deployment in a Kubernetes cluster with the Oracle WebLogic Kubernetes Operator. Please note that this walk-through is for demonstration purposes only, not for use in production.
3+
Use this Quick Start guide to create a WebLogic deployment in a Kubernetes cluster with the Oracle WebLogic Kubernetes Operator. Please note that this walk-through is for demonstration purposes only, not for use in production.
44
These instructions assume that you are already familiar with Kubernetes. If you need more detailed instructions, please
55
refer to the [User guide](user-guide.md).
66

site/recent-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document tracks recent changes to the operator, especially ones that introd
44

55
| Date | Version | Introduces backward incompatibilities | Change |
66
| --- | --- | --- | --- |
7-
| January 17, 2019 | v2.0-rc2 | yes | Schema updates are completed, and various bug fixes.
7+
| January 17, 2019 | v2.0-rc2 | yes | Schema updates are completed, and various bugs fixed.
88
| December 20, 2018 | v2.0-rc1 | yes | Operator is now installed via Helm charts, replacing the earlier scripts. The operator now supports the domain home on persistent volume or in Docker image use cases, which required a redesign of the domain schema. You can override the domain configuration using configuration override templates. Now load balancers and Ingresses can be independently configured. You can direct WebLogic logs to a persistent volume or to the pod's log. Added lifecycle support for servers and significantly enhanced configurability for generated pods. The final v2.0 release will be the initial release where the operator team intends to provide backward compatibility as part of future releases.
99
| March 20, 2018 | v1.1 | yes | Several files and input parameters have been renamed. This affects how operators and domains are created. It also changes generated Kubernetes artifacts, therefore customers must recreate their operators and domains.
1010
| April 4, 2018 | v1.0 | yes | Many Kubernetes artifact names and labels have changed. Also, the names of generated YAML files for creating a domain's PV and PVC have changed. Because of these changes, customers must recreate their operators and domains.

site/weblogic-docker-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ There are two main options available:
1010

1111
If you want to use the first option, you will need to obtain the standard
1212
WebLogic Server image from the Docker Store, [see here](#obtaining-standard-images-from-the-docker-store),
13-
and then create a new image with the mandatory patches applied as described in [this section](#creating-a-custom-images-with-patches-applied).
13+
and then create a new image with the mandatory patches applied as described in [this section](#creating-a-custom-image-with-patches-applied).
1414
If you want to use additional patches, you can customize that process to include additional patches.
1515

1616
If you want to use the second option, which includes the domain directory

0 commit comments

Comments
 (0)