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
+26-29Lines changed: 26 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ In this documentation, several important terms are used and are intended to have
43
43
44
44
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.
45
45
46
-
# Exposing applications outside the Kubernetes cluster
46
+
##Exposing applications outside the Kubernetes cluster
47
47
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:
48
48
49
49
* Only expose those protocols and ports that need to be exposed.
@@ -58,7 +58,7 @@ While it is natural to expose web applications outside the cluster, exposing adm
58
58
59
59
Oracle recommends careful consideration before deciding to expose any administrative interfaces externally.
60
60
61
-
# Requirements
61
+
##Requirements
62
62
63
63
The Oracle WebLogic Server Kubernetes Operator has the following requirements:
64
64
@@ -69,7 +69,7 @@ The Oracle WebLogic Server Kubernetes Operator has the following requirements:
69
69
70
70
**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.
71
71
72
-
# Restrictions
72
+
##Restrictions
73
73
74
74
The following features are not certified or supported in this release:
75
75
@@ -83,14 +83,6 @@ The following features are not certified or supported in this release:
83
83
84
84
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.
85
85
86
-
# API documentation
87
-
88
-
Documentation for APIs is provided here:
89
-
90
-
*[Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
91
-
92
-
*[Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
93
-
94
86
# User guide
95
87
96
88
## Prefer to see it rather than read about it?
@@ -110,7 +102,7 @@ Like what you see? Read on for all the nitty-gritty details...
110
102
111
103
Before installing the Oracle WebLogic Server Kubernetes Operator, ensure that the requirements listed above are met. If you need help setting up a Kubernetes environment, please check our [cheat sheets](site/k8s_setup.md).
112
104
113
-
The overall process of installing and configuring the operator and using it to manage WebLogic domains consists of the following steps. The provided scripts will perform most of these steps, but some must be performed manually:
105
+
The overall process of installing and configuring the operator, and using it to manage WebLogic domains, consists of the following steps:
114
106
115
107
* Registering for access to the Oracle Container Registry
116
108
* Setting up secrets to access the Oracle Container Registry
@@ -121,27 +113,27 @@ The overall process of installing and configuring the operator and using it to m
121
113
* Customizing the domain parameters file
122
114
* Creating a WebLogic domain
123
115
124
-
All of the [installation steps are explained in detail here](site/installation.md). Example files are provided in the `kubernetes` directory in this repository.
116
+
The provided scripts will perform most of these steps, but some must be performed manually. All of the [installation steps are explained in detail here](site/installation.md). Example files are provided in the `kubernetes` directory in this repository.
125
117
126
118
[comment]: #(If you need an Oracle database in your Kubernetes cluster, e.g. because your web application needs a place to keep its data, please see [this page] site/database.md for information about how to run the Oracle database in Kubernetes.)
127
119
128
-
## Using the operator's REST services
129
-
130
-
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.
131
-
132
120
## Creating a WebLogic domain with the operator
133
121
134
-
Please refer to [Creating a WebLogic domain with the operator](site/creating-domain.md) for information about how to create a WebLogic domain with the operator.
122
+
For information about how to create a WebLogic domain with the operator, see [Creating a WebLogic domain with the operator](site/creating-domain.md).
135
123
136
124
[comment]: #( Manually creating a WebLogic domain. If preferred, a domain can be created manually, i.e. without using the scripts provided with the operator. As long as the domain follows the guidelines, it can still be managed by the operator. Please refer to [Manually creating a WebLogic domain] site/manually-creating-domain.md for details. A good example of when manual domain creation may be preferred is when a user already has a set of existing WLST scripts that are used to create domains and they wish to reuse those same WLST scripts in Kubernetes, perhaps with some small modifications. )
137
125
126
+
## Using WLST
127
+
128
+
When creating a domain, there is an option to expose a T3 channel outside of the Kubernetes cluster to allow remote WLST access. For more information about how to use WLST with a domain running in Kubernetes, see [Using WLST](site/wlst.md) .
129
+
138
130
## Starting up the domain
139
131
140
-
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.
132
+
The operator will automatically start up domains that it is aware of, based on the configuration in the domain custom resource. For details, see[Startup up a WebLogic domain](site/starting-domain.md).
141
133
142
-
## Using WLST
134
+
## Using the operator's REST services
143
135
144
-
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.
136
+
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)
145
137
146
138
## Scaling a cluster
147
139
@@ -152,8 +144,7 @@ The operator provides the ability to scale up or down WebLogic clusters. There
152
144
* Using a WLDF policy rule and script action to call the operator's REST `scale` API.
153
145
* Using a Prometheus alert action to call the operator's REST `scale` API.
154
146
155
-
Please refer to [Scaling a WebLogic cluster](site/scaling.md) for more information.
156
-
147
+
For more information, see [Scaling a WebLogic cluster](site/scaling.md).
157
148
158
149
## Load balancing with an Ingress controller or a web server
159
150
@@ -164,7 +155,7 @@ You can choose a load balancer provider for your WebLogic domains running in a K
164
155
165
156
## Shutting down a domain
166
157
167
-
Please refer to [Shutting down a domain](site/shutdown-domain.md)for information about how to shut down a domain running in Kubernetes.
158
+
For information about how to shut down a domain running in Kubernetes, see [Shutting down a domain](site/shutdown-domain.md) .
168
159
169
160
## Removing a domain
170
161
@@ -201,17 +192,23 @@ Replace `NAMESPACE` with the namespace that the operator is running in.
201
192
202
193
To remove more than one operator, repeat these steps for each operator namespace.
203
194
195
+
# Developer guide
204
196
205
-
# Recent changes
197
+
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.
206
198
207
-
See [Recent changes](site/recent-changes.md) for recent changes to the operator, including any backward incompatible changes.
199
+
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!
208
200
201
+
# API documentation
209
202
210
-
# Developer guide
203
+
Documentation for APIs is provided here:
211
204
212
-
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.
205
+
*[Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
213
206
214
-
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!
207
+
*[Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
208
+
209
+
# Recent changes
210
+
211
+
See [Recent changes](site/recent-changes.md) for recent changes to the operator, including any backward incompatible changes.
0 commit comments