Skip to content

Commit 8336a6e

Browse files
more text cleanup (#1078)
* more text cleanup * code font needed
1 parent 2b30790 commit 8336a6e

File tree

13 files changed

+24
-24
lines changed

13 files changed

+24
-24
lines changed

documentation/2.0/content/concepts/archive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The root directory under which JARs/directories used for server classpaths are s
6969
The root directory under which empty directories must exist for Coherence persistent stores.
7070

7171
#### `wlsdeploy/custom`
72-
This is the root directory where your custom files can be stored in and extracted from the archive. These files are not collected by the Discover tool. Every file resource under this directory is extracted.
72+
This is the root directory where your custom files can be stored in and extracted from the archive. These files are not collected by the Discover Domain Tool. Every file resource under this directory is extracted.
7373

7474
#### `wlsdeploy/domainBin`
7575
The root directory under which `$DOMAIN_HOME/bin` scripts are stored. Only scripts referenced in the `domainInfo/domainBin` section of the model are extracted.

documentation/2.0/content/concepts/model.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ appDeployments:
8888
ModuleType: war
8989
```
9090
91-
The above example shows two important features of the framework. First, notice that the `URL`, `PasswordEncrypted`, `user` property `Value` and all `Target` fields contain values that have a `@@PROP:<name>@@` pattern. This indicates a variable placeholder whose value is specified at runtime using a variables file. See [Model tokens](#model-tokens) for more information about this and other token types.
91+
The above example shows two important features of the framework. First, notice that the `URL`, `PasswordEncrypted`, `user` property `Value` and all `Target` fields contain values that have a `@@PROP:<name>@@` pattern. This indicates a variable placeholder whose value is specified at runtime using a variables file. For more information about this and other token types, see [Model tokens](#model-tokens).
9292

93-
Second, notice that the `jsf#2.0` shared library `SourcePath` attribute value starts with `@@WL_HOME@@`. This is a path token that can be used to specify that the location is relative to the location of the WebLogic Server home directory on the target environment. See [Model tokens](#model-tokens) for more information and a list of available path tokens.
93+
Second, notice that the `jsf#2.0` shared library `SourcePath` attribute value starts with `@@WL_HOME@@`. This is a path token that can be used to specify that the location is relative to the location of the WebLogic Server home directory on the target environment. For more information and a list of available path tokens, see [Model tokens](#model-tokens).
9494

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

@@ -270,7 +270,7 @@ In addition to deleting named mbeans, you can remove items from a list. Most pra
270270
JMSSystemResource:
271271
BPMJMSModule:
272272
Target: soa_cluster,!AdminServer
273-
273+
274274
```
275275
In this example, the BPMJMSModule has the AdminServer target removed from the target list.
276276

documentation/2.0/content/developer/alias-definitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ This key element specifies which method should be used for retrieving the value
136136

137137
#### `access`
138138

139-
By default, an attribute is read write in both WLST and MODEL. This element is used to set an attribute to read-only. The two read-only attributes are `RO` and `ROD`. The latter indicates that the attribute is read-only and will not be written into the domain. However, it will be discovered by the discover tool into the model.
139+
By default, an attribute is read write in both WLST and MODEL. This element is used to set an attribute to read-only. The two read-only attributes are `RO` and `ROD`. The latter indicates that the attribute is read-only and will not be written into the domain. However, it will be discovered by the Discover Domain Tool into the model.
140140
#### `preferred_model_type`
141141

142142
This key element specifies the preferred data type that should be used to put data in the model during discovery. As an example, list values can be represented in the model as comma-separated text, such as `"value1, value2"`, or as a YAML list, such as `["value1", "value2"]`. If the list values can contain commas, it is preferred to use a YAML list.

documentation/2.0/content/developer/contribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ first open an issue and link to that issue when you submit your pull request.
1313
If you have any questions about a possible submission, feel free to open an issue too.
1414

1515
### Contributing to the WebLogic Deploy repository
16-
Pull requests can be made under [The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA).
16+
Pull requests can be made under [The Oracle Contributor Agreement](https://oca.opensource.oracle.com/) (OCA).
1717

1818
For pull requests to be accepted, the bottom of your commit message must have the following line using your name and e-mail address as it appears in the OCA Signatories list.
1919

documentation/2.0/content/rcuinfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ domainInfo:
5353

5454
When creating a domain using WDT and the -run_rcu option, you can specify your extended XML files in the RCUDbInfo section.
5555

56-
This correlates to the `createRepository` and `dropRepository` command line arguments `RCU -compInfoXMLLocation <file path> -storageXMLLocation <file path>`
56+
This correlates to the `createRepository` and `dropRepository` command-line arguments `RCU -compInfoXMLLocation <file path> -storageXMLLocation <file path>`
5757

5858
Include your XML files in your archive file using location `wlsdeploy/rcu/config`. Then include this relative location in the RCUDbInfo section of the model.
5959

documentation/2.0/content/samples/usersgroups-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ topology:
6262
- The processing of users, groups, and roles will only take place when using the [Create Domain Tool]({{< relref "/userguide/tools/create.md" >}}).
6363
- WebLogic global roles are only supported with WebLogic Server version 12.2.1 or greater.
6464
- WebLogic global roles are only updated for the WebLogic security XACML role mapping provider (for example, `XACMLRoleMapper`).
65-
- 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]({{< relref "/release-notes#assigning-security-groups-to-users" >}}) for information about a patch for this issue.
65+
- 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. For information about a patch for this issue, see [Known issues]({{< relref "/release-notes#assigning-security-groups-to-users" >}}).

documentation/2.0/content/userguide/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 1
88
#### Download and install the software
99

1010
The WebLogic Deploy Tooling project repository is located at [`https://github.com/oracle/weblogic-deploy-tooling`](https://github.com/oracle/weblogic-deploy-tooling).
11-
Binary distributions of the `weblogic-deploy.zip` installer can be downloaded from the [GitHub Releases page](https://github.com/oracle/weblogic-deploy-tooling/releases).
11+
You can download binary distributions of the `weblogic-deploy.zip` installer from the [GitHub Releases page](https://github.com/oracle/weblogic-deploy-tooling/releases).
1212

1313
1. To install the software, simply unzip the `weblogic-deploy.zip` installer on a machine that has the desired versions of WebLogic Server installed.
1414
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.
@@ -19,7 +19,7 @@ The following table specifies the supported WebLogic Server versions, along with
1919

2020
To create a domain with the proper JDK (particularly if the `JAVA_HOME` is different from the one which will be used by the target domain), set the domain `JavaHome` attribute in the domain model.
2121

22-
{{% notice note %}} The Encryption Model Tool used to encrypt and decrypt clear text passwords in the model and variable files, requires WDT to run with a minimum JDK version of 1.8.
22+
{{% notice note %}} The Encryption Model Tool used to encrypt and decrypt clear-text passwords in the model and variable files, requires WDT to run with a minimum JDK version of 1.8.
2323
{{% /notice %}}
2424

2525
| WebLogic Server Version | Tool JDK Version |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "Adds resources and applications to an existing domain, either in o
77
---
88

99

10-
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 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.
10+
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.
1111

1212
The Deploy Applications Tool will only add or update elements in the specified model. It will not attempt to remove any missing elements that were present in a previous model.
1313

documentation/2.0/content/userguide/tools/discover.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ When creating the archive, the tool will try to gather all binaries, scripts, an
1919

2020
1. Any binaries referenced from the `ORACLE_HOME` will not be gathered, as they are assumed to exist in any target domain to which model-driven operations will be applied. Doing this is key to allowing the model to be WebLogic Server version independent.
2121
2. In its current form, the Discover Domain Tool will only gather binaries and scripts that are accessible from the local machine. Warnings will be generated for any binaries or scripts that cannot be found but the configuration for those binaries will still be collected, where possible. It is the user's responsibility to add those missing files to the archive in the appropriate locations and edit the the model, as needed, to point to those files inside the archive using the relative path inside the archive (for example, `wlsdeploy/applications/myapp.ear`).
22-
3. You can you run the discover tool without generating an archive file if you wish to inspect the model file. A create or update domain requires a valid archive file for any binaries, scripts or directories that will be installed into the domain.
22+
3. You can you run the Discover Domain Tool without generating an archive file if you wish to inspect the model file. A create or update domain requires a valid archive file for any binaries, scripts or directories that will be installed into the domain.
2323

2424
You can customize what is generated in the model for password attributes by providing a variable file location and name. This file is a text properties file which will contain a key=value for each password found in the model. The key is a unique token name for a password attribute, and the value is the replacement value; in this case, an empty string. The attribute in the model is injected with the token name and property field notation. For example, `@@PROP:AdminUserName@@` or `@@PROP:JDBCSystemResource.<Name>.JdbcResource.JDBCDriverParams.PasswordEncrypted@@`.
2525

@@ -50,7 +50,7 @@ Before the model is persisted to the model file, any variable injectors or model
5050

5151
The resulting model can also be modified for compatibility with specific target environments, such as Oracle WebLogic Server Kubernetes Operator. For more information, see [Target environments]({{< relref "/userguide/target_env.md" >}}).
5252

53-
Any problems (or success) will be listed in the discover tool summary. The summary will print the version of the tool and Oracle home, and the WLST mode with which the tool was run (online or offline). A recap of all Warning and Severe messages will be listed, along with a total.
53+
Any problems (or success) will be listed in the Discover Domain Tool summary. The summary will print the version of the tool and Oracle home, and the WLST mode with which the tool was run (online or offline). A recap of all Warning and Severe messages will be listed, along with a total.
5454

5555

5656
An example of a summary with a WARNING message:
@@ -75,13 +75,13 @@ The following environment variables may be set.
7575

7676
### Opening an issue against Discover Domain
7777

78-
Please provide the `STDOUT` and `STDERR` log streams in the GitHub Issue. If the summary is not listed (unhandled exception stack trace occurs), be sure and include the Oracle and WDT install versions and whether the tool was run in online or offline WLST mode. If possible, provide the model, variable and archive files, and the log file, `discoverDomain.log`, from location `<install home>\weblogic-deploy\log`.
78+
Please provide the `STDOUT` and `STDERR` log streams in the GitHub Issue. If the summary is not listed (unhandled exception stack trace occurs), be sure and include the Oracle and WDT installation versions and whether the tool was run in online or offline WLST mode. If possible, provide the model, variable and archive files, and the log file, `discoverDomain.log`, from location `<install home>\weblogic-deploy\log`.
7979

8080
### Parameter table for `discoverDomain`
8181
| Parameter | Definition | Default |
8282
| ---- | ---- | ---- |
8383
| `-archive_file` | The path to the archive file. | |
84-
| `-admin_pass_env` | An alternative to entering the admin password at a prompt. The value is a environment variable name that WDT will use to retrieve the password. | |
84+
| `-admin_pass_env` | An alternative to entering the admin password at a prompt. The value is an environment variable name that WDT will use to retrieve the password. | |
8585
| `-admin_pass_file` | An alternative to entering the admin password at a prompt. The value is a the name of a file that contains a password string that the tool will read to retrieve the password. | |
8686
| `-admin_url` | The admin server URL used for online discovery. | |
8787
| `-admin_user` | The admin user used for online discovery. | |

documentation/2.0/content/userguide/tools/encrypt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: "Encrypts the passwords in a model (or its variable file) using a u
1010
{{% notice note %}} To meet Oracle's security standards, the encryption algorithms require JDK 8 to run.
1111
{{% /notice %}}
1212

13-
Models contain WebLogic Server domain configuration. Certain types of resources and other configurations require passwords; for example, a JDBC data source requires the password for the user establishing the database connection. When creating or configuring a resource that requires a password, that password must be specified either in the model directly or in the variable file. Clear-text passwords are not conducive to storing configurations as source, so the Encrypt Model Tool gives the model author the ability to encrypt the passwords in the model and variable file using passphrase-based, reversible encryption. When using a tool with a model containing encrypted passwords, the encryption passphrase must be provided, so that the tool can decrypt the password in memory to set the necessary WebLogic Server configuration (which supports its own encryption mechanism based on a domain-specific key). While there is no requirement to use the WebLogic Deploy Tooling encryption mechanism, it is highly recommended because storing clear text passwords on disk is never a good idea.
13+
Models contain WebLogic Server domain configuration. Certain types of resources and other configurations require passwords; for example, a JDBC data source requires the password for the user establishing the database connection. When creating or configuring a resource that requires a password, that password must be specified either in the model directly or in the variable file. Clear-text passwords are not conducive to storing configurations as source, so the Encrypt Model Tool gives the model author the ability to encrypt the passwords in the model and variable file using passphrase-based, reversible encryption. When using a tool with a model containing encrypted passwords, the encryption passphrase must be provided, so that the tool can decrypt the password in memory to set the necessary WebLogic Server configuration (which supports its own encryption mechanism based on a domain-specific key). While there is no requirement to use the WebLogic Deploy Tooling encryption mechanism, it is highly recommended because storing clear-text passwords on disk is never a good idea.
1414

1515
The Create, Update and Deploy tools can take a set of models. The Encrypt model will encrypt a set of models. Each model is encrypted using the same passphrase and written back to its original location.
1616

@@ -86,7 +86,7 @@ topology:
8686
GroupMemberOf: FriscoGroup
8787
```
8888
89-
To run the encryption tool on the model, run the following command:
89+
To run the Encrypt Model Tool on the model, run the following command:
9090
9191
$ weblogic-deploy\bin\encryptModel.cmd -oracle_home c:\wls12213 -model_file UnencryptedDemoDomain.yaml
9292
@@ -207,7 +207,7 @@ resources:
207207
mail.smtp.host: smtp.example.com
208208
```
209209

210-
Run the encryption tool and pass both the model and variable files, like this:
210+
Run the Encrypt Model Tool and pass both the model and variable files, like this:
211211

212212
$ weblogic-deploy\bin\encryptModel.cmd -oracle_home c:\wls12213 -model_file UnencryptedDemoDomain.yaml -variable_file UnencryptedDemoDomain.properties
213213

@@ -226,6 +226,6 @@ The variable file will now look something like the following:
226226
| `-manual` | Run without a model and get an encrypted value for a single password. | |
227227
| `-model_file` | The location of the model file or a set of model files. | |
228228
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if the `ORACLE_HOME` environment variable is not set. | |
229-
| `-passphrase_env` | An alternative to entering the encryption passphrase at a prompt. The value is a environment variable name that WDT will use to retrieve the passphrase. | |
229+
| `-passphrase_env` | An alternative to entering the encryption passphrase at a prompt. The value is an environment variable name that WDT will use to retrieve the passphrase. | |
230230
| `-passphrase_file` | An alternative to entering the encryption passphrase at a prompt. The value is a the name of a file with a string value which WDT will read to retrieve the passphrase. | |
231231
| `-variable_file` | The location and name of the property file containing the variable values for all variables used in the model(s). | |

0 commit comments

Comments
 (0)