Notify when only non-replicable custom archive path is used

Author: rakillen

Diff for: core/src/main/java/oracle/weblogic/deploy/util/WLSDeployArchive.java

@@ -2499,16 +2499,22 @@ public void extractCustomFiles(File domainHome) throws WLSDeployArchiveIOExcepti
 
         validateExistingDirectory(domainHome, "domainHome", getArchiveFileName(), METHOD);
 
-        if(containsPath(ARCHIVE_CUSTOM_TARGET_DIR)) {
+        boolean hasReplicable = containsPath(ARCHIVE_CUSTOM_TARGET_DIR);
+        if(hasReplicable) {
             extractDirectoryFromZip(ARCHIVE_CUSTOM_TARGET_DIR, domainHome);
         }
 
-        if(containsPath(NON_REPLICABLE_CUSTOM_TARGET_DIR)) {
-            // log that this location is deprecated, but don't use new location for extraction
-            LOGGER.deprecation("WLSDPLY-01463", NON_REPLICABLE_CUSTOM_TARGET_DIR, ARCHIVE_CUSTOM_TARGET_DIR);
+        boolean hasNonReplicable = containsPath(NON_REPLICABLE_CUSTOM_TARGET_DIR);
+        if(hasNonReplicable) {
             extractDirectoryFromZip(NON_REPLICABLE_CUSTOM_TARGET_DIR, domainHome);
         }
 
+        if(hasNonReplicable && !hasReplicable) {
+            // users of older WDT versions may not know about the replicable location.
+            // log a notification that this option is available.
+            LOGGER.notification("WLSDPLY-01463", NON_REPLICABLE_CUSTOM_TARGET_DIR, ARCHIVE_CUSTOM_TARGET_DIR);
+        }
+
         LOGGER.exiting(CLASS, METHOD);
     }
 

Diff for: core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties

@@ -248,8 +248,7 @@ WLSDPLY-01459=Failed to add RCU Wallet to archive because the archive file {0} a
 WLSDPLY-01460=Failed to get the database wallet names from archive file {0} because the archive contains an invalid database wallet entry at {1}
 WLSDPLY-01461=Failed to remove SAML2 initialization data file {0} from archive file {1} because the archive file did not contain {2}.
 WLSDPLY-01462=Failed to add SAML2 initialization data file {0} to archive file {1} because the archive file already contains this entry at {2}.
-WLSDPLY-01463=Custom files found in deprecated archive path {0}, should be changed to {1}. \
-  This will allow them to propagate to remote managed servers.
+WLSDPLY-01463=Custom files were found in archive path {0}, move smaller files to {1} to allow automatic replication to managed servers.
 WLSDPLY-01464=Database wallet found in deprecated archive path {0}, should be changed to {1}. \
   The archive contents have been extracted and assigned to that path.
 WLSDPLY-01465=Failed to add WebLogic Remote Console Extension file {0} to archive file {1} because the archive file already contains this entry at {2}.

Diff for: documentation/4.0/content/concepts/archive.md

@@ -79,6 +79,8 @@ This is the root directory where your custom files and directories can be stored
 files are not collected by the Discover Domain Tool.   Every file resource under this directory is extracted during
 `createDomain`, `updateDomain`, and `deployApps`.
 
+Some custom files may belong in `wlsdeploy/custom`. To determine which location is preferable for your files, see [Why are there two separate directory structures?]({{< relref "#why-are-there-two-separate-directory-structures" >}}).
+
 This location is particularly useful when handling files that live outside an application; for example, a property
 file used to configure the application.  The general steps to make applications that use such files work when
 provisioning them with WDT are:
@@ -130,6 +132,13 @@ wlsdeploy/applications/myApp/WEB-INF/weblogic.xml
 The root directory under which JARs/directories used for server classpaths are stored. Every file resource under this
 directory is extracted, even those not referenced in the model.
 
+#### `wlsdeploy/custom`
+This is the root directory where your custom files and directories can be stored and extracted from the archive. These
+files are not collected by the Discover Domain Tool.   Every file resource under this directory is extracted during
+`createDomain`, `updateDomain`, and `deployApps`.
+
+Some custom files may belong in `config/wlsdeploy/custom`. To determine which location is preferable for your files, see [Why are there two separate directory structures?]({{< relref "#why-are-there-two-separate-directory-structures" >}}).
+
 #### `wlsdeploy/domainBin`
 The root directory under which `$DOMAIN_HOME/bin` scripts are stored. Only scripts referenced in the
 `domainInfo/domainBin` section of the model are extracted, as shown in the example.

Diff for: documentation/4.0/content/userguide/tools-config/tool_prop.md

@@ -6,31 +6,31 @@ weight: 4
 ---
 
 
- You can configure or tune WebLogic Deploy Tooling tools using the tool property file. This property file is installed as `<weblogic-deploy>/lib/tool.properties`. You may change the value of any of the properties in this file to tune the WDT tool. Another option is to configure the tool properties in a Custom Configuration directory. Create the `tool.properties` file in the `$WDT_CUSTOM_CONFIG` directory.
+ You can configure or tune WebLogic Deploy Tooling tools using the tool property file. This property file is installed as `<weblogic-deploy>/lib/tool.properties`. To tune the WDT tool, you may change the value of any of the properties in this file. Another option is to configure the tool properties in a [Custom Configuration]({{< relref "/userguide/tools-config/custom_config.md" >}}) directory. For this option, create the `tool.properties` file in the `$WDT_CUSTOM_CONFIG` directory.
 
  If a property is removed from the file, or a property value is incorrectly formatted, a `WARNING` message is logged and an internal default value used instead of the missing or bad value.
 
- | Property                                   | Description                                                                                                                                                               |
- |--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- | `connect.timeout`                          | The number of milliseconds that WLST waits for the online `connect` command to complete. A value of 0 means the operation will not timeout.                               |
- | `activate.timeout`                         | The number of milliseconds that WLST waits for the activation of configuration changes to complete. A value of -1 means the operation will not timeout.                   |
- | `deploy.timeout`                           | The number of milliseconds that WLST waits for the undeployment process to complete. A value of 0 means the operation will not timeout.                                   |
- | `redeploy.timeout`                         | The number of milliseconds that WLST waits for the redeployment process to complete. A value of 0 means the operation will not timeout.                                   |
- | `undeploy.timeout`                         | The number of milliseconds that WLST waits for the undeployment process to complete. A value of 0 means the operation will not timeout.                                   |
- | `start.application.timeout`                | The number of milliseconds that WLST waits for the start application process to complete. A value of 0 means the operation will not timeout.                              |
- | `stop.application.timeout`                 | The number of milliseconds that WLST waits for the stop application process to complete. A value of 0 means the operation will not timeout.                               |
- | `set.server.groups.timeout`                | Specifies the amount of time the set server groups connection can be inactive before the connection times out.                                                            |
- | `wlst.edit.lock.acquire.timeout`           | Specifies the amount of time in milliseconds the WLST online `startEdit` command will wait trying to acquire the edit lock before it times out.                           |
- | `wlst.edit.lock.release.timeout`           | Specifies the amount of time in milliseconds the WLST online `startEdit` command will wait for the edit lock to be released before releasing it automatically.            |
- | `wlst.edit.lock.exclusive`                 | Specifies whether the edit lock acquired by `startEdit` should be exclusive or shared (default is `shared`).                                                              |
- | `yaml.max.file.size`                       | The maximum size of the YAML model file that the WDT SnakeYAML parser will allow.  The default value of `0` uses the SnakeYAML default setting of `3145728` (i.e., 3 MB). |
- | `use.deprecation.exit.code`                | Whether deprecation messages should cause WDT tools to exit with a non-zero exit code (default is `false`).                                                               |
- | `disable.rcu.drop.schema`                  | Whether the RCU drop step should be skipped when running Create Domain with the `-run_rco` switch (default is `false`).                                                   |
- | `enable.create.domain.password.validation` | Whether Create Domain should try to validate user passwords using the SystemPasswordValidator settings in the model (default is `true`).                                  |
- | `archive.custom.folder.size.limit`         | The size limit for the custom folder above which extracting the folder will generate a warning (default is `1048576`, which is 1 MB).                                     |
- | `ssh.private.key.default.file.name`        | The default file name of the SSH private key file (default is `id_rsa`).                                                                                                  |
- | `use.ssh.compression`                      | Whether to use SSH compression for all SSH operations (default is `true`).                                                                                                |
- | `use.server.version.for.online.operation`  | Whether to use the server's WebLogic Server version and patch level to initialize the aliases for WDT online operations (default is `true`).                              |
+ | Property                                   | Description                                                                                                                                                                              |
+ |--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+ | `activate.timeout`                         | The number of milliseconds that WLST waits for the activation of configuration changes to complete. A value of -1 means the operation will not timeout.                                  |
+ | `archive.custom.folder.size.limit`         | The size limit for the replicable custom files archive folder `config/wlsdeploy/custom` above which extracting the folder will generate a warning (default is `1048576`, which is 1 MB). |
+ | `connect.timeout`                          | The number of milliseconds that WLST waits for the online `connect` command to complete. A value of zero (0) means the operation will not timeout.                                              |
+ | `deploy.timeout`                           | The number of milliseconds that WLST waits for the undeployment process to complete. A value of zero (0) means the operation will not timeout.                                                  |
+ | `disable.rcu.drop.schema`                  | Whether the RCU drop step should be skipped when running Create Domain with the `-run_rco` switch (default is `false`).                                                                  |
+ | `enable.create.domain.password.validation` | Whether Create Domain should try to validate user passwords using the SystemPasswordValidator settings in the model (default is `true`).                                                 |
+ | `redeploy.timeout`                         | The number of milliseconds that WLST waits for the redeployment process to complete. A value of zero (0) means the operation will not timeout.                                                  |
+ | `set.server.groups.timeout`                | Specifies the amount of time the set server groups connection can be inactive before the connection times out.                                                                           |
+ | `ssh.private.key.default.file.name`        | The default file name of the SSH private key file (default is `id_rsa`).                                                                                                                 |
+ | `start.application.timeout`                | The number of milliseconds that WLST waits for the start application process to complete. A value of zero (0) means the operation will not timeout.                                             |
+ | `stop.application.timeout`                 | The number of milliseconds that WLST waits for the stop application process to complete. A value of zero (0) means the operation will not timeout.                                              |
+ | `undeploy.timeout`                         | The number of milliseconds that WLST waits for the undeployment process to complete. A value of zero (0) means the operation will not timeout.                                                  |
+ | `use.deprecation.exit.code`                | Whether deprecation messages should cause WDT tools to exit with a non-zero exit code (default is `false`).                                                                              |
+ | `use.server.version.for.online.operation`  | Whether to use the server's WebLogic Server version and patch level to initialize the aliases for WDT online operations (default is `true`).                                             |
+ | `use.ssh.compression`                      | Whether to use SSH compression for all SSH operations (default is `true`).                                                                                                               |
+ | `wlst.edit.lock.acquire.timeout`           | Specifies the amount of time in milliseconds the WLST online `startEdit` command will wait trying to acquire the edit lock before it times out.                                          |
+ | `wlst.edit.lock.exclusive`                 | Specifies whether the edit lock acquired by `startEdit` should be exclusive or shared (default is `shared`).                                                                             |
+ | `wlst.edit.lock.release.timeout`           | Specifies the amount of time in milliseconds the WLST online `startEdit` command will wait for the edit lock to be released before releasing it automatically.                           |
+ | `yaml.max.file.size`                       | The maximum size of the YAML model file that the WDT SnakeYAML parser will allow.  The default value of zero (0) uses the SnakeYAML default setting of `3145728` (i.e., 3 MB).                |
 
  You can override the value of a single property using a Java System property with the name `wdt.config.<tool-property-name>`.
  For example, adding `-Dwdt.config.connect.timeout=5000` will set the effective `connect.timeout` property to 5000 milliseconds, regardless of what the value in the tool.properties file might be.  To pass

Diff for: installer/src/main/lib/tool.properties

@@ -1,4 +1,4 @@
-# Copyright (c) 2020, 2023, Oracle and/or its affiliates.
+# Copyright (c) 2020, 2024, Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 #
 connect.timeout=120000
@@ -60,4 +60,4 @@ use.ssh.compression=true
 #
 # The recommended limit for the size of the archive custom folder contents
 #
-archive.custom.folder.size.limit=1000000
+archive.custom.folder.size.limit=1048576