Skip to content

Commit 798c3ed

Browse files
incorporate Monica's edits
1 parent 5e18ce0 commit 798c3ed

File tree

1 file changed

+31
-17
lines changed

1 file changed

+31
-17
lines changed

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Oracle is finding ways for organizations using WebLogic Server to run important
99
In addition, we've provided an open-source Oracle WebLogic Server Kubernetes Operator (the “operator”) which has several key features to assist you with deploying and managing WebLogic domains in a Kubernetes environment. You can:
1010

1111
* Create WebLogic domains on a Kubernetes persistent volume. This persistent volume can reside in an NFS.
12+
* Create a WebLogic domain in a Docker image.
13+
* Override certain aspects of the WebLogic domain configuration when it is in a Docker image.
1214
* Define WebLogic domains as a Kubernetes resource (using a Kubernetes custom resource definition).
1315
* Start servers based on declarative startup parameters and desired states.
1416
* Manage WebLogic configured or dynamic clusters.
@@ -18,7 +20,7 @@ In addition, we've provided an open-source Oracle WebLogic Server Kubernetes Ope
1820
* 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.
1921
* Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana.
2022

21-
The fastest way to experience the operator is to follow the Quick Start Guide, or you can peruse our [documentation](site), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), try out the [samples](kubernetes/samples/README.md), or check us out on our public Slack channel. To join our channel, [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/). The invitation email will include details on how to access our Slack workspace. After you are logged in, please come to #operator and say, "hello!"
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.
2224

2325

2426
# Important terms
@@ -39,11 +41,11 @@ This documentation uses several important terms which are intended to have a spe
3941

4042
# Getting started
4143

42-
Before using the operator, you might want to 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.
44+
Before using the operator, you might want to 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. Also, worth reading are the details of the [Kubernetes RBAC definitions](site/rbac.md) required by the operator.
4345

4446
## Prerequisites
4547

46-
* Kubernetes 1.9.0+, 1.10.0, 1.11.0 (check with `kubectl version`).
48+
* Kubernetes 1.10+, 1.11+, and 1.12.0+ (check with `kubectl version`).
4749
* Flannel networking v0.9.1-amd64 (check with `docker images | grep flannel`)
4850
* Docker 17.03.1.ce (check with `docker version`)
4951
* Oracle WebLogic Server 12.2.1.3.0
@@ -64,25 +66,18 @@ Use these [scripts and Helm charts](kubernetes/samples/README.md) to install Tra
6466

6567
### Configuring Kibana and Elasticsearch
6668

67-
Use this [sample script](samples/scripts/elasticsearch_and_kibana.yaml) to configure Elasticsearch and Kibana deployments and services.
69+
You can send the operator logs to Elasticsearch, to be displayed in Kibana. Use this [sample script](samples/scripts/elasticsearch_and_kibana.yaml) to configure Elasticsearch and Kibana deployments and services.
6870

6971
## Create and manage the operator
7072

71-
(Need a paragraph that describes the WebLogic Kubernetes Operator and roles including where to find the Operator image.)
73+
An operator is an application-specific controller that extends Kubernetes to create, configure, and manage instances of complex applications. The WebLogic Kubernetes Operator follows the standard Kubernetes Operator pattern, and simplifies the management and operation of WebLogic domains and deployments. You can find the operator image in [Docker Hub](https://hub.docker.com/r/oracle/weblogic-kubernetes-operator/).
7274

73-
In your Kubernetes cluster you can have one or more operators that manage one or more WebLogic domains (running in the cluster). We provide a Helm chart to create the operator. (Point to documentation and sample that describes how to do the steps below.)
75+
In your Kubernetes cluster you can have one or more operators that manage one or more WebLogic domains (running in a cluster). We provide a Helm chart to create the operator. (Point to the documentation and sample that describes how to do the steps below.)
7476

75-
### Operator details
76-
Learn more about the operator from these docs:
77-
* The [Kubernetes RBAC definitions](site/rbac.md) required by the operator.
78-
79-
* [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
80-
81-
* [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
8277

8378
### Starting the operator
8479

85-
* Create the namespace and service account for the operator
80+
* Create the namespace and service account for the operator (See the script and doc that describe how to do these.)
8681
* Edit the operator input YAML
8782
* Start the operator with a Helm chart
8883

@@ -91,7 +86,7 @@ Learn more about the operator from these docs:
9186
(images, RBAC roles, ...)
9287

9388
### Shutting down the operator
94-
89+
(See the operator sample README section that describes how to shutdown and delete all resources for the operator.)
9590

9691
## Create and manage WebLogic domains
9792

@@ -123,8 +118,8 @@ To create and manage a WebLogic domain in Kubernetes we create a deployment type
123118

124119
### Managing lifecycle operations
125120

126-
In Operator 2.0 you can perform lifecycle operations to the WebLogic servers, cluster, or domain.
127-
* Point to the documentation how to manage lifecycle operations.
121+
In Operator 2.0 you can perform lifecycle operations on WebLogic servers, clusters, or domains.
122+
* Point to the documentation on how to manage lifecycle operations.
128123

129124
### Modifying domain configurations
130125
You can modify the WebLogic domain configuration for both domain in PV and domain in image:
@@ -139,6 +134,25 @@ You can modify the WebLogic domain configuration for both domain in PV and domai
139134
### Deleting the domain
140135
(Point to sample)
141136

137+
# Developer guide
138+
139+
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 Kubernetes API.
140+
141+
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!
142+
143+
## API documentation
144+
145+
Documentation for APIs is provided here:
146+
147+
* [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
148+
149+
* [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
150+
151+
## Need more help?
152+
153+
We have a public Slack channel where you can get in touch with us to ask questions about using the operator. To join our channel, please [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/). The invitation email will include details of how to access our Slack workspace. After you are logged in, please come to #operator and say, "hello!"
154+
155+
142156
# Contributing to the operator
143157

144158
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.

0 commit comments

Comments
 (0)