Skip to content

Commit 78cbb92

Browse files
committed
Synchronize documentation
1 parent 4850400 commit 78cbb92

File tree

17 files changed

+181
-191
lines changed

17 files changed

+181
-191
lines changed

documentation/site/content/base-images/custom-images.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -507,11 +507,7 @@ to create the domain home in Domain in Image.
507507
508508
#### Create a custom image with your model inside the image
509509
510-
{{% notice tip %}}
511-
This section describes an option for layering Model in Image model files on a WebLogic image.
512-
The preferred approach for supplying Model in Image files
513-
is to use [Auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}) instead.
514-
{{% /notice %}}
510+
**NOTE**: Model in Image without auxiliary images (the WDT model and installation files are included in the same image with the WebLogic Server installation) will be deprecated in WebLogic Kubernetes Operator version 4.0.7. Oracle recommends that you use Model in Image _with_ auxiliary images. See [Auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}).
515511
516512
{{% notice warning %}}
517513
The example in this section references a base image,

documentation/site/content/base-images/patch-images.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ of the WebLogic domain to update the Oracle Home of the servers.
7777

7878
#### Model in Image without auxiliary images
7979

80+
**NOTE**: Model in Image without auxiliary images (the WDT model and installation files are included in the same image with the WebLogic Server installation) will be deprecated in WebLogic Kubernetes Operator version 4.0.7. Oracle recommends that you use Model in Image _with_ auxiliary images. See [Auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}).
81+
8082
For Model in Image domains _without_ using auxiliary images:
8183

8284
- The container image contains the JDK, WebLogic Server binaries,

documentation/site/content/managing-domains/accessing-the-domain/ingress/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Information about how to install and configure these ingress controllers to load
7070
- [NGINX guide](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/kubernetes/samples/charts/nginx/README.md)
7171

7272
{{% notice note %}}
73-
For production environments, we recommend NGINX, Traefik (2.2.1 or later) ingress controllers, and Apache webtier or the load balancer provided by your cloud provider.
73+
For production environments, we recommend NGINX, Traefik (2.2.1 or later) ingress controllers or the load balancer provided by your cloud provider.
7474
{{% /notice %}}
7575

7676
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/{{< latestMinorVersion >}}/kubernetes/samples/charts/traefik/samples).

documentation/site/content/managing-domains/choosing-a-model/_index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ When using the operator to start WebLogic Server instances from a domain, you ha
2121
- Supply a WebLogic installation in an image and supply a WebLogic configuration in one of three ways:
2222
- As WDT model YAML file supplied in separate
2323
[auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}).
24-
- As WebLogic Deployment Tool (WDT) model YAML file layered on the WebLogic installation image.
24+
- As WebLogic Deployment Tool (WDT) model YAML file layered on the WebLogic installation image. **NOTE**: Model in Image without auxiliary images (the WDT model and installation files are included in the same image with the WebLogic Server installation) will be deprecated in WebLogic Kubernetes Operator version 4.0.7. Oracle recommends that you use Model in Image _with_ auxiliary images. See [Auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}).
2525
- As WDT model YAML file in a Kubernetes ConfigMap.
2626
- Supply WebLogic applications in one of two ways:
2727
- In auxiliary images.
@@ -31,6 +31,7 @@ When using the operator to start WebLogic Server instances from a domain, you ha
3131
supplied in a Kubernetes ConfigMap.
3232

