Skip to content

Commit 4f56779

Browse files
markxnelsonrjeberhard
authored andcommitted
Documentation and samples updates for 2.4.0 (#1331)
* update prereqs * [enel] update pv sample to fix pv fs owner * archive static docs from 2.3.0 * archive 2.3.0 docs * update javadoc and domains swagger * update operator swagger docs * archive site docs * fix archived 2.3.0 docs to have the 'old' message on it * update release notes * fix create domain job template - had too many volumes sections * update docs for 2.4.0 * fx javadocs * add chart * resolve merge conflicts
1 parent b8d4c88 commit 4f56779

File tree

1,538 files changed

+826595
-5034
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,538 files changed

+826595
-5034
lines changed

docs-source/content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Oracle is finding ways for organizations using WebLogic Server to run important
1717
The fastest way to experience the operator is to follow the [Quick Start guide]({{< relref "/quickstart/_index.md" >}}), or you can peruse our [documentation]({{< relref "/userguide/_index.md" >}}), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples]({{< relref "/samples/_index.md" >}}).
1818

1919
***
20-
The [current release of the operator](https://github.com/oracle/weblogic-kubernetes-operator/releases) is 2.3.0.
21-
This release was published on August 27th, 2019.
20+
The [current release of the operator](https://github.com/oracle/weblogic-kubernetes-operator/releases) is 2.4.0.
21+
This release was published on November 15th, 2019.
2222
***
2323

2424
{{% notice note %}}

docs-source/content/quickstart/get-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ and accept the license agreement for the [WebLogic Server image](https://hub.doc
1919
1. Pull the operator image:
2020

2121
```bash
22-
$ docker pull oracle/weblogic-kubernetes-operator:2.3.0
22+
$ docker pull oracle/weblogic-kubernetes-operator:2.4.0
2323
```
2424

2525
1. Pull the Traefik load balancer image:

docs-source/content/quickstart/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ $ helm install stable/traefik \
5757
$ helm install kubernetes/charts/weblogic-operator \
5858
--name sample-weblogic-operator \
5959
--namespace sample-weblogic-operator-ns \
60-
--set image=oracle/weblogic-kubernetes-operator:2.3.0 \
60+
--set image=oracle/weblogic-kubernetes-operator:2.4.0 \
6161
--set serviceAccount=sample-weblogic-operator-sa \
6262
--set "domainNamespaces={}" \
6363
--wait

docs-source/content/release-notes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ draft: false
88

99
| Date | Version | Introduces backward incompatibilities | Change |
1010
| --- | --- | --- | --- |
11+
| November 15, 2019 | v2.4.0 | no | Includes fixes for a variety of issues related to FMW infrastructure domains and pod variable substitution. Operator now uses WebLogic Deploy Tooling 1.6.0 and the latest version of the Kubernetes Java Client.
1112
| August 27, 2019 | v2.3.0 | no | Added support for Coherence cluster rolling, pod templating and additional pod content, and experimental support for running under an Istio service mesh.
1213
| June 20, 2019 | v2.2.1 | no | The operator now supports Kubernetes 1.14.0+. This release is primarily a bug fix release and resolves the following issues:<br><ul><li>Servers in domains, where the domain home is on a persistent volume, would sometimes fail to start. These failures would be during the introspection phase following a full domain shutdown. Now, the introspection script better handles the relevant error conditions.</li><li>The domain resource provides an option to <a href="https://github.com/oracle/weblogic-kubernetes-operator/blob/master/docs/domains/Domain.md#server-service">pre-create Kubernetes services</a> for WebLogic Servers that are not yet running so that the DNS addresses of these services are resolvable. These services are now created as non-headless so that they have an IP address.</li></ul>
1314
| June 6, 2019 | v2.2.0 | no | Added support for FMW Infrastructure domains. WebLogic Server instances are now gracefully shut down by default and shutdown options are configurable. Operator is now built and runs on JDK 11.

docs-source/content/samples/simple/domains/domain-home-on-pv/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,28 @@ The following prerequisites must be handled prior to running the create domain s
2020
* In the same Kubernetes namespace, create the Kubernetes persistent volume (PV) where the domain home will be hosted, and the Kubernetes persistent volume claim (PVC) for the domain. For samples to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/simple/storage/_index.md" >}}). By default, the `create-domain.sh` script creates a domain with the `domainUID` set to `domain1` and expects the PVC `domain1-weblogic-sample-pvc` to be present. You can create `domain1-weblogic-sample-pvc` using [create-pv-pvc.sh](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/create-pv-pvc.sh) with an inputs file that has the `domainUID` set to `domain1`.
2121
* Create the Kubernetes secrets `username` and `password` of the administrative account in the same Kubernetes namespace as the domain.
2222

23+
{{% notice note %}}
24+
Please note the following important considerations about using persistent storage.
25+
{{% /notice %}}
26+
27+
There are a number of different Kubernetes storage providers that can be used to create persistent
28+
volumes. Depending on which variant and version of Kubernetes you are using, there will be different
29+
steps required to create persistent volumes. You must use a storage provider that suppports
30+
the `ReadWriteMany` option.
31+
32+
Many storage providers will create a file system on
33+
the persistent volume which is owned by the `root` user. In those cases, you will need to update the
34+
file permissions and/or ownership so that the `oracle` user (`uid 1000`) that is used in the standard
35+
WebLogic Server Docker images can write to the file system in the persistent volume.
36+
37+
This sample will automatically set the owner of all files on the persistent
38+
volume to `uid 1000`. If you want to change that behavior, please edit `kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain-job-template.yaml` and edit or remove the
39+
`initContainer` section.
40+
41+
In some variants of Kubernetes (for example OpenShift) you may also need to configure your pods
42+
to run with user 1000 to make sure that the WebLogic processes can access the file system on the
43+
persistent volume.
44+
2345
#### Use the script to create a domain
2446

2547
Make a copy of the `create-domain-inputs.yaml` file, and run the create script, pointing it at your inputs file and an output directory:

docs-source/content/userguide/introduction/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The operator is packaged in a [Docker image](https://hub.docker.com/r/oracle/web
1818

1919
```
2020
$ docker login
21-
$ docker pull oracle/weblogic-kubernetes-operator:2.3.0
21+
$ docker pull oracle/weblogic-kubernetes-operator:2.4.0
2222
```
2323

2424
For more details on acquiring the operator image and prerequisites for installing the operator, consult the [Quick Start guide]({{< relref "/quickstart/_index.md" >}}).

docs-source/content/userguide/introduction/introduction.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Detailed instructions are available [here]({{< relref "/userguide/managing-opera
1616

1717
### Operator prerequisites
1818

19-
* Kubernetes 1.11.5+, 1.12.3+, 1.13.0+, and 1.14.0+ (check with `kubectl version`).
19+
* Kubernetes 1.11.5+, 1.12.3+, 1.13.0+, 1.14.0+, and 1.15.0+ (check with `kubectl version`).
2020
* Flannel networking v0.9.1-amd64 (check with `docker images | grep flannel`).
2121
* Docker 18.9.1 (check with `docker version`) *or* CRI-O 1.14.7 (check with `crictl version | grep RuntimeVersion`).
2222
* Helm 2.14.3+ (check with `helm version`).
@@ -26,21 +26,35 @@ Detailed instructions are available [here]({{< relref "/userguide/managing-opera
2626
* Check the WLS version with `docker run container-registry.oracle.com/middleware/weblogic:12.2.1.3 sh -c` `'source $ORACLE_HOME/wlserver/server/bin/setWLSEnv.sh > /dev/null 2>&1 && java weblogic.version'`.
2727
* Check the WLS patches with `docker run container-registry.oracle.com/middleware/weblogic:12.2.1.3 sh -c` `'$ORACLE_HOME/OPatch/opatch lspatches'`.
2828
* You must have the `cluster-admin` role to install the operator.
29-
* We do not currently support running WebLogic in non-Linux containers.
29+
* We do not currently support running WebLogic in non-Linux containers.
30+
31+
### Important note about Kubernetes 1.16
32+
33+
Kubernetes 1.16 introduced changes to some Kubernetes APIs that are used by the operator.
34+
At this time, the operator is not guaranteed to work on Kubernetes 1.16.
35+
When we have completed testing and made any necessary code changes, we will update this
36+
page to confirm support of 1.16.
3037

3138
### Cloud providers
3239

3340
The Oracle [Global Pricing and Licensing site](https://www.oracle.com/corporate/pricing/specialty-topics.html)
34-
provides details about licensing practices and policies.
41+
provides details about licensing practices and policies.
3542
WebLogic Server and the operator are supported on "Authorized Cloud Environments" as defined in
36-
[this Oracle licensing policy](https://www.oracle.com/assets/cloud-licensing-070579.pdf) and
43+
[this Oracle licensing policy](https://www.oracle.com/assets/cloud-licensing-070579.pdf) and
3744
[this list of eligible products](http://www.oracle.com/us/corporate/pricing/authorized-cloud-environments-3493562.pdf).
3845

3946
The official document that defines the [supported configurations is here](https://www.oracle.com/middleware/technologies/ias/oracleas-supported-virtualization.html).
4047

4148
In accordance with these policies, the operator and WebLogic Server are supported on Oracle Cloud
4249
Infrastructure using *Oracle Container Engine for Kubernetes*, or in a cluster running *Oracle Linux
43-
Container Servies for use with Kubernetes* on OCI Compute; and on "authorized cloud environments".
50+
Container Services for use with Kubernetes* on OCI Compute, and on "authorized cloud environments".
51+
52+
### Oracle Linux Cloud Native Environment
53+
54+
[Oracle Linux Cloud Native Environment](https://docs.oracle.com/en/operating-systems/olcne/) is a fully integrated suite for the development and management of cloud-native applications. Based on the Open Container Initiative (OCI) and Cloud Native Computing Foundation (CNCF) standards, Oracle Linux Cloud Native Environment delivers a simplified framework for installations, updates, upgrades, and configuration of key features for orchestrating microservices.
55+
56+
WebLogic Server and the WebLogic Kubernetes operator are certified and supported on Oracle Linux Cloud Native Environment.
57+
4458

4559
### OpenShift
4660

@@ -55,16 +69,16 @@ There are a number of development-focused distributions of Kubernetes, like kind
5569
Often these run Kubernetes in a virtual machine on your development machine. We have found that these distributions
5670
present some extra challenges in areas like:
5771

58-
* Separate Docker image stores, making it necessary to save/load images to move them between Docker file systems,
59-
* Default virtual machine file sizes and resource limits that are too small to run WebLogic or hold the necessary images,
60-
* Storage providers that do not always support the features that the operator and/or WebLogic rely on,
61-
* Load balancing implementations that do not always support the features that the operator and/or WebLogic rely on.
72+
* Separate Docker image stores, making it necessary to save/load images to move them between Docker file systems
73+
* Default virtual machine file sizes and resource limits that are too small to run WebLogic or hold the necessary images
74+
* Storage providers that do not always support the features that the operator and/or WebLogic rely on
75+
* Load balancing implementations that do not always support the features that the operator and/or WebLogic rely on
6276

63-
As such, we *do not* recommend using these distributions to run the operator and/or WebLogic, and we do not
77+
As such, we *do not* recommend using these distributions to run the operator and/or WebLogic, and we do not
6478
provide support for WebLogic or the operator running in these distributions.
6579

6680
We have found that Docker for Desktop does not seem to suffer the same limitations, and we do support that as a
67-
dev/test option.
81+
development/test option.
6882

6983
### Operator Docker image
7084

docs-source/content/userguide/managing-domains/domain-lifecycle/restarting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ d. Update the `image` property of the domain resource specifying the new image n
161161
```
162162
domain:
163163
spec:
164-
image: oracle/weblogic-updated:2.3.0
164+
image: oracle/weblogic-updated:2.4.0
165165
```
166166
e. The operator will now initiate a rolling restart, which will apply the updated image, for all the server pods in the domain.
167167

docs-source/content/userguide/managing-operators/using-the-operator/using-helm.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ javaLoggingLevel: "FINE"
111111

112112
Specifies the Docker image containing the operator code.
113113

114-
Defaults to `weblogic-kubernetes-operator:2.3.0`.
114+
Defaults to `weblogic-kubernetes-operator:2.4.0`.
115115

116116
Example:
117117
```
@@ -488,6 +488,3 @@ To recover:
488488
If you create a new domain in a namespace that is deleted and recreated, the domain does not start up until you notify the operator.
489489

490490
Refer to [Domain Namespace Management] ({{<relref "/faq/namespace-management.md">}}) for more information about the problem and solutions.
491-
492-
493-
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<p>Created with <i class="fas fa-heart"></i> from <a href="https://www.oracle.com">Oracle</a></p>
22
<p>&nbsp;</p>
3+
<p>You are viewing the archived documentation for version 2.3.0. To view the documentation for the current release, please
4+
[click here](https://oracle.github.io/weblogic-kubernetes-operator)</p>
5+
<p>&nbsp;</p>
36
<p><a href="https://github.com/oracle/weblogic-kubernetes-operator"><i class="fab fa-github"></i> GitHub repo</a></p>
47
<p><a href="https://weblogic-slack-inviter.herokuapp.com/"><i class="fab fa-slack"></i> Public Slack #operator</a></p>
58
<p>&nbsp;</p>
6-
<img src="http://build.weblogick8s.org:8080/buildStatus/icon?job=weblogic-kubernetes-operator">
9+
<img src="http://build.weblogick8s.org:8080/buildStatus/icon?job=weblogic-kubernetes-operator">

0 commit comments

Comments
 (0)