Skip to content

Commit bab6747

Browse files
rosemarymaranorobertpatrick
authored andcommitted
Add deprecation statements
1 parent 0a0890d commit bab6747

File tree

9 files changed

+26
-18
lines changed

9 files changed

+26
-18
lines changed

documentation/4.0/content/concepts/archive.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ file in the specified location, and will be deployed to that directory in the do
4141

4242
These are the paths within the archive that are used for different types of resources. You can create further
4343
directory structures underneath some of these locations to organize the files and directories as you see fit. The
44-
Archive Helper Tool makes it easy to add, update, and remove entries from the archive file.
44+
Archive Helper Tool makes it easy to add, update, and remove entries from the archive file.
4545

4646
#### `config/wlsdeploy/coherence`
4747
The root directory under which Coherence config files and/or empty directories for Coherence persistent stores.
@@ -106,7 +106,7 @@ The root directory under which JARs/directories used for server classpaths are s
106106
directory is extracted, even those not referenced in the model.
107107

108108
#### `wlsdeploy/domainBin`
109-
The root directory under which `$DOMAIN_HOME/bin` scripts are stored. Only scripts referenced in the
109+
The root directory under which `$DOMAIN_HOME/bin` scripts are stored. Only scripts referenced in the
110110
`domainInfo/domainBin` section of the model are extracted, as shown in the example.
111111

