Skip to content

Commit a2e8cd5

Browse files
markxnelsonmarkxnelson
authored
Documentation updates (#649)
* wip * updates from tom barnes * more updates from tom barnes
1 parent 7624d33 commit a2e8cd5

File tree

3 files changed

+106
-24
lines changed

3 files changed

+106
-24
lines changed

‎README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Oracle is finding ways for organizations using WebLogic Server to run important
1818
* 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.
1919
* Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana.
2020

21-
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).
21+
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](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples](kubernetes/samples/README.md).
2222

2323
# About this documentation
2424

@@ -54,6 +54,14 @@ The [User guide](site/user-guide.md) provides detailed information about all asp
5454

5555
Please refer to our [samples](kubernetes/samples/README.md) for information about the available sample code we provide.
5656

57+
# Need more help?
58+
59+
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!"
60+
61+
# Recent changes
62+
63+
See [Recent changes](site/recent-changes.md) for changes to the operator, including any backward incompatible changes.
64+
5765
# Developer guide
5866

5967
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.
@@ -70,15 +78,6 @@ Documentation for APIs is provided here:
7078

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

73-
## Need more help?
74-
75-
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!"
76-
77-
## Recent changes
78-
79-
See [Recent changes](site/recent-changes.md) for changes to the operator, including any backward incompatible changes.
80-
81-
8281
# Contributing to the operator
8382

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

‎site/domains.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,46 @@ Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
2323
* 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.
2424
* [Configure a load balancer](kubernetes/samples/charts/README.md) to manage the domains and ingresses.
2525

26+
### Important considerations for WebLogic domains in Kubernetes
27+
28+
Please be aware of the following important considerations for WebLogic domains
29+
running in Kubernetes.
30+
31+
* Channel Listen Addresses in a configuration must either be left completely unset (e.g. not set to anything), or must be set to the exact required value of ‘DOMAIN_UID-SERVER_NAME’ (with all lower case, underscores converted to dashes). This includes default, SSL, admin, and custom channels.
32+
33+
The following features are not certified or supported in this release:
34+
35+
* Whole Server Migration,
36+
* Consensus Leasing,
37+
* Node Manager (although it is used internally for the liveness probe and to start WebLogic Server instances),
38+
* Multicast,
39+
* If using a hostPath persistent volume, then it must have read/write/many permissions for all container/pods in the WebLogic Server deployment,
40+
* Multitenancy, and
41+
* Production redeployment.
42+
43+
Please consult My Oracle Support Doc ID 2349228.1 for up-to-date information about the features of WebLogic Server that are supported in Kubernetes environments.
44+
45+
2646
### Creating and managing WebLogic domains
2747

28-
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`.
48+
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`.
2949
* (Point to documentation how to edit the domain inputs YAML and how to create the domain custom resource.)
3050
* Create Ingress controllers if you are using a load balancer that supports them, such as Traefik or Voyager.
3151

52+
### Modifying domain configurations
53+
54+
You can modify the WebLogic domain configuration for both the "domain in persistent volume" and the "domain in image" options before deploying a domain resource:
55+
56+
* When the domain is in a persistent volume, you can use WLST or WDT to change the configuration, or
57+
* For either case you can use [configuration overrides](config-overrides.md).
58+
59+
Configuration overrides allow changing a configuration without modifying its original `config.xml` or system resource xml files, and also support parameterizing overrides so that you can inject values into them from Kubernetes secrets. For example, you can inject database usernames, passwords, and URLs that are stored in a secret.
60+
3261
### Managing lifecycle operations
3362

3463
In Operator 2.0 you can perform lifecycle operations on WebLogic servers, clusters, or domains.
3564
* Point to the documentation on how to manage lifecycle operations.
3665

37-
### Modifying domain configurations
38-
You can modify the WebLogic domain configuration for both the domain in PV and the domain in image:
39-
40-
* When the domain is in a PV, use WLST or WDT to change the configuration.
41-
* 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.)
42-
4366
### Patching WebLogic and performing application updates
4467

4568
### Shutting down domains

‎site/weblogic-docker-images.md

Lines changed: 67 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,79 @@
11
**TODO** write me
22

33

4-
## Creating or obtaining WebLogic Docker images
4+
# Creating or obtaining WebLogic Docker images
55

6-
**TODO** write me
6+
You will need Docker images to run your WebLogic domains in Kubernetes.
7+
There are two main options available:
78

8-
### Obtaining standard images from the Docker store
9+
* Use a Docker image which contains the WebLogic Server binaries but
10+
not the domain, or
11+
* Use a Docker image which contains both the WebLogic Server binaries
12+
and the domain directory.
13+
14+
If you want to use the first option, you will need to obtain the standard
15+
WebLogic Server image from the Docker Store [see here](#obtaining-standard-images-from-the-docker-store)
16+
and then create a new image with the mandatory patches applied as described in [this section](#creating-a-custom-images-with-patches-applied).
17+
If you want to use additional patches, you can customize that process to include additional patches.
918

10-
**TODO** write me
19+
If you want to use the second option, which includes the domain directory
20+
inside the Docker image, then you will need to build your own Docker images
21+
as described in [this section](#creating-a-custom-image-with-your-domain-inside-the-image).
1122

12-
### Creating a custom images with patches applied
1323

14-
**TODO** write me
24+
## Obtaining standard images from the Docker store
25+
26+
Oracle provides a [WebLogic Server 12.2.1.3.0 Docker image](https://store.docker.com/_/oracle-weblogic-server-12c) in the
27+
[Docker Store](https://store.docker.com). To obtain that image, you
28+
must have a Docker Store account, log on to the Docker Store, navigate
29+
to that image and click on the "Proceed to Checkout" button which will
30+
prompt you to read and accept the license agreement for the image.
31+
Once you have accepted the license agreement, you will be abel to
32+
pull the image using your Docker store credentials.
33+
34+
First, you will need to login to the Docker Store:
35+
36+
```
37+
docker login
38+
```
39+
40+
Then, you can pull the image with this command:
41+
42+
```
43+
docker pull store/oracle/weblogic:12.2.1.3
44+
```
45+
46+
Additional information about using this image is available on the
47+
Docker Store.
48+
49+
## Creating a custom images with patches applied
50+
51+
The Oracle WebLogic Server Kubernetes Operator requires patch 28076014.
52+
This patch does have some prerequisites that will also need to be applied.
53+
54+
[This sample](https://github.com/oracle/docker-images/blob/master/OracleWebLogic/samples/12213-patch-wls-for-k8s/README.md) in
55+
the Oracle GitHub Docker images repository demonstrates how to create
56+
a patched image.
57+
58+
The `Dockerfile` in that sample lists the base image as follows:
59+
60+
```
61+
FROM oracle/weblogic:12.2.1.3-developer
62+
```
63+
64+
You can change this to use the standard WebLogic Server image you
65+
downloaded from the Docker Store by updating the `FROM` statement
66+
as follows:
67+
68+
```
69+
FROM store/oracle/weblogic:12.2.1.3
70+
```
71+
72+
After running the `docker build` as described in the sample, you
73+
will have created a Docker image with the necessary patches to
74+
run WebLogic 12.2.1.3 in Kubernetes using the operator.
1575

16-
### Creating a custom image with your domain inside the image
76+
## Creating a custom image with your domain inside the image
1777

1878
**TODO** write me
1979

0 commit comments

Comments
 (0)