Skip to content

Commit fff8eca

Browse files
homogenize heading sizes (#2402)
1 parent 81d3851 commit fff8eca

File tree

4 files changed

+41
-41
lines changed

4 files changed

+41
-41
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description = "Debugging a deployed Model in Image domain."
88

99
Here are some suggestions for debugging problems with Model in Image after your Domain YAML file is deployed.
1010

11-
#### Contents
11+
### Contents
1212

1313
- [Check the Domain status](#check-the-domain-status)
1414
- [Check the Domain events](#check-the-domain-events)
@@ -18,20 +18,20 @@ Here are some suggestions for debugging problems with Model in Image after your
1818
- [Check the FAQ](#check-the-faq)
1919

2020

21-
#### Check the Domain status
21+
### Check the Domain status
2222

2323
To check the Domain status: `kubectl -n MY_NAMESPACE describe domain MY_DOMAINUID`.
2424

2525
If you are performing an online update to a running domain's WebLogic configuration,
2626
then see [Online update status and labels]({{<relref "/userguide/managing-domains/model-in-image/runtime-updates#online-update-status-and-labels">}}).
2727

28-
#### Check the Domain events
28+
### Check the Domain events
2929

3030
To check events for the Domain: `kubectl -n MY_NAMESPACE get events --sort-by='.lastTimestamp'`.
3131

3232
For more information, see [Domain events]({{< relref "/userguide/managing-domains/domain-events.md" >}}).
3333

34-
#### Check the introspector job
34+
### Check the introspector job
3535

3636
If your introspector job failed, then examine the `kubectl describe` of the job and its pod, and also examine its log, if one exists.
3737

@@ -92,7 +92,7 @@ when `spec.logHome` is configured and `spec.logHomeEnabled` is true.
9292
If a model file error references a model file in your `spec.configuration.model.configMap`, then you can correct the error by redeploying the ConfigMap with a corrected model file and then initiating a domain restart or roll. Similarly, if a model file error references a model file in your model image, then you can correct the error by deploying a corrected image, modifying your Domain YAML file to reference the new image, and then initiating a domain restart or roll.
9393
{{% /notice %}}
9494

95-
#### Check the WebLogic Server pods
95+
### Check the WebLogic Server pods
9696

9797
If your introspector job succeeded, then there will be no introspector job or pod, the operator will create a `MY_DOMAIN_UID-weblogic-domain-introspect-cm` ConfigMap for your domain, and the operator will then run the domain's WebLogic Server pods.
9898

@@ -101,7 +101,7 @@ If `kubectl -n MY_NAMESPACE get pods` reveals that your WebLogic Server pods hav
101101
If you are performing an online update to a running domain's WebLogic configuration,
102102
then see [Online update status and labels]({{<relref "/userguide/managing-domains/model-in-image/runtime-updates#online-update-status-and-labels">}}).
103103

104-
#### Check the operator log
104+
### Check the operator log
105105

106106
Look for `SEVERE` and `ERROR` level messages in your operator logs. For example:
107107

@@ -133,7 +133,7 @@ Look for `SEVERE` and `ERROR` level messages in your operator logs. For example:
133133
| grep "domainUID...sample-domain1"
134134
```
135135

136-
#### Check the FAQ
136+
### Check the FAQ
137137

138138
Common issues that have corresponding FAQ entries include:
139139
- When a Domain YAML file is deployed and no introspector or WebLogic Server pods start, plus the operator log contains no mention of the domain, then check to make sure that the Domain's namespace has been set up to be monitored by an operator. See the [Managing domain namespaces FAQ]({{<relref "/faq/namespace-management">}}).

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ pre = "<b> </b>"
66
description = "Model file requirements, macros, and loading order."
77
+++
88

9-
#### Contents
9+
### Contents
1010

1111
- [Introduction](#introduction)
1212
- [Sample model file](#sample-model-file)
@@ -17,14 +17,14 @@ description = "Model file requirements, macros, and loading order."
1717
- [Using environment variables in model files](#using-environment-variables-in-model-files)
1818
- [Combining secrets and environment variables in model files](#combining-secrets-and-environment-variables-in-model-files)
1919

20-
#### Introduction
20+
### Introduction
2121

2222
This document describes basic Model in Image model file syntax, naming, and macros. For additional information, see the [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) documentation.
2323

2424
{{% notice tip %}} The WDT [Discover Domain Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/discover/) is particularly useful for generating model files from an existing domain home.
2525
{{% /notice %}}
2626

27-
#### Sample model file
27+
### Sample model file
2828

2929
Here's an example of a model YAML file that defines a WebLogic Server Administration Server and dynamic cluster.
3030

@@ -60,7 +60,7 @@ This sample model file:
6060

6161
For a description of model file macro references to secrets and environment variables, see [Model file macros](#model-file-macros).
6262

63-
#### Important notes about Model in Image model files
63+
### Important notes about Model in Image model files
6464

6565
- Using model file macros
6666

@@ -86,7 +86,7 @@ For a description of model file macro references to secrets and environment vari
8686

8787
- You can control the order that WDT uses to load your model files, see [Model file naming and loading order](#model-file-naming-and-loading-order).
8888

89-
#### Model file naming and loading order
89+
### Model file naming and loading order
9090

9191
Refer to this section if you need to control the order in which your model files are loaded. The order is important when two or more model files refer to the same configuration, because the last model that's loaded has the highest precedence.
9292

@@ -127,9 +127,9 @@ y.yaml,main-model.10.yaml,my-model.10.yaml,jdbc.20.yaml,z.yaml,jdbc-dev-urlprops
127127

128128
Property files (ending in `.properties`) use the same sorting algorithm, but they are appended together into a single file prior to passing them to the WebLogic Deploy Tool.
129129

130-
#### Model file macros
130+
### Model file macros
131131

132-
##### Using secrets in model files
132+
#### Using secrets in model files
133133

134134
You can use WDT model `@@SECRET` macros to reference the WebLogic administrator `username` and `password` keys that are stored in a Kubernetes Secret and to optionally reference additional secrets. Here is the macro pattern for accessing these secrets:
135135

@@ -155,13 +155,13 @@ Here's a sample snippet from a Domain YAML file that sets a `webLogicCredentials
155155
...
156156
```
157157

158-
##### Using environment variables in model files
158+
#### Using environment variables in model files
159159

160160
You can reference operator environment variables in model files. This includes any that you define yourself in your Domain YAML file using `domain.spec.serverPod.env` or `domain.spec.adminServer.serverPod.env`, or the built-in `DOMAIN_UID` environment variable.
161161

162162
For example, the `@@ENV:DOMAIN_UID@@` macro resolves to the current domain's domain UID.
163163

164-
##### Combining secrets and environment variables in model files
164+
#### Combining secrets and environment variables in model files
165165

166166
You can embed an environment variable macro in a secret macro. This is useful for referencing secrets that you've named based on your domain's `domainUID`.
167167

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ pre = "<b> </b>"
66
description = "Introduction to Model in Image, description of its runtime behavior, and references."
77
+++
88

9-
#### Contents
9+
### Contents
1010

1111
- [Introduction](#introduction)
1212
- [WebLogic Deploy Tool models](#weblogic-deploy-tool-models)
@@ -15,7 +15,7 @@ description = "Introduction to Model in Image, description of its runtime behavi
1515
- [Continuous integration and delivery (CI/CD)](#continuous-integration-and-delivery-cicd)
1616
- [References](#references)
1717

18-
#### Introduction
18+
### Introduction
1919

2020
Model in Image is an alternative to the operator's Domain in Image and Domain in PV domain types. See [Choose a domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}) for a comparison of operator domain types.
2121

@@ -37,7 +37,7 @@ This feature is supported for standard WLS domains, Restricted JRF domains, and
3737

3838
For JRF domains, Model in Image provides additional support for initializing the infrastructure database for a domain when a domain is started for the first time, supplying an database password, and obtaining an database wallet for re-use in subsequent restarts of the same domain. See [Requirements for JRF domain types]({{< relref "/userguide/managing-domains/model-in-image/usage/_index.md#requirements-for-jrf-domain-types" >}}).
3939

40-
#### WebLogic Deploy Tool models
40+
### WebLogic Deploy Tool models
4141

4242
WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST)
4343
configuration scripts and templates.
@@ -49,7 +49,7 @@ and [Model files]({{< relref "/userguide/managing-domains/model-in-image/model-f
4949
The WDT model format is fully described in the open source,
5050
[WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project.
5151

52-
#### Runtime behavior
52+
### Runtime behavior
5353

5454
When you deploy a Model in Image domain resource YAML file:
5555

@@ -64,7 +64,7 @@ When you deploy a Model in Image domain resource YAML file:
6464
- The operator subsequently boots your domain's WebLogic Server pods.
6565
- The pods will obtain their domain home from the ConfigMap.
6666

67-
#### Runtime updates
67+
### Runtime updates
6868

6969
Model updates can be applied at runtime by changing an image, secrets, a domain resource, or a WDT model ConfigMap after initial deployment.
7070

@@ -75,11 +75,11 @@ _It is the administrator's responsibility to make the necessary changes to a dom
7575

7676
See [Runtime updates]({{< relref "/userguide/managing-domains/model-in-image/runtime-updates.md" >}}).
7777

78-
#### Continuous integration and delivery (CI/CD)
78+
### Continuous integration and delivery (CI/CD)
7979

8080
To understand how Model in Image works with CI/CD, see [CI/CD considerations]({{< relref "/userguide/cicd/_index.md" >}}).
8181

82-
#### References
82+
### References
8383

8484
- [Model in Image sample]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}})
8585
- [WebLogic Deploy Tool (WDT)](https://oracle.github.io/weblogic-deploy-tooling/)

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ pre = "<b> </b>"
66
description = "Updating a running Model in Image domain's images and model files."
77
+++
88

9-
#### Contents
9+
### Contents
1010

1111
- [Overview](#overview)
1212
- [Supported updates](#supported-updates)
@@ -26,7 +26,7 @@ description = "Updating a running Model in Image domain's images and model files
2626
- [Using the WDT Discover and Compare Model Tools](#using-the-wdt-discover-domain-and-compare-model-tools) below.
2727
- [Changing a Domain `restartVersion` or `introspectVersion`](#changing-a-domain-restartversion-or-introspectversion)
2828

29-
#### Overview
29+
### Overview
3030

3131
If you want to make a WebLogic domain home configuration update to a running Model in Image domain,
3232
and you want the update to survive WebLogic Server pod restarts,
@@ -75,7 +75,7 @@ Unlike configuration overrides, the syntax for a model file update exactly match
7575
the syntax for specifying your model file originally.
7676
{{% /notice %}}
7777

78-
#### Supported updates
78+
### Supported updates
7979

8080
The following updates are *supported* for offline or online updates,
8181
except when they reference an area that is specifically
@@ -133,7 +133,7 @@ documented as [unsupported](#unsupported-updates) below:
133133
[Declaring Named MBeans to Delete](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/#declaring-named-mbeans-to-delete)
134134
in the WebLogic Deploying Tooling documentation.
135135

136-
#### Unsupported updates
136+
### Unsupported updates
137137

138138
{{% notice warning %}}
139139
It is important to avoid applying unsupported model updates to a running domain. An attempt to use an unsupported update may not always result in a clear error message, and the expected behavior may be undefined. If you need to make an unsupported update and no workaround is documented, then shut down your domain entirely before making the change. See [Full domain restarts]({{< relref "/userguide/managing-domains/domain-lifecycle/startup/_index.md#full-domain-restarts">}}).
@@ -233,7 +233,7 @@ and a description of workarounds and alternatives when applicable:
233233
`domainInfo.RCUDbinfo.*`, `topology.Security.*`, and `topology.SecurityConfiguration.*`.
234234
Any online update changes in these sections will result in a failure.
235235

236-
#### Updating an existing model
236+
### Updating an existing model
237237

238238
If you have verified your proposed model updates to a running
239239
Model in Image domain are supported by consulting
@@ -296,9 +296,9 @@ After your model updates are prepared, you can instruct the operator to propagat
296296
to a running domain by following the steps in [Offline updates](#offline-updates)
297297
or [Online updates](#online-updates).
298298

299-
#### Offline updates
299+
### Offline updates
300300

301-
##### Offline update steps
301+
#### Offline update steps
302302

303303
Use the following steps to initiate an offline configuration update to your model:
304304

@@ -343,15 +343,15 @@ If the job reports a failure, see
343343
[Debugging]({{< relref "/userguide/managing-domains/model-in-image/debugging.md" >}})
344344
for advice.
345345

346-
##### Offline update sample
346+
#### Offline update sample
347347

348348
For an offline update sample which adds a data source, see the
349349
[Update 1 use case]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}})
350350
in the Model in Image sample.
351351

352-
#### Online updates
352+
### Online updates
353353

354-
##### Online update steps
354+
#### Online update steps
355355

356356
Use the following steps to initiate an online configuration update to your model:
357357

@@ -440,7 +440,7 @@ spec:
440440
- sample-domain1-another-secret
441441
```
442442

443-
##### Online update handling of non-dynamic WebLogic configuration changes
443+
#### Online update handling of non-dynamic WebLogic configuration changes
444444

445445
The domain resource YAML `domain.spec.configuration.model.onlineUpdate.onNonDynamicChanges` attribute
446446
controls behavior when
@@ -469,7 +469,7 @@ then the new servers will start with the new non-dynamic changes
469469
and the domain will then be running in an inconsistent state until its older servers are restarted.
470470
{{% /notice %}}
471471

472-
##### Online update handling of deletes
472+
#### Online update handling of deletes
473473

474474
The primary use case for online updates is to make small additions,
475475
deletions of single resources or MBeans that have no dependencies,
@@ -614,7 +614,7 @@ resources:
614614
MaxThreadsConstraint:
615615
```
616616

617-
##### Online update status and labels
617+
#### Online update status and labels
618618

619619
During an online update, the operator will rerun the introspector job, which
620620
in turn attempts online WebLogic configuration changes to the running domain.
@@ -734,7 +734,7 @@ _Here are some of the expected WebLogic pod labels after an online update succes
734734
* Non-dynamic WebLogic configuration changes were included in a
735735
successful online model update.
736736

737-
##### Online update scenarios
737+
#### Online update scenarios
738738

739739
1. _Successful online update that includes only dynamic WebLogic MBean changes._
740740
* Example dynamic WebLogic MBean changes:
@@ -807,15 +807,15 @@ _Here are some of the expected WebLogic pod labels after an online update succes
807807
* Make corrections to the domain resource and/or model.
808808
* If retries have halted, then alter the `spec.introspectVersion`.
809809

810-
##### Online update sample
810+
#### Online update sample
811811

812812
For an online update sample which alters a data source and Work Manager, see the
813813
[Update 4 use case]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}})
814814
in the Model in Image sample.
815815

816-
#### Appendices
816+
### Appendices
817817

818-
##### Using the WDT Discover Domain and Compare Model Tools
818+
#### Using the WDT Discover Domain and Compare Model Tools
819819

820820
Optionally, you can use the WDT Discover Domain and Compare Domain Tools to help generate your model file updates.
821821
The WebLogic Deploy Tooling
@@ -880,7 +880,7 @@ For example, assuming you've installed WDT in `/u01/wdt/weblogic-deploy` and ass
880880

881881
> **Note**: If your domain type isn't `WLS`, remember to change the domain type to `JRF` or `RestrictedJRF` in the above `discoverDomain.sh` commands.
882882

883-
##### Changing a Domain `restartVersion` or `introspectVersion`
883+
#### Changing a Domain `restartVersion` or `introspectVersion`
884884

885885
As was mentioned in the [offline updates](#offline-updates) section, one way to tell the operator to
886886
apply offline configuration changes to a running domain is by altering the Domain

0 commit comments

Comments
 (0)