112112
```yaml
@@ -174,8 +174,8 @@ wlsdeploy/structuredApplications/myApp/plan/AppFileOverrides/updated.properties
174174

175175
#### `wlsdeploy/wrcExtension`
176176
The directory into which the WebLogic Remote Console extension WAR file (i.e., `console-rest-ext-6.0.war`) is stored.
177-
Create Domain, Update Domain, and Deploy Applications tools place any file in this directory into the
178-
`$DOMAIN_HOME/management-services-ext/` directory.
177+
Create Domain, Update Domain, and Deploy Applications tools place any file in this directory into the
178+
`$DOMAIN_HOME/management-services-ext/` directory. **NOTE**: The Deploy Applications Tool is deprecated in WDT 4.0.0.
179179

180180
### Using multiple archive files
181181

documentation/4.0/content/concepts/model.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ parser will generate parse errors if the model file contains leading tabs used f
4040
names and values can be specified without quotes except when the content contains one of the restricted characters in a
4141
location that causes the YAML parser to consider it to be a markup character instead of text. For example, a key may
4242
contain an embedded hyphen without needing to be quoted; however, if the key starts with a hyphen, the parser may
43-
consider it to be the start of a YAML list element. See the [YAML 1.1 specification](https://yaml.org/spec/1.1/)
43+
consider it to be the start of a YAML list element. See the [YAML 1.1 specification](https://yaml.org/spec/1.1/)
4444
for more information.
4545

4646
### Top-level model sections
@@ -51,7 +51,7 @@ The tooling has five top-level model sections:
5151
- `resources` - The location where resources and services are specified (for example, data sources, JMS, WLDF).
5252
- `appDeployments` - The location where shared libraries and applications are specified.
5353
- `kubernetes` - The location where the WebLogic Kubernetes Operator domain configuration is specified.
54-
- `verrazzano` - The location where the Verrazzano WebLogic Workload component and application configuration is specified.
54+
- `verrazzano` - The location where the Verrazzano WebLogic Workload component and application configuration is specified. **NOTE**: Verrazzano support is deprecated in WDT 4.0.0.
5555

5656
#### Simple example
5757
Here is a simple example of a model to deploy an application and its data source:
@@ -88,7 +88,7 @@ appDeployments:
8888
ModuleType: war
8989
```
9090
91-
The above example shows two important features of the framework. First, notice that the `URL`, `PasswordEncrypted`,
91+
The above example shows two important features of the framework. First, notice that the `URL`, `PasswordEncrypted`,
9292
`user` property `Value` and all `Target` fields contain values that have a `@@PROP:<name>@@` pattern. This indicates a
9393
variable placeholder whose value is specified at runtime using a variables file. For more information about this and
9494
other token types, see [Model tokens](#model-tokens).
@@ -99,7 +99,7 @@ on the target environment. For more information and a list of available path to
9999

100100
The example above shows the attribute `SourcePath` of the `simpleear` application with a value of
101101
`wlsdeploy/applications/simpleear.ear`. The prefix `wlsdeploy/` indicates that the resource is located in the archive
102-
file in the specified location, and will be deployed to that directory within the domain, in this case
102+
file in the specified location, and will be deployed to that directory within the domain, in this case
103103
`<domain-home>/wlsdeploy/applications/simpleear.ear`. See the [Archive file]({{< relref "/concepts/archive.md" >}})
104104
for more details about using the archive file.
105105

@@ -221,8 +221,8 @@ then the token `@@SECRET:secrets:the-secret@@` will search the following locatio
221221
If either of these files is found, the secret is read from that file and substituted in the model.
222222

223223
The second method for locating the Kubernetes secret file is to use the environment variable
224-
`WDT_MODEL_SECRETS_NAME_DIR_PAIRS` to map `<name>` values to specific directory locations. For example, if
225-
`WDT_MODEL_SECRETS_NAME_DIR_PAIRS` is set to `my-root=/etc/my-secrets,your-root=/etc/your-secrets`, then the token
224+
`WDT_MODEL_SECRETS_NAME_DIR_PAIRS` to map `<name>` values to specific directory locations. For example, if
225+
`WDT_MODEL_SECRETS_NAME_DIR_PAIRS` is set to `my-root=/etc/my-secrets,your-root=/etc/your-secrets`, then the token
226226
`@@SECRET:your-root:the-secret@@` will look for the secrets file at:
227227
```
228228
/etc/your-secrets/the-secret
@@ -310,7 +310,7 @@ Users with these requirements should raise an issue for this support.
310310
With WebLogic Deploy Tooling, you can specify named items in the model to be deleted using the Create Domain,
311311
Update Domain, and Deploy Applications Tools. Named items are those that have multiple instances that are
312312
distinguished by user-provided names, such as managed servers, data sources, and security realms. Items to be deleted
313-
are prepended with an exclamation point (!) in the model.
313+
are prepended with an exclamation point (!) in the model. **NOTE**: The Deploy Applications Tool is deprecated in WDT 4.0.0.
314314

315315
In this example, the managed server ```obsoleteServer``` will be deleted, and ```newServer``` will be created:
316316

@@ -365,7 +365,7 @@ models on the command line. For example:
365365

366366
In this case, the models are merged into a single model before being applied. Each successive model is added to the
367367
previous model. In cases where entities exist in both models, the attributes are combined and attribute values from
368-
successive models prevail. The resulting model is then verified before being applied. For example,
368+
successive models prevail. The resulting model is then verified before being applied. For example,
369369
if Model 1 looks like:
370370
```yaml
371371
topology:

documentation/4.0/content/developer/crd-schemas.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ weight: 4
77

88
The structure of the `kubernetes` and `verrazzano` sections of the [WDT model]({{< relref "/concepts/model.md" >}}) are described by schemas based on the Custom Resource Definitions (CRDs) for those products. This is different from other sections of the model that use the [alias framework]({{< relref "/developer/alias-definitions.md" >}}) to describe their structures.
99

10+
**NOTE**: Verrazzano support is deprecated in WDT 4.0.0.
11+
1012
These schemas are used during model validation to check that folder and attribute names are valid. The [Model Help Tool]({{< relref "/userguide/tools/model_help.md" >}}) uses them to list the contents of folders and details about their attributes.
1113

1214
CRDs corresponding to the `kubernetes` section of the model are contained in the [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/) (WKO) project. CRDs from this project are merged together to form self-contained OpenAPI schemas.
@@ -44,4 +46,3 @@ This will write the generated schema files to the target directory `<project-dir
4446
#### Importing the new schemas
4547

4648
Copy the generated files to the `<project-dir>/core/src/main/resources/oracle/weblogic/deploy/crds` directory. Confirm that any changes appear correctly when using the [Model Help Tool]({{< relref "/userguide/tools/model_help.md" >}}) before checking in the schemas.
47-

documentation/4.0/content/samples/odl-model.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: "A model for configuring Oracle Diagnostic Logging (ODL)."
99

1010
Oracle Diagnostic Logging (ODL) can be configured and updated with Create Domain, Update Domain, and Deploy Applications Tools, starting with WDT release 1.5.2.
1111
ODL configuration is supported only for offline mode in WDT. ODL configuration is not added when a model is created using the Discover Domain Tool.
12-
This example shows how some common configuration elements can be represented in the model.
12+
This example shows how some common configuration elements can be represented in the model. **NOTE**: The Deploy Applications Tool is deprecated in WDT 4.0.0.
1313

1414
```yaml
1515
resources:

documentation/4.0/content/samples/ohs-model.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 9
66
description: "A model for configuring Oracle HTTP Server (OHS)."
77
---
88

9-
Starting with WDT 1.8.0, you can configure and update Oracle HTTP Server (OHS) using the Create Domain, Update Domain, and Deploy Applications Tools, in offline mode only. To discover the OHS configuration, use the Discover Domain Tool, in offline mode only.
9+
Starting with WDT 1.8.0, you can configure and update Oracle HTTP Server (OHS) using the Create Domain, Update Domain, and Deploy Applications Tools, in offline mode only. To discover the OHS configuration, use the Discover Domain Tool, in offline mode only. **NOTE**: The Deploy Applications Tool is deprecated in WDT 4.0.0.
1010

1111
#### Prerequisites
1212

documentation/4.0/content/userguide/target_env.md

+2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ In addition, the `wko` target will replace credentials in the model with referen
5959

6060
#### The Verrazzano targets
6161

62+
**NOTE**: Verrazzano support is deprecated in WDT 4.0.0.
63+
6264
You can use these targets to customize the model and create a Kubernetes resource file for use with Verrazzano. There are three targets for specific [domain home source types](https://oracle.github.io/weblogic-kubernetes-operator/managing-domains/choosing-a-model/):
6365

6466
- `vz` for [Model in Image](https://oracle.github.io/weblogic-kubernetes-operator/managing-domains/model-in-image/) deployments

documentation/4.0/content/userguide/tools/deploy.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ weight: 3
66
description: "Adds resources and applications to an existing domain, either in offline or online mode."
77
---
88

9+
{{% notice note %}}
10+
The Deploy Applications Tool is deprecated in WDT 4.0.0. For comparable functionality and more, use the [Update Domain Tool]({{< relref "/userguide/tools/update.md" >}}).
11+
{{% /notice %}}
912

1013
The Deploy Applications Tool uses a model, the archive, and WLST to deploy applications and resources into an existing WebLogic Server domain in either WLST online or offline mode. When deploying applications and resources from a model, the Deploy Applications Tool focuses primarily on the `resources` and `appDeployments` sections of the model. There are exceptions for the `domainInfo` and `topology` sections, where those configuration elements are deemed to be "application-related." For example, the servers' `ServerStart` folder has an `Arguments` and a `ClassPath` attribute that change the server environment (when started by the Node Manager) that applications may rely on to function properly. Likewise, the `domainInfo` section contains a list of JAR files that are to be placed in `<DOMAIN_HOME>/lib` which are relevant to applications for a similar reason.
1114

@@ -40,7 +43,7 @@ If you are running from a remote machine, then you do not need to specify the do
4043
create such directory or file. For example, if you specify a `domainBin: [ wlsdeploy/domainBin/setUserOverrides.sh]` which references a file entry in the archive file `wlsdeploy/domainBin/setUserOverrides.sh`,
4144
the tool will fail with an error.
4245
- Exploded format application specified in the archive is not supported
43-
-
46+
-
4447
As usual, the tool will prompt for the password (it can also be supplied by piping it to standard input of the tool). To bypass the prompt, you can use one of two options. Store the password in an environment variable, and use the variable name with command-line option `-admin_pass_env`. Store the password in a file. Provide the file name with command-line option `-admin_pass_file`.
4548

4649
When running the tool in WLST online mode, the deploy operation may require server restarts or a domain restart to pick up the changes. The deploy operation can also encounter situations where it cannot complete its operation until the domain is restarted. To communicate these conditions to scripts that may be calling the Deploy Applications Tool, the shell scripts have three special, non-zero exit codes to communicate these states:

documentation/4.0/content/userguide/tools/kubernetes.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ description: "Generates YAML resource files for use with the WebLogic Kubernetes
1111

1212
You can use the Extract Domain Resource Tool to create resource files for use with the WebLogic Kubernetes Operator or Verrazzano. This allows the domain configuration and the Kubernetes container configuration to be specified in a single model file.
1313

14+
**NOTE**: Verrazzano support is deprecated in WDT 4.0.0.
15+
1416
This is especially useful when making configuration changes to the domain that also need to be reflected in the resource file. For example, adding a cluster to the domain only requires that it be added to the `topology` section of the WDT model, then a new resource file can be generated to apply to Kubernetes.
1517

1618
More information about the WebLogic Kubernetes Operator can be found [here](https://oracle.github.io/weblogic-kubernetes-operator).

documentation/4.0/content/userguide/tools/model_help.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ Examples:
208208
cd ../../../ServerTemplate/DynamicServers
209209

210210

211-
[top] -->
211+
[top] -->
212212
```
213213

214214
### Parameter table for `model_help`
@@ -218,6 +218,6 @@ Examples:
218218
| `-folders_only` | List only the folders for the specified model path. | |
219219
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if the `ORACLE_HOME` environment variable is not set. | |
220220
| `-recursive` | List only the folders for the specified model path, and recursively include the folders below that path. | |
221-
| `-target <target>` | The target platform, such as `wko` (the default). This determines the structure of the `kubernetes` and `verrazzano` sections. | |
221+
| `-target <target>` | The target platform, such as `wko` (the default). This determines the structure of the `kubernetes` and `verrazzano` sections. **NOTE**: Verrazzano support is deprecated in WDT 4.0.0.| |
222222
| `-target_mode <mode>` | The WLST mode to use to load the aliases. The mode is either `online` or `offline` (the default). | |
223223
| `<model_path>` | The path to the model element to be examined. The format is `[^<section^>:][/^<folder^>]...` | |

0 commit comments

Comments
 (0)