Skip to content

Commit 36b6272

Browse files
committed
Merge branch 'rm/re-arrange-DoPV-docs' into 'main'
Rearrange DoPV docs and fix links See merge request weblogic-cloud/weblogic-kubernetes-operator!4318
2 parents e668647 + f04a9dd commit 36b6272

File tree

17 files changed

+25
-34
lines changed

17 files changed

+25
-34
lines changed

documentation/site/content/managing-domains/aks/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ After clicking **Create** to create this offer, you will go to the **Deployment
309309
| `clusterT3ExternalEndpoint` | This output is not always present:{{< line_break >}}1. You must [create/update the WLS cluster with advanced configuration](https://oracle.github.io/weblogic-azure/aks/).{{< line_break >}}2. You must enable custom T3 channel by setting `enableClusterT3Tunneling=true`.{{< line_break >}}3. You must configure [Networking](#networking) to enable the Azure Load Balancer service for the WLS cluster.{{< line_break >}}{{< line_break >}}This is a fully qualified, public link to custom T3 channel of the WLS cluster.{{< line_break >}}Sample value:`http://20.4.56.3:8005/` |
310310
| `shellCmdtoConnectAks` | AZ CLI command to connect to the AKS cluster.{{< line_break >}}Sample value: {{< line_break >}}`az account set --subscription xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx; az aks get-credentials --resource-group contoso-rg --name contosoakscluster`|
311311
| `shellCmdtoOutputWlsDomainYaml` | Shell command to display the base64 encoded string of the WLS domain resource definition.{{< line_break >}}Sample value: {{< line_break >}}`echo -e YXBpV...mVCg== \| base64 -d > domain.yaml` |
312-
| `shellCmdtoOutputWlsImageModelYaml` | Shell command to display the base64 encoded string of the WLS [image model]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}).{{< line_break >}}Sample value:{{< line_break >}}`echo -e IyBDb...3EnC \| base64 -d > model.yaml`|
312+
| `shellCmdtoOutputWlsImageModelYaml` | Shell command to display the base64 encoded string of the WLS [image model]({{< relref "/managing-domains/model-in-image/model-files.md" >}}).{{< line_break >}}Sample value:{{< line_break >}}`echo -e IyBDb...3EnC \| base64 -d > model.yaml`|
313313
| `shellCmdtoOutputWlsImageProperties`|Shell command to display the base64 encoded string of the model properties.{{< line_break >}}Sample value:{{< line_break >}}`echo -e IyBDF...PTUK \| base64 -d > model.properties` |
314314
| `shellCmdtoOutputWlsVersionsandPatches` | Shell command to display the base64 encoded string of the WLS version and patches.{{< line_break >}}Sample value:{{< line_break >}}`echo -e CldlY...gMS4= \| base64 -d > version.info`|
315315

documentation/site/content/managing-domains/domain-on-pv/domain-creation-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Domain creation images"
33
date = 2019-02-23T16:45:16-05:00
4-
weight = 25
4+
weight = 3
55
pre = "<b> </b>"
66
description = "Domain creation images supply the WDT model for Domain on PV."
77
+++

