Skip to content

Commit 3ea5a5c

Browse files
committed
Backport documentation changes
1 parent e70657e commit 3ea5a5c

File tree

11 files changed

+138
-37
lines changed

11 files changed

+138
-37
lines changed

documentation/staging/content/faq/oci-lb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ description: "If you are running your Kubernetes cluster on Oracle Container Eng
77
for Kubernetes (OKE), then you can have OCI automatically
88
provision load balancers for you by creating a `Service` of type
99
`LoadBalancer` instead of (or in addition to) installing an
10-
ingress controller like Traefik or Voyager."
10+
ingress controller like Traefik."
1111
---
1212

1313
If you are running your Kubernetes cluster on Oracle Container Engine
1414
for Kubernetes (commonly known as OKE), then you can have OCI automatically
1515
provision load balancers for you by creating a `Service` of type
1616
`LoadBalancer` instead of (or in addition to) installing an
17-
ingress controller like Traefik or Voyager.
17+
ingress controller like Traefik.
1818

1919
OKE Kubernetes worker nodes typically do not have public IP addresses.
2020
This means that the `NodePort` services created by the operator are

documentation/staging/content/faq/security-validation.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,19 @@ Warnings may be at the level of the JDK, or that SSL is not enabled. Some warnin
2222

2323
- For Model in Image, supply model files with the recommended changes in its image's `modelHome` directory or use [runtime updates]({{< relref "/userguide/managing-domains/model-in-image/runtime-updates.md" >}}).
2424

25+
26+
> Msg ID: 090985
27+
>
28+
> Description: Production Mode is enabled but the the file or directory /u01/oracle/user_projects/domains/domain/bin/setDomainEnv.sh is insecure since its permission is not a minimum of umask 027.
29+
>
30+
> SOLUTION: Change the file or directory permission to at most allow only write by owner, read by group.
31+
>
32+
> Description: The file or directory SerializedSystemIni.dat is insecure since its permission is not a minimum of umask 027.
33+
>
34+
> SOLUTION: Change the file or directory permission to at most allow only write by owner, read by group.
35+
36+
When the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT) creates a [Domain Home in Image](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/choosing-a-model/), you can specify the `--target OpenShift` option so that when WIT creates the domain, it sets the correct permissions in the domain home. When no `--target` option is specified, then the domain home directory has a umask of 027.
37+
2538
{{% notice note %}}
2639
For information about handling file permission warnings on the OpenShift Kubernetes Platform, see the [OpenShift chapter]({{<relref "/security/openshift.md">}}) in the Security section.
2740
{{% /notice %}}
28-

documentation/staging/content/samples/azure-kubernetes-service/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Azure Kubernetes Service makes it simple to deploy a managed Kubernetes cluster
2626

2727
To learn more, see the [What is Azure Kubernetes Service?](https://docs.microsoft.com/en-us/azure/aks/intro-kubernetes).
2828

29+
See [Supported platforms]({{< relref "userguide/platforms/environments.md" >}})
30+
for general operator prerequisites
31+
and operator support limitations that are specific to AKS.
32+
2933
#### Domain home source types
3034

3135
This sample demonstrates running the WebLogic cluster on AKS using two domain home types. The instructions for each are self-contained and independent. This section lists the domain home source types recommended for use with AKS, along with some benefits of each. For complete details on domain home source types, see [Choose a domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}).

documentation/staging/content/samples/ingress/_index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,16 @@ description: "Ingress controllers and load balancer sample scripts."
66
---
77

88

9-
The WebLogic Kubernetes Operator supports NGINX, Traefik, Voyager, and Apache. We provide samples that demonstrate how to install and configure each one.
9+
The WebLogic Kubernetes Operator supports NGINX, Traefik, and Apache. We provide samples that demonstrate how to install and configure each one.
1010

1111
{{% notice note %}}
12-
For production environments, we recommend NGINX, Voyager, Traefik (2.2.1 or later) ingress controllers, Apache, or the load balancer provided by your cloud provider.
12+
For production environments, we recommend NGINX, Traefik (2.2.1 or later) ingress controllers, Apache, or the load balancer provided by your cloud provider.
1313
{{% /notice %}}
1414

1515

1616
The samples are located in following folders:
1717

1818
* [Traefik](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/traefik/README.md)
19-
* [Voyager](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/voyager/README.md)
2019
* [NGINX](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/nginx/README.md)
2120
* Apache-samples/[custom-sample](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/apache-samples/custom-sample/README.md)
2221
* Apache-samples/[default-sample](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/apache-samples/default-sample/README.md)