3333
- **[Domain in Image]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}})**:
34+
**NOTE**: The Domain in Image domain home source type is deprecated in WebLogic Kubernetes Operator version 4.0. Oracle recommends that you choose either Domain in PV or Model in Image, depending on your needs.
3435
- Set the domain resource `domain.spec.domainHomeSourceType` attribute to `Image`.
3536
- Supply a WebLogic installation in an image and supply a WebLogic configuration as a domain home layered on this image.
3637
- Supply WebLogic applications layered on the installation image.
@@ -62,7 +63,7 @@ There are advantages for each domain home source type where Model in Image is th
6263
| Patches can be applied by simply changing the image and rolling the domain. | To apply patches, you must update the domain-specific image and then restart or roll the domain depending on the nature of the patch. | Same as Domain in PV when using dedicated [auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}) to supply model artifacts; same as Domain in Image otherwise. |
6364
| Many cloud providers do not provide persistent volumes that are shared across availability zones, so you may not be able to use a single persistent volume. You may need to use some kind of volume replication technology or a clustered file system. | Provided you do not store and state in containers, you do not have to worry about volume replication across availability zones because each pod has its own copy of the domain. WebLogic replication will handle propagation of any online configuration changes. | Same as Domain in Image. |
6465
| CI/CD pipelines may be more complicated because you would need to run WLST against the live domain directory to effect changes. | CI/CD pipelines are simpler because you can create the whole domain in the image and don't have to worry about a persistent copy of the domain. | CI/CD pipelines are even simpler because you don't need to generate a domain home. The operator will create a domain home for you based on the model that you supply. |
65-
| There are fewer images to manage and store, which could provide significant storage and network savings. | There are more images to manage and store in this approach. | Same as Domain in Image unless you use the [auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}) approach. With auxiliary images, you can use a single image to distribute your WebLogic installation (similar to Domain on PV), plus one or more specific dedicated images that contain your WebLogic configuration and applications.|
66+
| There are fewer images to manage and store, which could provide significant storage and network savings. | There are more images to manage and store in this approach. | Same as Domain in Image unless you use the [auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}) approach. With auxiliary images, you can use a single image to distribute your WebLogic installation (similar to Domain in PV), plus one or more specific dedicated images that contain your WebLogic configuration and applications.|
6667
| You may be able to use standard Oracle-provided images or, at least, a very small number of self-built images, for example, with patches installed. | You may need to do more work to set up processes to build and maintain your images. | Same as Domain in Image.|
6768

6869
### Use or create WebLogic images depending on domain home source type
@@ -74,6 +75,8 @@ There are advantages for each domain home source type where Model in Image is th
7475
* [Auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}})
7576

7677
* Model in Image domains that _do not_ use auxiliary images:
78+
**NOTE**: Model in Image without auxiliary images (the WDT model and installation files are included in the same image with the WebLogic Server installation) will be deprecated in WebLogic Kubernetes Operator version 4.0.7. Oracle recommends that you use Model in Image _with_ Auxiliary images. See [Auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}).
79+
7780
* [Create a custom image with your model inside the image]({{< relref "/base-images/custom-images#create-a-custom-image-with-your-model-inside-the-image" >}})
7881

7982
* Domain in Image domains:

documentation/site/content/managing-domains/domain-resource.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ This document describes how to create your own Domain and Cluster resources.
1414

1515
Domain resources reference WebLogic domain configuration, a WebLogic install,
1616
[images]({{< relref "/base-images/_index.md" >}}),
17-
and anything else necessary to run the domain. Beginning with operator 4.0, WebLogic clusters that are within a WebLogic domain configuration may optionally be associated with a Cluster resource in addition to a Domain resource. This Cluster resource makes it simpler to scale the number of running member servers using `kubectl scale`, the Kubernetes built-in Horizontal Pod Autoscaling, or similar tools. These Cluster resources are only active if referenced by a Domain resource.
17+
and anything else necessary to run the domain. Beginning with operator 4.0, WebLogic clusters that are within a WebLogic domain
18+
configuration may optionally be associated with a Cluster resource in addition to a Domain resource. This Cluster resource makes it
19+
simpler to scale the number of running member servers using `kubectl scale`, the Kubernetes built-in Horizontal Pod Autoscaling,
20+
or similar tools. These Cluster resources are only active if referenced by a Domain resource. **Note:** This Cluster resource is a new
21+
custom resource different from the Domain resource. In earlier operator versions, you specified the life cycle attributes of WebLogic clusters
22+
in the Domain resource cluster section. Beginning with operator 4.0, the Domain resource cluster section references only the name of the Cluster resources;
23+
all the life cycle attributes are specified in the new Cluster resource objects.
1824