documentation/site/content/managing-domains/working-with-wdt-models/jrf-domain.md renamed to documentation/site/content/managing-domains/domain-on-pv/jrf-domain.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "JRF domains"
33
date = 2023-04-26T16:45:16-05:00
4-
weight = 25
4+
weight = 5
55
pre = "<b> </b>"
66
description = "Important information about using JRF domains."
77
+++
@@ -72,7 +72,7 @@ $ opss-wallet.sh -n sample-ns -d sample-domain1 -s -r -wf /tmp/ewallet.p12 -ws j
7272
7373
When a JRF domain is created, an OPSS wallet is stored in the file system where the domain home resides.
7474
This specific wallet key can be exported and used to create a new domain. There is no way to reuse the original RCU schema without this specific wallet key.
75-
Therefore, for disaster recovery, **you should back up this encryption key**.
75+
Therefore, for disaster recovery, **you should back up this OPSS wallet**.
7676
7777
After the operator creates the JRF domain, it stores the OPSS wallet in a ConfigMap. See [Download and save the OPSS wallet](#download-opss-wallet-and-store-in-a-kubernetes-secret).
7878
@@ -149,11 +149,11 @@ In the rare scenario where the domain home directory is corrupted, and you do **
149149
150150
#### Disaster recovery for Model in Image domains
151151
152-
**NOTE**: JRF support in Model in Image domains is deprecated in operator version 4.1.0; use the [Domain on PV]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}) domain home source type instead.
152+
**NOTE**: JRF support in Model in Image domains has been deprecated since operator version 4.1.0; use the Domain on PV [domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}) instead.
153153
154154
When a JRF domain is created, an OPSS wallet is stored in the file system where the domain home resides.
155155
This specific wallet key can be exported and used to create a new domain. There is no way to reuse the original RCU schema without this specific wallet key.
156-
Therefore, for disaster recovery, **you should back up this encryption key**.
156+
Therefore, for disaster recovery, **you should back up this OPSS wallet**.
157157
158158
After the operator creates the JRF domain, it stores the OPSS wallet in a ConfigMap. See [Download and save the OPSS wallet](#download-opss-wallet-and-store-in-a-kubernetes-secret).
159159

documentation/site/content/managing-domains/working-with-wdt-models/model-files.md renamed to documentation/site/content/managing-domains/domain-on-pv/model-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Working with WDT model files"
33
date = 2020-03-11T16:45:16-05:00
4-
weight = 30
4+
weight = 4
55
pre = "<b> </b>"
66
description = "Learn about model file requirements, macros, and loading order."
77
+++

documentation/site/content/managing-domains/domain-on-pv/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ They compactly define a WebLogic domain using model files, variable properties f
4444
For more information about the model format
4545
and its integration,
4646
see [Usage]({{< relref "/managing-domains/domain-on-pv/usage.md" >}})
47-
and [Working with WDT Model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}).
47+
and [Working with WDT Model files]({{< relref "/managing-domains/domain-on-pv/model-files.md" >}}).
4848
The WDT model format is fully described in the open source,
4949
[WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project.
5050

documentation/site/content/managing-domains/domain-on-pv/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ to specify any `persistentVolume` or `persistentVolumeClaim` under the `intiali
208208
209209
#### Domain information
210210
211-
**For JRF-based domains, before proceeding, please be sure to read this document**, [JRF domains]({{< relref "/managing-domains/working-with-wdt-models/jrf-domain.md">}}).
211+
**For JRF-based domains, before proceeding, please be sure to read this document**, [JRF domains]({{< relref "/managing-domains/domain-on-pv/jrf-domain.md">}}).
212212
213213
This is the section describing the WebLogic domain. For example:
214214
@@ -238,7 +238,7 @@ spec:
238238
| `createIfNotExists` | Specifies whether the operator should create the RCU schema first, before creating the domain. | `domain` or `domainAndRCU` (drop existing RCU schema and create new RCU schema) | N (default `domain`) |
239239
| `domainCreationImages` | WDT domain images. | An array of images. | Y |
240240
| `domainCreationConfigMap` | Optional ConfigMap containing extra WDT models. | Kubernetes ConfigMap name. | N |
241-
| `osss.walletPasswordSecret` | Password for extracting OPSS wallet encryption key for JRF domain. | Kubernetes Secret name with the key `walletPassword`. | Y |
241+
| `osss.walletPasswordSecret` | Password for extracting OPSS wallet for JRF domain. | Kubernetes Secret name with the key `walletPassword`. | Y |
242242
| `osss.walletFileSecret` | Extracted OPSS wallet file. | Kubernetes Secret name with the key `walletFile`. | N (Only needed when recreating the domain during disaster recovery) |
243243
244244
**After a JRF domain is successfully deployed**: follow the next section, [Best practices](#best-practices), to download and back up the OPSS wallet.
@@ -247,7 +247,7 @@ spec:
247247
248248
Oracle recommends that you save the OPSS wallet file in a safe, backed-up location __immediately__ after the initial JRF domain is created.
249249
In addition, you should make sure to store the wallet in a Kubernetes Secret in the same namespace. This will allow the secret to be available when the domain needs to be recovered in a disaster scenario or if the domain directory gets corrupted. There is no way to reuse the original RCU schema without this specific wallet key.
250-
Therefore, for disaster recovery, **you should back up this encryption key**.
250+
Therefore, for disaster recovery, **you should back up this OPSS wallet**.
251251
252252
253253
#### Back up the JRF domain home directory and database
@@ -343,7 +343,7 @@ In the rare scenario where the domain home directory is corrupted, and you do **
343343
$ kubectl -n sample-ns patch domain sample-domain1 --type='JSON' -p='[ { "op" : "replace", "path" : "/spec/restartVersion", "value" : "15" }]'
344344
```
345345
346-
For more information, see [Disaster Recovery]({{< relref "/managing-domains/working-with-wdt-models/jrf-domain#disaster-recovery-for-domain-on-pv-deployment">}}).
346+
For more information, see [Disaster Recovery]({{< relref "/managing-domains/domain-on-pv/jrf-domain#disaster-recovery-for-domain-on-pv-deployment">}}).
347347
348348
### Troubleshooting
349349

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ They compactly define a WebLogic domain using YAML files and support including
3434
application archives in a ZIP file. For a description of the model format
3535
and its integration with Model in Image,
3636
see [Usage]({{< relref "/managing-domains/model-in-image/usage.md" >}})
37-
and [Model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}).
37+
and [Model files]({{< relref "/managing-domains/model-in-image/model-files.md" >}}).
3838
The WDT model format is fully described in the open source,
3939
[WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project.
4040

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Model updates can include additions, changes, and deletions. For help generating
106106

107107
- For a description of model file syntax, see the
108108
[WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) documentation
109-
and Model in Image [Model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}) documentation.
109+
and Model in Image [Model files]({{< relref "/managing-domains/model-in-image/model-files.md" >}}) documentation.
110110

