userguide

Author: rosemarymarano

documentation/1.9/content/KnownIssues.md

@@ -1,4 +1,4 @@
-## Known Issues for Oracle WebLogic Server Deploy Tooling
+## Known Issues for WebLogic Deploy Tooling
 
 The following list contains known issues. Each issue may contain a workaround or an associated issue number.
 

documentation/1.9/content/_index.md

@@ -12,22 +12,18 @@ WDT provides several single-purpose tools, all exposed as shell scripts (for bot
 - The [Encrypt Model Tool]({{< relref "/encrypt.md" >}}) (`encryptModel`) encrypts the passwords in a model (or its variable file) using a user-provided passphrase.
 - The [Validate Model Tool]({{< relref "/validate.md" >}}) (`validateModel`) provides both standalone validation of a model as well as model usage information to help users write or edit their models.
 - The [Compare Model Tool]({{< relref "/compare.md" >}}) (`compareModel`) compares two model files.
-- The [Prepare Model Tool]({{< relref "/prepare.md" >}}) (`prepareModel`) prepares model files for deploying to WebLogic Server Kubernetes Operator environment.
-- The [Extract Domain Resource Tool]({{< relref "/kubernetes.md" >}}) (`extractDomainResource`) generates a domain resource YAML for use with the Oracle WebLogic Server Kubernetes Operator.
+- The [Prepare Model Tool]({{< relref "/prepare.md" >}}) (`prepareModel`) prepares model files for deploying to WebLogic Kubernetes Operator environment.
+- The [Extract Domain Resource Tool]({{< relref "/kubernetes.md" >}}) (`extractDomainResource`) generates a domain resource YAML for use with the WebLogic Kubernetes Operator.
 - The [Variable Injector Tool]({{< relref "/variable_injection.md" >}}) is used to tokenize a model with variables.
 - The [Model Help Tool]({{< relref "/model_help.md" >}}) (`modelHelp.sh`) provides information about the folders and attributes that are valid for sections and folders of a domain model.
 
 As new use cases are discovered, new tools will likely be added to cover those operations but all will use the metadata model to describe what needs to be done.
 
 
-### Download and Install the Software
-
-The Oracle WebLogic Server Deploy Tooling project repository is located at [`https://github.com/oracle/weblogic-deploy-tooling`](https://github.com/oracle/weblogic-deploy-tooling).  Binary distributions of the `weblogic-deploy.zip` installer can be downloaded from the [GitHub Releases page](https://github.com/oracle/weblogic-deploy-tooling/releases).  To install the software, simply unzip the `weblogic-deploy.zip` installer on a machine that has the desired versions of WebLogic Server installed.  After being unzipped, the software is ready to use, just set the `JAVA_HOME` environment variable to point to a Java 7 or higher JDK  and the shell scripts are ready to run.
-
 
 ### Supported WLS Versions
 
-For the supported WebLogic Server and JDK versions required to run WebLogic Server Deploy Tooling, see [Supported WLS Versions]({{< relref "/wls_versions.md" >}}).
+For the supported WebLogic Server and JDK versions required to run WebLogic Deploy Tooling, see [Supported WLS Versions]({{< relref "/wls_versions.md" >}}).
 
 
 ## Concepts

documentation/1.9/content/config/target_env.md

@@ -1,12 +1,12 @@
-## Target Environments
+## Target environments
 
 The [Discover Domain]({{< relref "/discover.md" >}}) and [Prepare Model]({{< relref "/prepare.md" >}}) Tools allow you to customize the model and other files produced to be compatible with a specific target environment. Options for a target environment may include:
 - Using model tokens for some attributes in the model (see [Model Tokens]({{< relref "/model#model-tokens" >}}))
 - Using Kubernetes secrets for credentials in the model
 - Applying filters to the model (see [Model Filters]({{< relref "/tool_configuration#model-filters" >}}))
 - Creating additional configuration files for the target system
 
-### Specifying a Target Environment
+### Specifying a target environment
 
 Each tool specifies a target environment using the command-line argument `-target <target-name>`, where `<target-name>` refers to a pre-configured target environment, or a user-defined environment. In addition, the `-output_dir <output-directory>` argument specifies where the files for the target environment will be stored.
 
@@ -18,17 +18,17 @@ This example would apply the `k8s` target type to the discovery result, and plac
 
 If a variable file is specified on the tool's command line using the `-variable_file` argument, any injected variables will be added to that file. If no variable file is specified, injected variables will be written to the file `<output-directory>/<target_name>_variable.properties`.
 
-### The Target Configuration File 
+### The Target Configuration File
 
 A target environment is configured in a JSON file at this location:
 ```
 $WLSDEPLOY_HOME/lib/target/<target-name>/target.json
 ```
 The `<target-name>` value corresponds to the value of the `-target` argument on the tool's command line. The WLS installation includes two pre-defined targets:
  - [Oracle Weblogic Server Kubernetes Operator](#the-oracle-weblogic-server-kubernetes-operator-target) (named `k8s`)
- - [Verrazzano](#the-verrazzano-target) (named `vz`). 
+ - [Verrazzano](#the-verrazzano-target) (named `vz`).
 
-You can define a new or extended target environment with a new `target-name` in the above location, or using a [Custom Configuration](../tool_configuration.md#custom-configuration) directory, such as `$WDT_CUSTOM_CONFIG/target/<my-target-name>/target.json`. 
+You can define a new or extended target environment with a new `target-name` in the above location, or using a [Custom Configuration](../tool_configuration.md#custom-configuration) directory, such as `$WDT_CUSTOM_CONFIG/target/<my-target-name>/target.json`.
 
 Here is an example of a target environment file:
 ```
@@ -83,7 +83,7 @@ Template files can be customized for specific environments. The recommended meth
 
 These target environment configurations are included in the WebLogic Deploy Tooling installation.
 
-#### The Oracle WebLogic Server Kubernetes Operator Target
+#### The WebLogic Kubernetes Operator target
 
 This target environment can be applied by providing the command-line argument `-target wko`. It will provide this additional processing:
 

documentation/1.9/content/developer/_index.md

@@ -3,7 +3,7 @@ title = "Developer Guide"
 date = 2019-02-22T15:27:54-05:00
 weight = 4
 chapter = true
-pre = "<b> </b>"
+pre = "<b>4. </b>"
 +++
 
 

documentation/1.9/content/tool_configuration.md

@@ -8,19 +8,19 @@
 
  ### Tool Property File
  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.
- 
+
  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. | 
+ | `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. |
  | `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. |
- 
+
  ### Model Filters
 
  WebLogic Deploy Tooling supports the use of model filters to manipulate the domain model. The Create Domain, Update Domain, and Deploy Applications Tools apply filters to the model after it is read, before it is validated and applied to the domain. The Discover Domain Tool applies filters to the model after it has been discovered, before the model is validated and written.
@@ -64,7 +64,7 @@ def filter_model(model):
 
  ### Domain Type Definitions
 
- WebLogic Server Deploy Tooling has an extensible domain type system.  The three built-in domain types (`WLS`, `RestrictedJRF`, and `JRF`) are defined in JSON files of the same name in the `WLSDEPLOY_HOME/lib/typedefs` directory.  For example, the `JRF` domain type is defined in the `WLSDEPLOY_HOME/lib/typedefs/JRF.json` file with similar content, as shown below.
+ WebLogic Deploy Tooling has an extensible domain type system.  The three built-in domain types (`WLS`, `RestrictedJRF`, and `JRF`) are defined in JSON files of the same name in the `WLSDEPLOY_HOME/lib/typedefs` directory.  For example, the `JRF` domain type is defined in the `WLSDEPLOY_HOME/lib/typedefs/JRF.json` file with similar content, as shown below.
 
  ```json
  {

documentation/1.9/content/use_cases.md

@@ -10,7 +10,7 @@
  - [Modeling ODL](#odl-configuration)
  - [Modeling Oracle HTTP Server (OHS)](#configuring-oracle-http-server)
  - [Targeting Server Groups](#targeting-server-groups)
- - [Using WDT with Oracle WebLogic Server Kubernetes Operator](kubernetes.md)
+ - [Using WDT with WebLogic Kubernetes Operator](kubernetes.md)
 
  ### Administration Server Configuration
 
@@ -338,7 +338,7 @@
  **NOTE:** Creating and updating domains with custom security providers is limited to WebLogic version 12.1.2 and newer.
 
  Prior to using this tooling to create or update a domain with a custom security provider, there are several prerequisites.  First, WebLogic Server requires the custom MBean JAR to be in the Oracle Home directory before it can be configured, `WLSERVER/server/lib/mbeantypes`.  Second, WebLogic Scripting Tool, WLST, requires that the schema JAR be placed in the Oracle Home directory before WLST offline can be used to discover it or configure it, `ORACLEHOME/oracle_common/lib/schematypes`.  Generating an MBean JAR documentation can be found in the WebLogic Server [documentation](https://docs.oracle.com/en/middleware/standalone/weblogic-server/14.1.1.0/devsp/generate_mbeantype.html).  Generating the schema JAR can be done with the `prepareCustomProvider` script provided in the WebLogic Server installation.
- 
+
  WebLogic allows you to define an alternate directory other than `WLSERVER/server/lib/mbeantypes` by using the system property `-Dweblogic.alternateTypesDirectory=dir`. In order for the custom provider jars to be loaded correctly by WLST when discovering or configuring a domain, set this system property in the `WLSDEPLOY_PROPERTIES` environment variable.
 
  The format for a custom security provider is slightly different from a built-in provider in that the custom provider must supply the fully-qualified name of the class for the provider in the model between the provider name and the attributes for that provider.  Note that the generated Impl suffix is omitted from the name. In the custom `CredentialMapper` example below, note the location in the model of 'examples.security.providers.SampleCredentialMapper':
@@ -413,7 +413,7 @@
  - The user and group processing is not complete, currently, users cannot be assigned to groups. Users created using the `Security` section are automatically added to the `Administrators` group and are not added to the groups specified. See [Known Issues](../KnownIssues.md#assigning-security-groups-to-users) for information about a patch for this issue.
 
  ### Modeling WebLogic User Password Credential Mapping
- 
+
  The Create Domain Tool can be used to create user password credential mappings for use with the `DefaultCredentialMapper` security provider. Information in the model will be used to create a credential mapping file that will be imported the first time the Administration Server is started. This example shows how mappings are represented in the model:
  ```yaml
 domainInfo:
@@ -444,11 +444,11 @@ domainInfo:
                 RemotePassword: '@@PROP:remote2.pwd@@'
 ```
  In this example, the mapping `map1` creates a cross-domain credential mapping that provides access from this domain to the remote domain `otherDomain` as the user `otherUser` with the configured password.
- 
+
  The mapping `map2` creates a remote resource credential mapping that will give the local user `user1` access to a single remote resource on `remote.host` as the user `remoteUser` with the configured password. The mapping `map3` is similar, but provides access to a different remote resource for two local users, `user1` and `user2`.
- 
+
  The names of the mapping sections in the model, such as `map1` and `map2`, are used to group the attributes for each mapping in the model and are not part of the resulting credential mappings. These names should be unique for each mapping of a particular type.
- 
+
  ### ODL Configuration
 
  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. ODL configuration is only supported for offline mode in WDT. ODL configuration is not added when a model is created using the Discover Domain Tool. This example shows how some common configuration elements can be represented in the model.

documentation/1.9/content/userguide/_index.md

@@ -0,0 +1,9 @@
++++
+title = "User Guide"
+date = 2019-02-22T15:27:54-05:00
+weight = 2
+chapter = true
+pre = "<b>2. </b>"
++++
+
+The User Guide provides detailed information about installing and using WebLogic Deploy Tools.

documentation/1.9/content/userguide/install.md

@@ -0,0 +1,13 @@
+---
+title: "Install WDT"
+date: 2019-02-23T17:19:24-05:00
+draft: false
+weight: 1
+---
+#### Download and Install the Software
+
+The WebLogic Deploy Tooling project repository is located at [`https://github.com/oracle/weblogic-deploy-tooling`](https://github.com/oracle/weblogic-deploy-tooling).  
+Binary distributions of the `weblogic-deploy.zip` installer can be downloaded from the [GitHub Releases page](https://github.com/oracle/weblogic-deploy-tooling/releases).  
+
+1. To install the software, simply unzip the `weblogic-deploy.zip` installer on a machine that has the desired versions of WebLogic Server installed.  
+1. After being unzipped, the software is ready to use, just set the `JAVA_HOME` environment variable to point to a Java 7 or higher JDK  and the shell scripts are ready to run.

documentation/1.9/content/userguide/tools/_index.md

@@ -0,0 +1,29 @@
++++
+title = "WDT Tools"
+date = 2019-02-22T15:27:54-05:00
+weight = 1
+pre = "<b> </b>"
++++
+
+
+The [Create Domain Tool]({{< relref "/create.md" >}}) (`createDomain`) understands how to create a domain and populate the domain with all resources and applications specified in the model.
+
+The [Update Domain Tool]({{< relref "/update.md" >}}) (`updateDomain`) understands how to update an existing domain and populate the domain with all resources and applications specified in the model, either in offline or online mode.
+
+The [Deploy Applications Tool]({{< relref "/deploy.md" >}}) (`deployApps`) understands how to add resources and applications to an existing domain, either in offline or online mode.
+
+The [Discover Domain Tool]({{< relref "/discover.md" >}}) (`discoverDomain`) introspects an existing domain and creates a model file describing the domain and an archive file of the binaries deployed to the domain.
+
+The [Encrypt Model Tool]({{< relref "/encrypt.md" >}}) (`encryptModel`) encrypts the passwords in a model (or its variable file) using a user-provided passphrase.
+
+The [Validate Model Tool]({{< relref "/validate.md" >}}) (`validateModel`) provides both standalone validation of a model as well as model usage information to help users write or edit their models.
+
+The [Compare Model Tool]({{< relref "/compare.md" >}}) (`compareModel`) compares two model files.
+
+The [Prepare Model Tool]({{< relref "/prepare.md" >}}) (`prepareModel`) prepares model files for deploying to WebLogic Kubernetes Operator environment.
+
+The [Extract Domain Resource Tool]({{< relref "/kubernetes.md" >}}) (`extractDomainResource`) generates a domain resource YAML for use with the WebLogic Kubernetes Operator.
+
+The [Variable Injector Tool]({{< relref "/variable_injection.md" >}}) is used to tokenize a model with variables.
+
+The [Model Help Tool]({{< relref "/model_help.md" >}}) (`modelHelp.sh`) provides information about the folders and attributes that are valid for sections and folders of a domain model.

documentation/1.9/content/compare.md renamed to documentation/1.9/content/userguide/tools/compare.md

@@ -1,8 +1,15 @@
-## The Compare Model Tool
+---
+title: "Compare Model Tool"
+date: 2019-02-23T17:19:24-05:00
+draft: false
+weight: 7
+description: "Compares two model files."
+---
+
 
 When working with a domain model, sometimes it is useful to know the differences between different models.
  The Compare Model Tool compares two model files and generates a model that shows the differences between them.
-    
+
 To use the Compare Model Tool, simply run the `compareModel` shell script with the correct arguments.  To see the list of valid arguments, simply run the shell script with the `-help` option (or with no arguments) for usage information.
 
 For example, comparing the following models.  
@@ -259,7 +266,7 @@ topology:
 ```
 
 Comparing the new and old models:
- 
+
  1. Added `cluster-2` and `cluster-2-template` in the topology section.
  2. Removed `ServerStart` of `cluster-1-template` in the topology section.
  3. Deployed two applications `yourear` and `myear` in the appDeployments section.
@@ -268,19 +275,19 @@ Comparing the new and old models:
  5. Removed `WebAppContainer` in the resource section.
  6. Removed the attribute `ResetDeliveryCountOnForward` from `MyUniformDistributedQueue`.
  7. Changed deployment targets for application `myear`.
- 8. Removed the attribute 'ModuleType' for application `myear`. 
- 
- **Note**:  The `!` is a notation for the deletion of a non-attribute key element from the model. Missing attributes 
- will be omitted from the resulting model, but shown as messages in the output.  If the attribute value is a list, even 
- if all the individual items within the list are identical but the ordering is different, the attribute is counted as 
+ 8. Removed the attribute 'ModuleType' for application `myear`.
+
+ **Note**:  The `!` is a notation for the deletion of a non-attribute key element from the model. Missing attributes
+ will be omitted from the resulting model, but shown as messages in the output.  If the attribute value is a list, even
+ if all the individual items within the list are identical but the ordering is different, the attribute is counted as
  different.
- 
+
  To compare the two model files and generate the output to files, run the tool as follows:
 
     weblogic-deploy\bin\compareModel.cmd -oracle_home c:\wls12213 -output_dir c:\cm-output ew_model.yaml old_model.yaml
-    
+
     The following files will be written to the directory:
-    
+
     diffed_model.json
     diffed_model.yaml
     compare_model_stdout