1925
{{% notice tip %}}
2026
Many of the samples accompanying the operator project include scripts to generate initial Domain and Cluster resources from a set of simplified inputs; however, these resources are the actual source of truth for how the operator will manage each WebLogic Server domain. You are encouraged to either start with the YAML files generated by the various samples, or create Domain and Cluster resources manually or by using other tools, based on the schema referenced here or in this documentation.
@@ -43,6 +49,7 @@ After you have written your YAML files, you use them to create your domain artif
4349

4450
```shell
4551
$ kubectl apply -f domain-resource.yaml
52+
$ kubectl apply -f cluster-resource.yaml
4653
```
4754

4855
To confirm that the Domain and any Clusters were created, use this command:

documentation/site/content/managing-domains/model-in-image/usage.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ There are multiple methods for supplying Model in Image WDT artifacts:
9393
WDT binaries, WebLogic Server binaries, and WebLogic Server patches in an image.
9494
See [Create a custom image with your model inside the image]({{< relref "/base-images/custom-images#create-a-custom-image-with-your-model-inside-the-image" >}}).
9595

96+
**NOTE**: Model in Image without auxiliary images (the WDT model and installation files are included in the same image with the WebLogic Server installation) will be deprecated in WebLogic Kubernetes Operator version 4.0.7. Oracle recommends that you use Model in Image _with_ auxiliary images. See [Auxiliary images]({{< relref "/managing-domains/model-in-image/auxiliary-images.md" >}}).
97+
9698
- Use a Persistent Volume Claim (PVC):
9799
This method is for advanced use cases only. Supply WDT model YAML, variable, or archive files
98100
in a [Persistent Volume Claim]({{< relref "/managing-domains/persistent-storage/volumes.md" >}})
@@ -185,7 +187,7 @@ that are copied from [Auxiliary Images]({{<relref "/managing-domains/model-in-im
185187

186188
**Notes**:
187189

188-
- There are additional attributes that are common to all domain home source types, such as the `image` field. See the Domain Resource [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md) and [documentation]({{< relref "/managing-domains/domain-resource.md" >}}) for a full list of Domain fields.
190+
- There are additional attributes that are common to all domain home source types, such as the `image` or `clusters` field. See the Domain Resource [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/{{< latestMinorVersion >}}/documentation/domains/Domain.md) and [documentation]({{< relref "/managing-domains/domain-resource.md" >}}) for a full list of Domain fields.
189191

190192
- For fully specified Model in Image Domain YAML file examples,
191193
see the [`kubernetes/samples/scripts/create-weblogic-domain/model-in-image/domain-resources`](https://github.com/oracle/weblogic-kubernetes-operator/tree/{{< latestMinorVersion >}}/kubernetes/samples/scripts/create-weblogic-domain/model-in-image/domain-resources) GitHub directory for the [Model in Image sample]({{< relref "/samples/domains/model-in-image/_index.md" >}}).

documentation/site/content/managing-operators/rbac.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,6 @@ the following `ClusterRoleBinding` entries are mapped to a `ClusterRole` grantin
141141
| | | **Update**: domains (weblogic.oracle), domains/status | |
142142
| | | **Create**: tokenreviews, selfsubjectrulesreviews | |
143143
| Operator `nonresource` | Operator `nonresource` | **Get**: /version/* | [^1] |
144-
| Operator `discovery` | Kubernetes `system:discovery` | **See**: [Kubernetes Discovery Roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#discovery-roles) | [^3] |
145-
| Operator `auth-delegator` | Kubernetes `system:auth-delegator` | **See**: [Kubernetes Component Roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#other-component-roles) | [^3] |
146144

147145

148146
[^1]: The binding is assigned to the operator `ServiceAccount`.

0 commit comments

Comments
 (0)