Skip to content

Commit d9bc465

Browse files
authored
Merge pull request #576 from oracle/updateRMe
update README
2 parents beedb44 + d167614 commit d9bc465

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In addition, we've provided an open-source Oracle WebLogic Server Kubernetes Ope
2020
* 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.
2121
* Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana.
2222

23-
The fastest way to experience the operator is to follow the Quick Start Guide, or you can peruse our [documentation](site), read our blogs, try out the [samples](kubernetes/samples/README.md), or check us out on our public Slack channel.
23+
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, or try out the [samples](kubernetes/samples/README.md).
2424

2525

2626
# Important terms
@@ -45,7 +45,7 @@ Before using the operator, you might want to read the [design philosophy](site/d
4545

4646
## Prerequisites
4747

48-
* Kubernetes 1.10+, 1.11+, and 1.12.0+ (check with `kubectl version`).
48+
* Kubernetes 1.10.11+, 1.11.5+, and 1.12.3+ (check with `kubectl version`).
4949
* Flannel networking v0.9.1-amd64 (check with `docker images | grep flannel`)
5050
* Docker 17.03.1.ce (check with `docker version`)
5151
* Oracle WebLogic Server 12.2.1.3.0
@@ -81,7 +81,7 @@ In your Kubernetes cluster you can have one or more operators that manage one or
8181
* Edit the operator input YAML
8282
* Start the operator with a Helm chart
8383

84-
### Modifying the Operator
84+
### Modifying the operator
8585

8686
(images, RBAC roles, ...)
8787

@@ -91,16 +91,17 @@ In your Kubernetes cluster you can have one or more operators that manage one or
9191
## Create and manage WebLogic domains
9292

9393
In this version of the operator, a WebLogic domain can be persisted either to a persistent volume (PV) or in a Docker image.
94-
(We can add a paragraph that describes the pros and cons of both these approaches.)
94+
(Describe the pros and cons of both these approaches.)
9595

96-
You can create the WebLogic domain inside of a Docker image or in a PV using WebLogic Scripting Tool (WLST) or WebLogic Deploy Tooling (WDT).
97-
* Advantages of using WDT. (See samples, Domain in image WDT, Domain in image WLST, Domain in PV WDT, Domain in PV WLST)
98-
99-
(What images do we need before we get started? Operator 2.0 requires you to patch your WebLogic image 12.2.1.3 with patch #.)
10096
* WebLogic binary image when domain is persisted to a PV (as in Operator v1.1)
10197
* WebLogic domain image where the domain is persisted to a Docker image (new for Operator v2.0). The WebLogic domain image will contain the WebLogic binaries, domain configuration, and applications.
10298

103-
### Preparing the Kubernetes cluster to run the WebLogic domain
99+
You create the WebLogic domain inside of a Docker image or in a PV using WebLogic Scripting Tool (WLST) or WebLogic Deploy Tooling (WDT).
100+
* (Describe the advantages of using WDT. See samples, Domain in image WDT, Domain in image WLST, Domain in PV WDT, Domain in PV WLST.)
101+
102+
(What images do we need before we get started? Operator 2.0 requires you to patch your WebLogic image 12.2.1.3 with patch #.)
103+
104+
### Preparing the Kubernetes cluster to run WebLogic domains
104105

105106
Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
106107

@@ -110,9 +111,9 @@ Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
110111
* Optionally, [create a PV & persistent volume claim (PVC)](kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/README.md) which can hold the domain home, logs, and application binaries.
111112
* [Configure a load balancer](kubernetes/samples/charts/README.md) to manage the domains and ingresses.
112113

113-
### Creating and managing the WebLogic domain
114+
### Creating and managing WebLogic domains
114115

115-
To create and manage a WebLogic domain in Kubernetes we create a deployment type, the domain custom resource. The operator always looks at the custom resource and manages the domain deployment to adjust to the definitions in the custom resource. This custom resource can also be managed using the Kubernetes command-line interface `kubectl`.
116+
To create and manage a WebLogic domain in Kubernetes we create a deployment type, the domain custom resource. The operator introspects the custom resource and manages the domain deployment to adjust to the definitions in the custom resource. This custom resource can also be managed using the Kubernetes command-line interface `kubectl`.
116117
* (Point to documentation how to edit the domain inputs YAML and how to create the domain custom resource.)
117118
* Create Ingress controllers if you are using a load balancer that supports them, such as Traefik or Voyager.
118119

@@ -122,16 +123,16 @@ In Operator 2.0 you can perform lifecycle operations on WebLogic servers, cluste
122123
* Point to the documentation on how to manage lifecycle operations.
123124

124125
### Modifying domain configurations
125-
You can modify the WebLogic domain configuration for both domain in PV and domain in image:
126+
You can modify the WebLogic domain configuration for both the domain in PV and the domain in image:
126127

127128
* When the domain is in a PV, use WLST or WDT to change the configuration.
128-
* Use configuration overrides when using the domain in image. (Point to the documentation.)
129+
* Use configuration overrides when using the domain in image.(Check with Tom B, "The automatic and custom overrides apply to all domains - not just domain-in-image domains." Point to the documentation.)
129130

130131
### Patching WebLogic and performing application updates
131132

132-
### Shutting down the domain
133+
### Shutting down domains
133134

134-
### Deleting the domain
135+
### Deleting domains
135136
(Point to sample)
136137

137138
# Developer guide
@@ -144,7 +145,9 @@ Please take a look at our [wish list](https://github.com/oracle/weblogic-kuberne
144145

145146
Documentation for APIs is provided here:
146147

147-
* The operator provides a REST API that you can use to obtain information about the configuration and to initiate scaling actions. For details about how to use the REST APIs, see [Using the operator's REST services](site/rest.md). Also, see the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
148+
* The operator provides a REST API that you can use to obtain information about the configuration and to initiate scaling actions. For details about how to use the REST APIs, see [Using the operator's REST services](site/rest.md).
149+
150+
* See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
148151

149152
* [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
150153

@@ -154,12 +157,12 @@ We have a public Slack channel where you can get in touch with us to ask questio
154157

155158
## Recent changes
156159

157-
See [Recent changes](site/recent-changes.md) for recent changes to the operator, including any backward incompatible changes.
160+
See [Recent changes](site/recent-changes.md) for changes to the operator, including any backward incompatible changes.
158161

159162

160163
# Contributing to the operator
161164

162-
Oracle welcomes contributions to this project from anyone. Contributions may be reporting an issue with the operator, or submitting a pull request. Before embarking on significant development that may result in a large pull request, it is recommended that you create an issue and discuss the proposed changes with the existing developers first.
165+
Oracle welcomes contributions to this project from anyone. Contributions may be reporting an issue with the operator or submitting a pull request. Before embarking on significant development that may result in a large pull request, it is recommended that you create an issue and discuss the proposed changes with the existing developers first.
163166

164167
If you want to submit a pull request to fix a bug or enhance an existing feature, please first open an issue and link to that issue when you submit your pull request.
165168

0 commit comments

Comments
 (0)