documentation/staging/content/samples/tanzu-kubernetes-service/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ This sample assumes the following prerequisite environment setup:
3232
* [kubectl](https://kubernetes-io-vnext-staging.netlify.com/docs/tasks/tools/install-kubectl/); use `kubectl version` to test if `kubectl` works. This document was tested with version v1.18.6.
3333
* [Helm](https://helm.sh/docs/intro/install/) version 3.1 or later; use `helm version` to check the `helm` version. This document was tested with version v3.2.1.
3434

35+
See [Supported platforms]({{< relref "userguide/platforms/environments" >}})
36+
for general operator prerequisites
37+
and operator support limitations that are specific to Tanzu.
38+
3539
##### Create a Tanzu Kubernetes cluster
3640

3741
Create the Kubernetes cluster using the TKG CLI. See the [Tanzu documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.2/vmware-tanzu-kubernetes-grid-12/GUID-index.html) to set up your Kubernetes cluster.

documentation/staging/content/security/openshift.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,12 @@ For additional information about OpenShift requirements and the operator,
113113
see [OpenShift]({{<relref "/userguide/platforms/environments#openshift">}}).
114114
{{% /notice %}}
115115

116-
#### Using a dedicated namespace
116+
#### Use a dedicated namespace
117117

118118
When the user that installs an individual instance of the operator does not have the required privileges to create resources at the Kubernetes cluster level, a dedicated namespace can be used for the operator instance and all the WebLogic domains that it manages. For more details about the `dedicated` setting, please refer to [Operator Helm configuration values]({{< relref "/userguide/managing-operators/using-helm#operator-helm-configuration-values" >}}).
119119

120120
#### Set the Helm chart property `kubernetesPlatorm` to `OpenShift`
121121
Beginning with operator version 3.3.2, set the operator `kubernetesPlatform` Helm chart property to `OpenShift`. This property accommodates OpenShift security requirements. For more information, see [Operator Helm configuration values]({{<relref "/userguide/managing-operators/using-helm#operator-helm-configuration-values">}}).
122+
123+
#### With WIT, set the `target` parameter to `OpenShift`
124+
When using the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT), `create`, `rebase`, or `update` command, to create a [Domain in Image](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/choosing-a-model/) domain home, you can specify the `--target` parameter for the target Kubernetes environment. Its value can be either `Default` or `OpenShift`. The `OpenShift` option changes the domain directory files such that the group permissions for those files will be the same as the user permissions (group writable, in most cases). If you do not supply the OS group and user setting with `--chown`, then the `Default` setting for this option is changed from `oracle:oracle` to `oracle:root` to be in line with the expectations of an OpenShift environment.

documentation/staging/content/userguide/managing-domains/ingress/_index.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ pre = "<b> </b>"
77

88
Ingresses are one approach provided by Kubernetes to configure load balancers.
99
Depending on the version of Kubernetes you are using, and your cloud provider, you may need to use Ingresses.
10-
For more information about Ingresses, see [the Ingress documentation](https://kubernetes.io/docs/concepts/services-networking/ingress/).
10+
For more information about Ingresses, see the [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) documentation.
1111

1212
#### WebLogic clusters as backends of an Ingress
1313

@@ -34,7 +34,7 @@ The service, `serviceName` and `servicePort`, of a WebLogic cluster will be used
3434
object and the load balancer will route traffic to the WebLogic Servers within the cluster based on the rules.
3535

3636
{{% notice note %}}
37-
Most common ingress controllers, for example Traefik, Voyager, and NGINX,
37+
Most common ingress controllers, for example Traefik and NGINX,
3838
understand that there are zero or more actual pods behind the service, and they actually
3939
build their backend list and route requests to those backends directly, not through the service. This means that
4040
requests are properly balanced across the pods, according to the load balancing algorithm
@@ -56,25 +56,21 @@ additional pods become ready, or pods enter a non-ready state.
5656

5757
* Use the Helm chart [ingress-per-domain](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/ingress-per-domain).
5858

59-
Each ingress provider supports a number of annotations in Ingress resources. This Helm chart allows you to define the routing rules without dealing with the detailed provider-specific annotations. Currently we support two ingress providers: Traefik and Voyager.
59+
Each ingress provider supports a number of annotations in Ingress resources. This Helm chart allows you to define the routing rules without dealing with the detailed provider-specific annotations.
6060

61-
* Create the Ingress resource manually from a YAML file.
61+
* Create the Ingress resource manually from a YAML file.
6262

6363
Manually create an Ingress YAML file and then apply it to the Kubernetes cluster.
6464

65-
#### Guide and samples for Traefik, Voyager/HAProxy, and NGINX
65+
#### Guide and samples for Traefik and NGINX
6666

6767
Information about how to install and configure these ingress controllers to load balance WebLogic clusters is provided here:
6868

6969
- [Traefik guide](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/traefik/README.md)
70-
- [Voyager guide](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/voyager/README.md)
7170
- [NGINX guide](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/nginx/README.md)
7271

7372
{{% notice note %}}
74-
For production environments, we recommend NGINX, Voyager, Traefik (2.2.1 or later) ingress controllers, Apache, or the load balancer provided by your cloud provider.
73+
For production environments, we recommend NGINX, Traefik (2.2.1 or later) ingress controllers, Apache, or the load balancer provided by your cloud provider.
7574
{{% /notice %}}
7675

77-
Samples are also provided for these two ingress controllers, showing how to manage multiple WebLogic clusters as the backends, using different routing rules, host-routing and path-routing; and TLS termination:
78-
79-
- [Traefik samples](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/traefik/samples)
80-
- [Voyager samples](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/voyager/samples)
76+
Samples are also provided for the Traefik ingress controller, showing how to manage multiple WebLogic clusters as the backends, using different routing rules, host-routing and path-routing; and TLS termination: [Traefik samples](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/traefik/samples).

0 commit comments

Comments
 (0)