Skip to content

Commit a24824f

Browse files
authored
Merge pull request #35 from oracle/patt/more-copy-edits
Minor copy edits to the latest additions
2 parents 270eae3 + e739cd5 commit a24824f

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Oracle WebLogic Server Kubernetes Operator
22

3-
Built with [Wercker](http://www.wercker.com)
3+
Built with [Wercker](http://www.wercker.com)
44
[![wercker status](https://app.wercker.com/status/68ce42623fce7fb2e52d304de8ea7530/m/master "wercker status")](https://app.wercker.com/project/byKey/68ce42623fce7fb2e52d304de8ea7530)
5-
5+
66
Many organizations are exploring, testing, or actively moving application workloads into a cloud environment, either in house or using an external cloud provider. Kubernetes has emerged as a leading cloud platform and is seeing widespread adoption. But a new computing model does not necessarily mean new applications or workloads – many of the existing application workloads running in environments designed and built over many years, before the ‘cloud era’, are still mission critical today. As such, there is a lot of interest in moving such workloads into a cloud environment, like Kubernetes, without forcing application rewrites, retesting and additional process and cost. There is also a desire to not just run the application in the new environment, but to run it ‘well’ – to adopt some of the idioms of the new environment and to realize some of the benefits of that new environment.
77

8-
Oracle has been working with the WebLogic community to find ways to make it as easy as possible for organizations using WebLogic to run important workloads to move those workloads into the cloud. One aspect of that effort is the creation of the Oracle WebLogic Server Kubernetes Operator. The Technology Preview release of the Operator provides a number of features to assist with the management of WebLogic domains in a Kubernetes environment, including:
8+
Oracle has been working with the WebLogic community to find ways to make it as easy as possible for organizations using WebLogic Server to run important workloads to move those workloads into the cloud. One aspect of that effort is the creation of the Oracle WebLogic Server Kubernetes Operator. The Technology Preview release of the Operator provides a number of features to assist with the management of WebLogic domains in a Kubernetes environment, including:
99

1010
* A mechanism to create a WebLogic domain on a Kubernetes persistent volume,
1111
* A mechanism to define a WebLogic domain as a Kubernetes resource (using a Kubernetes custom resource definition),
@@ -64,7 +64,7 @@ The Oracle WebLogic Server Kubernetes Operator has the following requirements:
6464
* Docker 17.03.1.ce (check with `docker version`)
6565
* Oracle WebLogic Server 12.2.1.3.0
6666

67-
Note: Minikube and the embedded Kubernetes in Docker for Mac and Docker for Windows are not "supported" platforms right now, but we have done some basic testing and everything appears to work in these environments. They are probably suitable for "trying out" the operator, but if you run into issues, we would ask that you try to reproduce them on a supported environment before reporting them. Also, Calico networking appears to work in the limited testing we have done so far.
67+
**Note:** Minikube and the embedded Kubernetes in Docker for Mac and Docker for Windows are not "supported" platforms right now, but we have done some basic testing and everything appears to work in these environments. They are probably suitable for "trying out" the operator, but if you run into issues, we would ask that you try to reproduce them on a supported environment before reporting them. Also, Calico networking appears to work in the limited testing we have done so far.
6868

6969
# Restrictions
7070

@@ -79,7 +79,7 @@ The following features are not certified or supported in the Technology Preview
7979
* Multitenancy
8080
* Production redeployment
8181

82-
Please consult My Oracle Support [Doc ID 2349228.1](https://support.oracle.com/rs?type=doc&id=2349228.1) for up to date information about the features of WebLogic Server that are supported in Kubernetes environments.
82+
Please consult My Oracle Support [Doc ID 2349228.1](https://support.oracle.com/rs?type=doc&id=2349228.1) for up-to-date information about the features of WebLogic Server that are supported in Kubernetes environments.
8383

8484
# API documentation
8585

@@ -96,9 +96,9 @@ Documentation for APIs is provided here:
9696
If you would rather see the developers demonstrating the operator rather than reading the documentation, then here are your videos:
9797

9898
* [Installing the operator](https://youtu.be/B5UmY2xAJnk) includes the installation and also shows using the operator's REST API.
99-
* [Creating a WebLogic domain with the operator](https://youtu.be/Ey7o8ldKv9Y) shows creation of two WebLogic domains including accessing the administration console and looking at the various resources created in Kubernetes - services, ingresses, pods, load balancers, etc.
99+
* [Creating a WebLogic domain with the operator](https://youtu.be/Ey7o8ldKv9Y) shows creation of two WebLogic domains including accessing the administration console and looking at the various resources created in Kubernetes - services, Ingresses, pods, load balancers, etc.
100100
* [Deploying a web application, scaling a WebLogic cluster with the operator and verifying load balancing](https://youtu.be/hx4OPhNFNDM)
101-
* [Using WLST against a domain running in Kubernetes](https://youtu.be/eY-KXEk8rI4), this example shows how to create a data source for an Oracle database that is also running in Kubernetes.
101+
* [Using WLST against a domain running in Kubernetes](https://youtu.be/eY-KXEk8rI4) shows how to create a data source for an Oracle database that is also running in Kubernetes.
102102
* [Scaling a WebLogic cluster with WLDF](https://youtu.be/Q8iZi2e9HvU)
103103
* [Prometheus integration](https://youtu.be/D7KWVXzzqx8) including exporting WebLogic Server metrics to Prometheus and creating a Prometheus alert to trigger scaling
104104
* [Shutting down a domain](#)
@@ -140,15 +140,15 @@ If preferred, a domain can be created manually, i.e. without using the scripts p
140140

141141
## Exporting WebLogic metrics to Prometheus
142142

143-
When using the operator to manage WebLogic domains, it may also be desirable to export WebLogic Server metrics to Prometheus using the [WLS Exporter](https://github.com/oracle/weblogic-monitoring-exporter) which allows metrics to be displayed in Grafana, and permits the creation of alerts and initiation of scaling actions from Prometheus alerts. Please refer to [Prometheus integration](site/prometheus.md) for more information.
143+
When using the operator to manage WebLogic domains, it may also be desirable to export WebLogic Server metrics to Prometheus using the [WLS Exporter](https://github.com/oracle/weblogic-monitoring-exporter), which allows metrics to be displayed in Grafana, and permits the creation of alerts and initiation of scaling actions from Prometheus alerts. Please refer to [Prometheus integration](site/prometheus.md) for more information.
144144

145145
## Starting up the domain
146146

147147
The operator will automatically start up domains that it is aware of, based on the configuration in the domain custom resource. Please refer to [Startup up a WebLogic domain](site/starting-domain.md) for details.
148148

149149
## Using WLST
150150

151-
When creating a domain there is an option to expose a T3 channel outside of the Kubernetes cluster to allow remote WLST access. Please refer to [Using WLST](site/wlst.md) for more information about how to use WLST with a domain running in Kubernetes.
151+
When creating a domain, there is an option to expose a T3 channel outside of the Kubernetes cluster to allow remote WLST access. Please refer to [Using WLST](site/wlst.md) for more information about how to use WLST with a domain running in Kubernetes.
152152

153153
## Scaling a cluster
154154

@@ -167,7 +167,7 @@ Please refer to [Shutting down a domain](site/shutdown-domain.md) for informatio
167167

168168
## Load balancing with the Traefik ingress controller
169169

170-
The initial "Technology Preview" release of the operator supports only the Traefik load balancer/ingress controller. Support for other load balancers is planned in the future.
170+
The initial Technology Preview release of the operator supports only the Traefik load balancer/Ingress controller. Support for other load balancers is planned in the future.
171171
Please refer to [Load balancing with the Traefik ingress controller](site/traefik.md) for information about current capabilities.
172172

173173
## Exporting operator logs to ELK
@@ -186,7 +186,7 @@ kubectl delete pv PV-NAME
186186

187187
Find the names of the persistent volume claim and the persistent volume in the domain custom resource YAML file, or if it is not available, check for the `domainUID` in the metadata on the persistent volumes.
188188

189-
To permanently delete the actual domain configuration, delete the physical volume using the appropriate tools. For example, if the persistent volume used the `HostPath provider`, delete the corresponding directory on the Kubernetes master.
189+
To permanently delete the actual domain configuration, delete the physical volume using the appropriate tools. For example, if the persistent volume used the `HostPath provider`, then delete the corresponding directory on the Kubernetes master.
190190

191191
Be aware that there may be metric data from the domain in Prometheus if this option was used. These data will need to be deleted separately, if desired.
192192

@@ -205,11 +205,11 @@ Replace `NAMESPACE` with the namespace that the operator is running in.
205205
To remove more than one operator, repeat these steps for each operator namespace.
206206

207207

208-
# Developer Guide
208+
# Developer guide
209209

210-
Developers interested in this project are encouraged to read the [Developer guide](site/developer.md) to learn how to build the project, run tests, etc. The Developer guide also provides details about the structure of the code, coding standards, and the Asynchronous Call facility used in the code to manage calls to the Kuberentes API.
210+
Developers interested in this project are encouraged to read the [Developer guide](site/developer.md) to learn how to build the project, run tests, and so on. The Developer guide also provides details about the structure of the code, coding standards, and the Asynchronous Call facility used in the code to manage calls to the Kuberentes API.
211211

212-
Please take a look at our [wish list](https://github.com/oracle/weblogic-kubernetes-operator/wiki/Wish-list) to get an idea of what kind of features we would like to add to the operator. Maybe you will see something you would like to contribute to!
212+
Please take a look at our [wish list](https://github.com/oracle/weblogic-kubernetes-operator/wiki/Wish-list) to get an idea of the kind of features we would like to add to the operator. Maybe you will see something you would like to contribute to!
213213

214214
# Contributing to the operator
215215

@@ -219,7 +219,7 @@ If you want to submit a pull request to fix a bug or enhance an existing feature
219219

220220
If you have any questions about a possible submission, feel free to open an issue too.
221221

222-
## Contributing to the Oracle Kubernetes Operator for WebLogic repository
222+
## Contributing to the Oracle WebLogic Server Kubernetes Operator repository
223223

224224
Pull requests can be made under The Oracle Contributor Agreement (OCA), which is available at [https://www.oracle.com/technetwork/community/oca-486395.html](https://www.oracle.com/technetwork/community/oca-486395.html).
225225

@@ -247,4 +247,4 @@ Only pull requests from committers that can be verified as having signed the OCA
247247

248248
## Introducing a new dependency
249249

250-
Please be aware that pull requests that seek to introduce a new dependency will be subject to additional review. In general, contributors should avoid dependencies with incompatible licenses, and should try to use recent versions of dependencies. Standard security vulnerability checklists will be consulted before accepting a new dependency. Dependencies on closed-source code, including WebLogic, will most likely be rejected.
250+
Please be aware that pull requests that seek to introduce a new dependency will be subject to additional review. In general, contributors should avoid dependencies with incompatible licenses, and should try to use recent versions of dependencies. Standard security vulnerability checklists will be consulted before accepting a new dependency. Dependencies on closed-source code, including WebLogic Server, will most likely be rejected.

0 commit comments

Comments
 (0)