111111
- For a description of helper tooling that you can use to generate model change YAML,
112112
see [Using the WDT Discover and Compare Model Tools](#using-the-wdt-discover-domain-and-compare-model-tools).

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ There are multiple methods for supplying Model in Image WDT models files, WDT va
108108
updates to models supplied by one of these methods.
109109

110110
For more information about model file syntax,
111-
see [Working with WDT model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}).
111+
see [Working with WDT model files]({{< relref "/managing-domains/model-in-image/model-files.md" >}}).
112112

113113
### Optional WDT model ConfigMap
114114

@@ -129,7 +129,7 @@ For example, place additional `.yaml` and `.properties` files in a directory cal
129129
weblogic.domainUID=MY-DOMAINUID
130130
```
131131

132-
See [Working with WDT model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}) for a description of model file syntax and loading order, and see [Runtime updates]({{< relref "/managing-domains/model-in-image/runtime-updates.md" >}}) for a description of using WDT model ConfigMaps to update the model configuration of a running domain.
132+
See [Working with WDT model files]({{< relref "/managing-domains/model-in-image/model-files.md" >}}) for a description of model file syntax and loading order, and see [Runtime updates]({{< relref "/managing-domains/model-in-image/runtime-updates.md" >}}) for a description of using WDT model ConfigMaps to update the model configuration of a running domain.
133133

134134

135135
### Required runtime encryption secret
@@ -161,7 +161,7 @@ Corresponding Domain YAML file snippet:
161161
162162
### Secrets for model macros
163163
164-
Create additional secrets as needed by macros in your model files. For example, these can store database URLs and credentials that are accessed using `@@SECRET` macros in your model that reference the secrets. For a description of model macros, see [Model files]({{< relref "/managing-domains/working-with-wdt-models/model-files.md" >}}).
164+
Create additional secrets as needed by macros in your model files. For example, these can store database URLs and credentials that are accessed using `@@SECRET` macros in your model that reference the secrets. For a description of model macros, see [Model files]({{< relref "/managing-domains/model-in-image/model-files.md" >}}).
165165

166166
### Domain fields
167167

documentation/site/content/managing-domains/working-with-wdt-models/_index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)