Skip to content

Commit c15c3f4

Browse files
first pass edits for May release
1 parent 8413056 commit c15c3f4

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ Built with [Wercker](http://www.wercker.com)
44

55
[![wercker status](https://app.wercker.com/status/68ce42623fce7fb2e52d304de8ea7530/m/develop "wercker status")](https://app.wercker.com/project/byKey/68ce42623fce7fb2e52d304de8ea7530)
66

7-
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.
7+
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.
88

9-
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:
9+
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. This release of the Operator provides a number of features to assist with the management of WebLogic domains in a Kubernetes environment, including:
1010

11-
* A mechanism to create a WebLogic domain on a Kubernetes persistent volume
12-
* A mechanism to define a WebLogic domain as a Kubernetes resource (using a Kubernetes custom resource definition)
13-
* The ability to automatically start servers based on declarative startup parameters and desired states
14-
* The ability to automatically expose the WebLogic Server Administration Console outside the Kubernetes cluster (if desired)
15-
* The ability to automatically expose T3 channels outside the Kubernetes domain (if desired)
16-
* The ability to automatically expose HTTP paths on a WebLogic domain outside the Kubernetes domain with load balancing, and to update the load balancer when Managed Servers in the WebLogic domain are started or stopped
17-
* The ability to scale a WebLogic domain 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
11+
* A mechanism to create a WebLogic domain on a Kubernetes persistent volume.
12+
* A mechanism to define a WebLogic domain as a Kubernetes resource (using a Kubernetes custom resource definition).
13+
* The ability to automatically start servers based on declarative startup parameters and desired states.
14+
* The ability to automatically expose the WebLogic Server Administration Console outside the Kubernetes cluster (if desired).
15+
* The ability to automatically expose T3 channels outside the Kubernetes domain (if desired).
16+
* The ability to automatically expose HTTP paths on a WebLogic domain outside the Kubernetes domain with load balancing, and to update the load balancer when Managed Servers in the WebLogic domain are started or stopped.
17+
* The ability to scale a WebLogic domain 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.
1818
* The ability to publish Operator and WebLogic Server logs into ElasticSearch and interact with them in Kibana.
1919

2020
As part of Oracle’s ongoing commitment to open source in general, and to Kubernetes and the Cloud Native Computing Foundation specifically, Oracle has open sourced the Operator and is committed to enhancing it with additional features. Oracle welcomes feedback, issues, pull requests, and feature requests from the WebLogic community.
@@ -41,7 +41,7 @@ In this documentation, several important terms are used and are intended to have
4141
Before using the operator, it is highly recommended that you read the [design philosophy](site/design.md) to develop an understanding of the operator's design, and the [architectural overview](site/architecture.md) to understand its architecture, including how WebLogic domains are deployed in Kubernetes using the operator. It is also worth reading the details of the [Kubernetes RBAC definitions](site/rbac.md) required by the operator.
4242

4343
# Exposing applications outside the Kubernetes cluster
44-
The operator can configure services to expose WebLogic applications and features outside of the Kubernetes cluster. Care should be taken when exposing anything externally to ensure that the appropriate security considerations are taken into account. There is no significant difference between a WebLogic domain running in a Kubernetes cluster and a domain running in a traditional data center in this regard. The same kinds of considerations should be taken into account, for example:
44+
The operator can configure services to expose WebLogic applications and features outside of the Kubernetes cluster. Care should be taken when exposing anything externally to ensure that the appropriate security considerations are taken into account. In this regard, there is no significant difference between a WebLogic domain running in a Kubernetes cluster and a domain running in a traditional data center. The same kinds of considerations should be taken into account, for example:
4545

4646
* Only expose those protocols and ports that need to be exposed.
4747
* Use secure protocols (HTTPS, T3S, and such).
@@ -68,12 +68,11 @@ The Oracle WebLogic Server Kubernetes Operator has the following requirements:
6868

6969
# Restrictions
7070

71-
The following features are not certified or supported in the Technology Preview release at the time of writing:
71+
The following features are not certified or supported in this release:
7272

7373
* Whole Server Migration
7474
* Consensus Leasing
7575
* Node Manager (although it is used internally for the liveness probe and to start WebLogic Server instances)
76-
* Dynamic domains (the current certification only covers configured clusters; certification of dynamic clusters is planned at a future date)
7776
* Multicast
7877
* If using a `hostPath` persistent volume, then it must have read/write/many permissions for all container/pods in the WebLogic Server deployment
7978
* Multitenancy
@@ -97,9 +96,9 @@ If you would rather see the developers demonstrating the operator rather than re
9796

9897
* [Installing the operator](https://youtu.be/B5UmY2xAJnk) includes the installation and also shows using the operator's REST API.
9998
* [Creating a WebLogic domain with the operator](https://youtu.be/Ey7o8ldKv9Y) shows the creation of two WebLogic domains including accessing the Administration Console and looking at the various resources created in Kubernetes - services, Ingresses, pods, load balancers, and such.
100-
* [Deploying a web application, scaling a WebLogic cluster with the operator and verifying load balancing](https://youtu.be/hx4OPhNFNDM)
99+
* [Deploying a web application, scaling a WebLogic cluster with the operator and verifying load balancing](https://youtu.be/hx4OPhNFNDM).
101100
* [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.
102-
* [Scaling a WebLogic cluster with WLDF](https://youtu.be/Q8iZi2e9HvU)
101+
* [Scaling a WebLogic cluster with WLDF](https://youtu.be/Q8iZi2e9HvU).
103102
* Watch this space, more to come!
104103

105104
Like what you see? Read on for all the nitty-gritty details...
@@ -125,7 +124,7 @@ All of the [installation steps are explained in detail here](site/installation.m
125124

126125
## Using the operator's REST services
127126

128-
The operator provides a REST API that can be used to obtain information about the configuration and to initiate scaling actions. Please refer to [Using the operator's REST services](site/rest.md) for details about how to use the REST APIs.
127+
The operator provides a REST API that you can use to obtain information about the configuration and to initiate scaling actions. Please refer to [Using the operator's REST services](site/rest.md) for details about how to use the REST APIs.
129128

130129
## Creating a WebLogic domain with the operator
131130

@@ -158,14 +157,14 @@ Please refer to [Shutting down a domain](site/shutdown-domain.md) for informatio
158157

159158
## Load balancing with the Traefik Ingress controller
160159

161-
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.
162-
Please refer to [Load balancing with Traefik](site/traefik.md) for information about current capabilities.
160+
This release of the operator supports only the Traefik load balancer/Ingress controller. Support for other load balancers is planned in the future.
161+
Please refer to [Load balancing with Traefik](site/traefik.md) for information about the current capabilities.
163162

164163
[comment]: # (Exporting operator logs to ELK. The operator provides an option to export its log files to the ELK stack. Please refer to [ELK integration]site/elk.md for information about this capability.)
165164

166165
## Removing a domain
167166

168-
To permanently remove a domain from a Kubernetes cluster, first shut down the domain using the instructions provided above in the section titled “Shutting down a domain, then remove the persistent volume claim and the persistent volume using these commands:
167+
To permanently remove a domain from a Kubernetes cluster, first shut down the domain using the instructions provided in [Shutting down a domain](site/shutdown-domain.md), then remove the persistent volume claim and the persistent volume using these commands:
169168

170169
```
171170
kubectl delete pvc PVC-NAME -n NAMESPACE
@@ -193,7 +192,7 @@ To remove more than one operator, repeat these steps for each operator namespace
193192

194193
# Recent changes
195194

196-
See [Recent changes](site/recent-changes.md) for recent changes to the operator, including any backwards incompatible changes.
195+
See [Recent changes](site/recent-changes.md) for recent changes to the operator, including any backward incompatible changes.
197196

198197

199198
# Developer guide
@@ -214,7 +213,7 @@ If you have any questions about a possible submission, feel free to open an issu
214213

215214
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).
216215

217-
For pull requests to be accepted, the bottom of the commit message must have the following line using the contributor’s name and e-mail address as it appears in the OCA Signatories list.
216+
For pull requests to be accepted, the bottom of the commit message must have the following line, using the contributor’s name and e-mail address as it appears in the OCA Signatories list.
218217

219218
```
220219
Signed-off-by: Your Name <[email protected]>
@@ -231,7 +230,7 @@ Only pull requests from committers that can be verified as having signed the OCA
231230
## Pull request process
232231

233232
* Fork the repository.
234-
* Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, e.g. `1234-fixes`.
233+
* Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, for example, `1234-fixes`.
235234
* Ensure that any documentation is updated with the changes that are required by your fix.
236235
* Ensure that any samples are updated if the base image has been changed.
237236
* Submit the pull request. Do not leave the pull request blank. Explain exactly what your changes are meant to do and provide simple steps on how to validate your changes. Ensure that you reference the issue you created as well. We will assign the pull request to 2-3 people for review before it is merged.

0 commit comments

Comments
 (0)