Skip to content

Commit ac9e140

Browse files
authored
Update prereq information in docs (#1299)
* update prereq information in docs * update prereq information in docs * update prereq information in docs * explicitly state support for oke, olc4k and aks * explicitly state support for oke, olc4k and aks * just say authorized cloud environments, link, and leave it at that * just say authorized cloud environments, link, and leave it at that * just say authorized cloud environments, link, and leave it at that
1 parent 8a3addb commit ac9e140

File tree

3 files changed

+38
-3
lines changed

3 files changed

+38
-3
lines changed

docs-source/content/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ The [current release of the operator](https://github.com/oracle/weblogic-kuberne
2121
This release was published on August 27th, 2019.
2222
***
2323

24+
{{% notice note %}}
25+
Please review the prerequisites and supported environments [here]({{< relref "/userguide/introduction/introduction" >}}).
26+
{{% /notice %}}
27+
2428
#### Operator earlier versions
2529

2630
Documentation for prior releases of the operator is available [here](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/site/README.md).

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

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,49 @@ Detailed instructions are available [here]({{< relref "/userguide/managing-opera
2323
* Oracle WebLogic Server 12.2.1.3.0 with patch 29135930.
2424
* The existing WebLogic Docker image, `container-registry.oracle.com/middleware/weblogic:12.2.1.3 `,
2525
has all the necessary patches applied.
26-
* A `docker pull` is required if you pulled the image prior to that date.
2726
* 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'`.
2827
* Check the WLS patches with `docker run container-registry.oracle.com/middleware/weblogic:12.2.1.3 sh -c` `'$ORACLE_HOME/OPatch/opatch lspatches'`.
2928
* You must have the `cluster-admin` role to install the operator.
29+
* We do not currently support running WebLogic in non-Linux containers.
30+
31+
### Cloud providers
32+
33+
The Oracle [Global Pricing and Licensing site](https://www.oracle.com/corporate/pricing/specialty-topics.html)
34+
provides details about licensing practices and policies.
35+
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
37+
[this list of eligible products](http://www.oracle.com/us/corporate/pricing/authorized-cloud-environments-3493562.pdf).
38+
39+
The official document that defines the [supported configurations is here](https://www.oracle.com/middleware/technologies/ias/oracleas-supported-virtualization.html).
40+
41+
In accordance with these policies, the operator and WebLogic Server are supported on Oracle Cloud
42+
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".
3044

3145
### OpenShift
3246

33-
Operator 2.0.1+ is certified for use on OpenShift 3.11.43+, with Kubernetes 1.11.5+. OpenShift 4 certification is currently in progress.
47+
Operator 2.0.1+ is certified for use on OpenShift Container Platform 3.11.43+, with Kubernetes 1.11.5+. OpenShift 4 certification is currently in progress.
3448

3549
When using the operator in OpenShift, the `anyuid` security context constraint is required to ensure that WebLogic containers run with a UNIX UID that has the correct permissions on the domain filesystem.
3650
For more information, see [OpenShift]({{<relref "/security/openshift.md">}}) in the Security section.
3751

52+
### Important note about development-focused Kubernetes distributions
53+
54+
There are a number of development-focused distributions of Kubernetes, like kind, Minikube, Minishift and so on.
55+
Often these run Kubernetes in a virtual machine on your development machine. We have found that these distributions
56+
present some extra challenges in areas like:
57+
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.
62+
63+
As such, we *do not* recommend using these distributions to run the operator and/or WebLogic, and we do not
64+
provide support for WebLogic or the operator running in these distributions.
65+
66+
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.
68+
3869
### Operator Docker image
3970

4071
You can find the operator image in

docs-source/content/userguide/overview/k8s-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you need some help setting up a Kubernetes environment to experiment with the
1717
"Development/test" options:
1818

1919
* Install [Docker for Mac](https://docs.docker.com/docker-for-mac/#kubernetes) and enable its embedded Kubernetes cluster (or register for the [Docker for Windows](https://beta.docker.com/form) beta and wait until Kubernetes is available there).
20-
* Install [Minikube](https://github.com/kubernetes/minikube) on your Windows/Linux/Mac computer.
20+
* We *do not* recommend or support other development/test options like Minikube, Minishift, kind, and so on.
2121

2222
We have provided our hints and tips for several of these options in the sections below.
2323

0 commit comments

Comments
 (0)