Skip to content

Commit 9f10527

Browse files
alai8rjeberhardTom Barnesankediarosemarymarano
authored
OWLS-91040 - WKO 4.0 conditions: rework conditions doc (#3568)
* WKO 4.0 conditions: rework conditions doc Co-authored-by: Ryan Eberhard <[email protected]> Co-authored-by: Tom Barnes <[email protected]> Co-authored-by: Anil Kedia <[email protected]> Co-authored-by: Rosemary Marano <[email protected]>
1 parent 2eec2e2 commit 9f10527

File tree

8 files changed

+279
-100
lines changed

8 files changed

+279
-100
lines changed

documentation/staging/content/managing-domains/accessing-the-domain/domain-events.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description = "Monitor domain resources using operator-generated events about re
99

1010
### Overview
1111

12-
This document describes Kubernetes events that the operator generates about resources that it manages, during key points of its processing workflow. These events provide an additional way of monitoring your domain resources. Most of the operator-generated events are associated with a domain resource, and those events are included in the domain resource object as well. Note that the Kubernetes server also generates events for standard Kubernetes resources, such as pods, services, and jobs that the operator generates on behalf of deployed domain custom resources.
12+
This document describes Kubernetes events that the operator generates about resources that it manages, during key points of its processing workflow. These events provide an additional way of monitoring your domain resources. Most of the operator-generated events are associated with a domain resource, and those events are included in the Domain resource object as well. Note that the Kubernetes server also generates events for standard Kubernetes resources, such as pods, services, and jobs that the operator generates on behalf of deployed domain custom resources.
1313

1414
### What's new
1515

@@ -29,7 +29,11 @@ The domain events have been enhanced in 4.0. Here is a summary of the changes in
2929
* Have a better failure categorization (see [Operator-generated event types](#operator-generated-event-types) for more details).
3030
* Include the categorization information in the event message.
3131
* Provide more information in the event message to indicate what has gone wrong, what you need to do to resolve the problem, and if the operator will [retry]({{< relref "/managing-domains/domain-lifecycle/retry.md" >}}) the failed operation.
32-
* Added three event types, `Unavailable`, `Incomplete`, and `FailureResolved`, to record the transition of domain condition `Available/Completed/Failed` from `True` to `False`, and vice versa.
32+
* Added four event types: `Available`, `Unavailable`, `Incomplete`, and `FailureResolved`, to record
33+
the transition of their corresponding [Domain resource status conditions]({{< relref "/managing-domains/accessing-the-domain/status-conditions#types-of-domain-conditions" >}}).
34+
* Added seven event types: `ClusterAvailable`, `ClusterChanged`, `ClusterCompleted`, `ClusterCreated`,
35+
`ClusterDeleted`, `ClusterIncomplete`, and `ClusterUnavailable`, to record the transition of their
36+
corresponding [Cluster resource status conditions]({{< relref "/managing-domains/accessing-the-domain/status-conditions#types-of-cluster-conditions" >}}).
3337

3438
### Operator-generated event types
3539

@@ -38,23 +42,34 @@ The operator generates these event types in a domain namespace, which indicate t
3842
* `Created`: A new domain is created.
3943
* `Changed`: A change has been made to an existing domain.
4044
* `Deleted`: An existing domain has been deleted.
41-
* `Available`: An existing domain is available, which means a sufficient number of servers are ready such that the customer's applications are available.
42-
* `Failed`: The domain resource encountered a problem which prevented it from becoming fully up. The possible failure could be one or multiple of the following conditions:
43-
* Invalid configurations in domain resource.
45+
* `Available`: An existing domain is available, which means that a sufficient number of servers are ready such that the customer's applications are available. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#available" >}}).
46+
* `Failed`: The domain resource encountered a problem which prevented it from becoming fully up.
47+
For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#failed" >}}).
48+
The possible failure could be one or more of the following conditions:
49+
* Invalid configurations in the domain resource.
4450
* A Kubernetes API call error.
4551
* Introspection failures.
4652
* An unexpected error in a server pod.
47-
* A topology mismatch between the domain resource configuration and the WebLogic domain configuration.
48-
* The replicas of a cluster in the domain resource exceeds the maximum number of servers configured for the WebLogic cluster.
53+
* A topology mismatch between the Domain resource configuration and the WebLogic domain configuration.
54+
* The replicas of a cluster in the Domain resource exceeds the maximum number of servers configured for the WebLogic cluster.
4955
* An internal error.
5056
* A failure that retries will not help, or has been retried and has exceeded the [pre-defined maximum retry time]({{< relref "/managing-domains/domain-lifecycle/retry#retry-behavior" >}}).
5157
* `Completed`: The domain resource is complete because all of the following are true: there is no failure detected, there are no pending server shutdowns, and all servers expected to be running are ready and at their target image, auxiliary images, restart version, and introspect version.all servers that are supposed to be started are up running.
52-
* `Unavailable`: The domain resource is unavailable, which means the domain does not have a sufficient number of servers active.
58+
For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#completed" >}}).
59+
* `Unavailable`: The domain resource is unavailable, which means that the domain does not have a sufficient number of servers active. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#available" >}}).
5360
* `Incomplete`: The domain resource is incomplete for one or more of the following reasons: there are failures detected, there are pending server shutdowns, or not all servers expected to be running are ready and at their target image, auxiliary images, restart version, and introspect version.
54-
* `FailureRessolved`: The failure condition that the domain was in has been resolved.
61+
For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#completed" >}}).
62+
* `FailureResolved`: The failure condition that the domain was in, has been resolved. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#failed" >}}).
5563
* `RollStarting`: The operator has detected domain resource or Model in Image model
56-
updates that require it to perform a rolling restart of the domain.
57-
* `RollCompleted`: The operator has successfully completed a rolling restart of a domain.
64+
updates that require it to perform a rolling restart of the domain. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#rolling" >}}).
65+
* `RollCompleted`: The operator has successfully completed a rolling restart of a domain. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#rolling" >}}).
66+
* `ClusterCreated`: A new Cluster resource is created.
67+
* `ClusterChanged`: A change has been made to an existing Cluster resource.
68+
* `ClusterDeleted`: An existing Cluster resource has been deleted.
69+
* `ClusterAvailable`: An existing cluster is available, which means that a sufficient number of its servers have reached the ready state. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#cluster-available" >}}).
70+
* `ClusterCompleted`: The cluster is complete because all of the following are true: there is no failure detected, there are no pending server shutdowns, and all servers expected to be running are ready and at their target image, auxiliary images, restart version, and introspect version. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#cluster-completed" >}}).
71+
* `ClusterIncomplete`: The cluster is incomplete for one or more of the following reasons: there are failures detected, there are pending server shutdowns, or not all servers expected to be running are ready and at their target image, auxiliary images, restart version, or introspect version. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#cluster-completed" >}}).
72+
* `ClusterUnavailable`: The cluster is unavailable because an insufficient number of its servers that are expected to be running are ready. For details, see the corresponding [condition]({{< relref "/managing-domains/accessing-the-domain/status-conditions#cluster-available" >}}).
5873
* `PodCycleStarting`: The operator has started to replace a server pod after it detects that the current pod does not conform to the current domain resource or WebLogic domain configuration.
5974
* `NamespaceWatchingStarted`: The operator has started watching for domains in a namespace.
6075
* `NamespaceWatchingStopped`: The operator has stopped watching for domains in a namespace. Note that the creation of this event in a domain namespace is the operator's best effort only; the event will not be generated if the required Kubernetes privilege is removed when a namespace is no longer managed by the operator.

documentation/staging/content/managing-domains/accessing-the-domain/logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Log files"
33
date: 2019-02-23T17:39:19-05:00
44
draft: false
5-
weight: 9
5+
weight: 10
66
description: "Configure WebLogic Server and domain log settings."
77
---
88

documentation/staging/content/managing-domains/accessing-the-domain/monitoring-exporter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Monitoring exporter"
33
date: 2019-02-23T17:39:19-05:00
44
draft: false
5-
weight: 10
5+
weight: 11
66
description: "Use the WebLogic Monitoring Exporter to export Prometheus-compatible metrics."
77
---
88

0 commit comments

Comments
 (0)