You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-18Lines changed: 21 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ In addition, we've provided an open-source Oracle WebLogic Server Kubernetes Ope
20
20
* 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.
21
21
* Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana.
22
22
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).
24
24
25
25
26
26
# Important terms
@@ -45,7 +45,7 @@ Before using the operator, you might want to read the [design philosophy](site/d
45
45
46
46
## Prerequisites
47
47
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`).
@@ -81,7 +81,7 @@ In your Kubernetes cluster you can have one or more operators that manage one or
81
81
* Edit the operator input YAML
82
82
* Start the operator with a Helm chart
83
83
84
-
### Modifying the Operator
84
+
### Modifying the operator
85
85
86
86
(images, RBAC roles, ...)
87
87
@@ -91,16 +91,17 @@ In your Kubernetes cluster you can have one or more operators that manage one or
91
91
## Create and manage WebLogic domains
92
92
93
93
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.)
95
95
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 #.)
100
96
* WebLogic binary image when domain is persisted to a PV (as in Operator v1.1)
101
97
* 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.
102
98
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
104
105
105
106
Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
106
107
@@ -110,9 +111,9 @@ Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
110
111
* 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.
111
112
*[Configure a load balancer](kubernetes/samples/charts/README.md) to manage the domains and ingresses.
112
113
113
-
### Creating and managing the WebLogic domain
114
+
### Creating and managing WebLogic domains
114
115
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`.
116
117
* (Point to documentation how to edit the domain inputs YAML and how to create the domain custom resource.)
117
118
* Create Ingress controllers if you are using a load balancer that supports them, such as Traefik or Voyager.
118
119
@@ -122,16 +123,16 @@ In Operator 2.0 you can perform lifecycle operations on WebLogic servers, cluste
122
123
* Point to the documentation on how to manage lifecycle operations.
123
124
124
125
### 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:
126
127
127
128
* 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.)
129
130
130
131
### Patching WebLogic and performing application updates
131
132
132
-
### Shutting down the domain
133
+
### Shutting down domains
133
134
134
-
### Deleting the domain
135
+
### Deleting domains
135
136
(Point to sample)
136
137
137
138
# Developer guide
@@ -144,7 +145,9 @@ Please take a look at our [wish list](https://github.com/oracle/weblogic-kuberne
144
145
145
146
Documentation for APIs is provided here:
146
147
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.
148
151
149
152
*[Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
150
153
@@ -154,12 +157,12 @@ We have a public Slack channel where you can get in touch with us to ask questio
154
157
155
158
## Recent changes
156
159
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.
158
161
159
162
160
163
# Contributing to the operator
161
164
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.
163
166
164
167
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.
0 commit comments