Skip to content

Commit 79b8a3b

Browse files
Tom Barnesrjeberhard
andauthored
Minor lc doc updates (#2295)
* minor life-cycle doc updates * Backport doc changes Co-authored-by: Ryan Eberhard <[email protected]>
1 parent fd07265 commit 79b8a3b

File tree

6 files changed

+52
-20
lines changed

6 files changed

+52
-20
lines changed

documentation/3.2/content/userguide/managing-domains/domain-lifecycle/introspection.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ weight: 5
66
description: "This document describes domain introspection in the Oracle WebLogic Server in Kubernetes environment."
77
---
88

9+
#### Contents
10+
11+
- [Overview](#overview)
12+
- [When introspection occurs automatically](#when-introspection-occurs-automatically)
13+
- [Initiating introspection](#initiating-introspection)
14+
- [Failed introspection](#failed-introspection)
15+
- [Introspection use cases](#introspection-use-cases)
16+
17+
#### Overview
918

1019
This document describes domain introspection, when it occurs automatically, and how and when to initiate additional introspections of the domain configuration in the Oracle WebLogic Server in Kubernetes environment.
1120

@@ -76,9 +85,11 @@ when `spec.logHome` is configured and `spec.logHomeEnabled` is true.
7685

7786
### Introspection use cases
7887

79-
#### Adding clusters or Managed Servers to the WebLogic domain configuration
88+
The following sections describe typical use cases for rerunning the introspector.
89+
90+
#### Adding clusters or Managed Servers to a Domain in PV configuration
8091

81-
When you have an existing WebLogic domain home on a persistent volume ("Domain in PV") and you currently have WebLogic Server instances running, it is now possible to define new WebLogic clusters or Managed Servers in the domain configuration and start these new instances without affecting the life cycle of any WebLogic Server instances that are already running.
92+
When you have an existing WebLogic domain home on a persistent volume (Domain in PV) and you currently have WebLogic Server instances running, it is now possible to define new WebLogic clusters or Managed Servers in the domain configuration and start these new instances without affecting the life cycle of any WebLogic Server instances that are already running.
8293

8394
Prior to operator 3.0.0, this was not possible because there was no mechanism to initiate introspection other than a full domain shut down and restart and so the operator was unaware of the new clusters or Managed Servers. Now, after updating the domain configuration, you can initiate introspection by changing the `introspectVersion`.
8495

@@ -123,3 +134,7 @@ Alternately, you can set `overrideDistributionStrategy` to ON_RESTART, which mea
123134

124135
{{% notice note %}} Changes to configuration overrides distributed to running WebLogic Server instances can only take effect if the corresponding WebLogic configuration MBean attribute is "dynamic". For instance, the Data Source "passwordEncrypted" attribute is dynamic while the "Url" attribute is non-dynamic.
125136
{{% /notice %}}
137+
138+
#### Distributing changes to running Model in Image domains
139+
140+
The operator supports rerunning the introspector in order to propagate [model updates]({{<relref "/userguide/managing-domains/model-in-image/runtime-updates.md">}}) to a running Model in Image domain.

documentation/3.2/content/userguide/managing-domains/model-in-image/runtime-updates.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -756,7 +756,7 @@ _Here are some of the expected WebLogic pod labels after an online update succes
756756
* Each WebLogic Server pod's `weblogic.introspectVersion` label will match `domain.spec.introspectVersion` after it is rolled.
757757
* The domain status `Available` condition will have a `Status` of `True` after the roll completes.
758758
* Actions required:
759-
* If you want the non-dynamic changes to take effect, then restart the pod(s) with the `weblogic.configChangesPendingRestart=true` label (such as by initiating a domain roll).
759+
* None. All changes will complete after the operator initiated domain roll completes.
760760
* See [Online update handling of non-dynamic WebLogic configuration changes](#online-update-handling-of-non-dynamic-weblogic-configuration-changes).
761761

762762
1. _Changing any of the domain resource [fields that cause servers to be restarted]({{< relref "/userguide/managing-domains/domain-lifecycle/startup/_index.md#fields-that-cause-servers-to-be-restarted" >}}) in addition to `domain.spec.introspectVersion`, `spec.configuration.secrets`, `spec.configuration.model.onlineUpdate`, or `spec.configuration.model.configMap`._
@@ -872,7 +872,7 @@ apply offline configuration changes to a running domain is by altering the Domai
872872
`spec.restartVersion`. Similarly, an [online update](#online-updates) is initiated by altering
873873
the Domain `spec.introspectVersion`. Here are some common ways to alter either of these fields:
874874

875-
- You can alter `restartVersion` interactively using `kubectl edit -n MY_NAMESPACE domain MY_DOMAINUID`.
875+
- You can alter `restartVersion` or `introspectVersion` interactively using `kubectl edit -n MY_NAMESPACE domain MY_DOMAINUID`.
876876

877877
- If you have your domain's resource file, then you can alter this file and call `kubectl apply -f` on the file.
878878

@@ -919,8 +919,9 @@ the Domain `spec.introspectVersion`. Here are some common ways to alter either o
919919
```
920920

921921
- You can use a WebLogic Server Kubernetes Operator sample script that invokes
922-
the same commands that are described in the previous bulleted item. See
923-
`patch-restart-version.sh` and `patch-introspect-version.sh` in
924-
the
925-
`kubernetes/samples/scripts/create-weblogic-domain/model-in-image/utils/`
926-
Model in Image sample directory.
922+
the same commands that are described in the previous bulleted item.
923+
- See `patch-restart-version.sh` and `patch-introspect-version.sh` in
924+
the `kubernetes/samples/scripts/create-weblogic-domain/model-in-image/utils/`
925+
directory.
926+
- Or, see the more advanced `introspectDomain.sh` and `rollDomain.sh` among
927+
the [Domain lifecycle sample scripts]({{< relref "/samples/simple/domains/lifecycle/_index.md">}}).

documentation/3.2/content/userguide/managing-operators/installation/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and uninstall the operator.
1414
- [Install the operator Helm chart](#install-the-operator-helm-chart)
1515
- [Alternatively, install the operator Helm chart from the GitHub chart repository](#alternatively-install-the-operator-helm-chart-from-the-github-chart-repository)
1616
- [Upgrade the operator](#upgrade-the-operator)
17-
- [Remove the operator](#remove-the-operator)
17+
- [Uninstall the operator](#uninstall-the-operator)
1818

1919
#### Install the operator Helm chart
2020

documentation/staging/content/userguide/managing-domains/domain-lifecycle/introspection.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ weight: 5
66
description: "This document describes domain introspection in the Oracle WebLogic Server in Kubernetes environment."
77
---
88

9+
#### Contents
10+
11+
- [Overview](#overview)
12+
- [When introspection occurs automatically](#when-introspection-occurs-automatically)
13+
- [Initiating introspection](#initiating-introspection)
14+
- [Failed introspection](#failed-introspection)
15+
- [Introspection use cases](#introspection-use-cases)
16+
17+
#### Overview
918

1019
This document describes domain introspection, when it occurs automatically, and how and when to initiate additional introspections of the domain configuration in the Oracle WebLogic Server in Kubernetes environment.
1120

@@ -76,9 +85,11 @@ when `spec.logHome` is configured and `spec.logHomeEnabled` is true.
7685

7786
### Introspection use cases
7887

79-
#### Adding clusters or Managed Servers to the WebLogic domain configuration
88+
The following sections describe typical use cases for rerunning the introspector.
89+
90+
#### Adding clusters or Managed Servers to a Domain in PV configuration
8091

81-
When you have an existing WebLogic domain home on a persistent volume ("Domain in PV") and you currently have WebLogic Server instances running, it is now possible to define new WebLogic clusters or Managed Servers in the domain configuration and start these new instances without affecting the life cycle of any WebLogic Server instances that are already running.
92+
When you have an existing WebLogic domain home on a persistent volume (Domain in PV) and you currently have WebLogic Server instances running, it is now possible to define new WebLogic clusters or Managed Servers in the domain configuration and start these new instances without affecting the life cycle of any WebLogic Server instances that are already running.
8293

8394
Prior to operator 3.0.0, this was not possible because there was no mechanism to initiate introspection other than a full domain shut down and restart and so the operator was unaware of the new clusters or Managed Servers. Now, after updating the domain configuration, you can initiate introspection by changing the `introspectVersion`.
8495

@@ -123,3 +134,7 @@ Alternately, you can set `overrideDistributionStrategy` to ON_RESTART, which mea
123134

124135
{{% notice note %}} Changes to configuration overrides distributed to running WebLogic Server instances can only take effect if the corresponding WebLogic configuration MBean attribute is "dynamic". For instance, the Data Source "passwordEncrypted" attribute is dynamic while the "Url" attribute is non-dynamic.
125136
{{% /notice %}}
137+
138+
#### Distributing changes to running Model in Image domains
139+
140+
The operator supports rerunning the introspector in order to propagate [model updates]({{<relref "/userguide/managing-domains/model-in-image/runtime-updates.md">}}) to a running Model in Image domain.

documentation/staging/content/userguide/managing-domains/model-in-image/runtime-updates.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -756,7 +756,7 @@ _Here are some of the expected WebLogic pod labels after an online update succes
756756
* Each WebLogic Server pod's `weblogic.introspectVersion` label will match `domain.spec.introspectVersion` after it is rolled.
757757
* The domain status `Available` condition will have a `Status` of `True` after the roll completes.
758758
* Actions required:
759-
* If you want the non-dynamic changes to take effect, then restart the pod(s) with the `weblogic.configChangesPendingRestart=true` label (such as by initiating a domain roll).
759+
* None. All changes will complete after the operator initiated domain roll completes.
760760
* See [Online update handling of non-dynamic WebLogic configuration changes](#online-update-handling-of-non-dynamic-weblogic-configuration-changes).
761761

762762
1. _Changing any of the domain resource [fields that cause servers to be restarted]({{< relref "/userguide/managing-domains/domain-lifecycle/startup/_index.md#fields-that-cause-servers-to-be-restarted" >}}) in addition to `domain.spec.introspectVersion`, `spec.configuration.secrets`, `spec.configuration.model.onlineUpdate`, or `spec.configuration.model.configMap`._
@@ -872,7 +872,7 @@ apply offline configuration changes to a running domain is by altering the Domai
872872
`spec.restartVersion`. Similarly, an [online update](#online-updates) is initiated by altering
873873
the Domain `spec.introspectVersion`. Here are some common ways to alter either of these fields:
874874

875-
- You can alter `restartVersion` interactively using `kubectl edit -n MY_NAMESPACE domain MY_DOMAINUID`.
875+
- You can alter `restartVersion` or `introspectVersion` interactively using `kubectl edit -n MY_NAMESPACE domain MY_DOMAINUID`.
876876

877877
- If you have your domain's resource file, then you can alter this file and call `kubectl apply -f` on the file.
878878

@@ -919,8 +919,9 @@ the Domain `spec.introspectVersion`. Here are some common ways to alter either o
919919
```
920920

921921
- You can use a WebLogic Server Kubernetes Operator sample script that invokes
922-
the same commands that are described in the previous bulleted item. See
923-
`patch-restart-version.sh` and `patch-introspect-version.sh` in
924-
the
925-
`kubernetes/samples/scripts/create-weblogic-domain/model-in-image/utils/`
926-
Model in Image sample directory.
922+
the same commands that are described in the previous bulleted item.
923+
- See `patch-restart-version.sh` and `patch-introspect-version.sh` in
924+
the `kubernetes/samples/scripts/create-weblogic-domain/model-in-image/utils/`
925+
directory.
926+
- Or, see the more advanced `introspectDomain.sh` and `rollDomain.sh` among
927+
the [Domain lifecycle sample scripts]({{< relref "/samples/simple/domains/lifecycle/_index.md">}}).

documentation/staging/content/userguide/managing-operators/installation/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and uninstall the operator.
1414
- [Install the operator Helm chart](#install-the-operator-helm-chart)
1515
- [Alternatively, install the operator Helm chart from the GitHub chart repository](#alternatively-install-the-operator-helm-chart-from-the-github-chart-repository)
1616
- [Upgrade the operator](#upgrade-the-operator)
17-
- [Remove the operator](#remove-the-operator)
17+
- [Uninstall the operator](#uninstall-the-operator)
1818

1919
#### Install the operator Helm chart
2020

0 commit comments

Comments
 (0)