Skip to content

Commit a8877ec

Browse files
edit commands (#892)
* edit commands * fix command formatting
1 parent 9c6094b commit a8877ec

24 files changed

+102
-55
lines changed

documentation/1.9/content/_index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,9 @@ This documentation includes sections targeted to different audiences:
5252
* [Concepts]({{< relref "/concepts/" >}}) explains the underlying metadata models and archive files.
5353
* The [User Guide]({{< relref "/userguide/" >}}) contains detailed usage information, including how to install and configure WebLogic Deploy Tooling, and how to use each tool.
5454
* The [Samples]({{< relref "/samples/" >}}) provide informative use case scenarios.
55-
* The [Developer Guide]({{< relref "/developer/" >}}) provides details for people who want to understand how WDT is built, its features mapped and implemented.
55+
* The [Developer Guide]({{< relref "/developer/" >}}) provides details for people who
56+
want to understand how WDT is built, its features mapped and implemented. Those who
57+
wish to contribute to the WebLogic Deploy Tooling code will find useful information [here]({{< relref "/developer/contribute.md" >}}).
5658

5759
### Related projects
5860

@@ -61,6 +63,3 @@ This documentation includes sections targeted to different audiences:
6163
* [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter)
6264
* [WebLogic Logging Exporter](https://github.com/oracle/weblogic-logging-exporter)
6365
* [WebLogic Remote Console](https://github.com/oracle/weblogic-remote-console)
64-
65-
### Contributing
66-
Those who wish to contribute to the WebLogic Deploy Tooling code will find useful information [here](https://github.com/oracle/weblogic-deploy-tooling/blob/master/CONTRIBUTING.md).

documentation/1.9/content/concepts/archive.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,13 @@ The directory where the model is optionally located. Only one model file, either
4747
The directory where a wallet can be stored for use with Oracle Platform Security Services. The file resource name is not specified in the model, and is assumed to be a single ZIP file in the archive at this location.
4848

4949
#### `wlsdeploy/applications`
50-
The root directory under which applications are stored. Applications can be stored in the archive as EAR or WAR files, or expanded* under this folder. A sample expanded WAR application might have these entries:
50+
The root directory under which applications are stored. Applications can be stored in the archive as EAR or WAR files, or expanded under this folder.
51+
52+
{{% notice note %}} Expanded application directories are supported after WebLogic Deploy Tooling release 1.6.2.
53+
{{% /notice %}}
54+
55+
A sample expanded WAR application might have these entries:
56+
5157
```
5258
wlsdeploy/applications/myApp/index.jsp
5359
wlsdeploy/applications/myApp/META-INF/MANIFEST.MF
@@ -56,28 +62,26 @@ wlsdeploy/applications/myApp/WEB-INF/web.xml
5662
wlsdeploy/applications/myApp/WEB-INF/weblogic.xml
5763
```
5864

59-
\* Expanded application directories are supported after WebLogic Deploy Tooling release 1.6.2
60-
6165
#### `wlsdeploy/classpathLibraries`
6266
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.
6367

6468
#### `wlsdeploy/coherence`
6569
The root directory under which empty directories must exist for Coherence persistent stores.
6670

6771
#### `wlsdeploy/domainBin`
68-
The root directory under which $DOMAIN_HOME/bin scripts are stored. Only scripts referenced in the `domainInfo/domainBin` section of the model are extracted.
72+
The root directory under which `$DOMAIN_HOME/bin` scripts are stored. Only scripts referenced in the `domainInfo/domainBin` section of the model are extracted.
6973

7074
#### `wlsdeploy/domainLibraries`
7175
The root directory under which `$DOMAIN_HOME/lib` libraries are stored. Only libraries referenced in the `domainInfo/domainLibraries` section of the model are extracted.
7276

7377
#### `wlsdeploy/nodeManager`
74-
The root directory under which node manager file resources, such as keystore files, are stored.
78+
The root directory under which Node Manager file resources, such as keystore files, are stored.
7579

7680
#### `wlsdeploy/scripts`
7781
The root directory under which scripts are stored. These can include JDBC create scripts, and WLDF action scripts.
7882

7983
#### `wlsdeploy/servers`
80-
The root directory under which server files, such as keystore files, are stored. These are organized by server name, such as `wlsdeploy/server/my-server/mykey.jks`
84+
The root directory under which server files, such as keystore files, are stored. These are organized by server name, such as `wlsdeploy/server/my-server/mykey.jks`.
8185

8286
#### `wlsdeploy/sharedLibraries`
8387
The root directory under which shared libraries are stored. These are stored as JAR files within the archive.
@@ -89,7 +93,7 @@ The root directory under which empty directories must exist for `FileStore` elem
8993

9094
The Create Domain, Update Domain, Deploy Applications, and Validate Model Tools allow the specification of multiple archive files on the command line. For example:
9195

92-
weblogic-deploy\bin\createDomain.cmd -archive_file one.zip,two.zip,three.zip ...
96+
$ weblogic-deploy\bin\createDomain.cmd -archive_file one.zip,two.zip,three.zip ...
9397

9498
File resources can be present in any of these archives. Resources in each archive will supersede resources found in previous archives.
9599

documentation/1.9/content/concepts/model.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ The second method for locating the Kubernetes secret file is to use the environm
172172
```
173173
If the `<name>` value has a corresponding mapped directory in `WDT_MODEL_SECRETS_NAME_DIR_PAIRS`, then that directory will take precedence over any roots specified in `WDT_MODEL_SECRETS_DIRS`.
174174

175-
NOTE: It is important that the secrets directories contain only secrets files, because those files are examined to create a list of available name/key pairs.
175+
{{% notice note %}} It is important that the secrets directories contain only secrets files, because those files are examined to create a list of available name/key pairs.
176+
{{% /notice %}}
176177

177178
**Path tokens** are tokens that reference known values, and can be used to make the model more portable. For example, a model may reference a WebLogic library source path as:
178179
```yaml
@@ -259,13 +260,13 @@ This feature can also remove items that were created by WebLogic Server template
259260

260261
This feature does not apply to named security providers within a realm. These items follow a special set of rules that are required to maintain their ordering. See [Modeling security providers]({{< relref "/samples/securityproviders-model.md" >}}) for detailed information.
261262

262-
This feature cannot be use to un-deploy applications or remove libraries.
263+
This feature cannot be use to undeploy applications or remove libraries.
263264

264265
### Using multiple models
265266

266267
The Create Domain, Update Domain, Deploy Applications, and Validate Model Tools allow the specification of multiple models on the command line. For example:
267268

268-
weblogic-deploy\bin\createDomain.cmd -model_file modelOne,modelTwo,modelThree ...
269+
$ weblogic-deploy\bin\createDomain.cmd -model_file modelOne,modelTwo,modelThree ...
269270

270271
In this case, the models are merged into a single model before being applied. Each successive model is added to the previous model. In cases where entities exist in both models, the attributes are combined and attribute values from successive models prevail. The resulting model is then verified before being applied.
271272
For example, if Model 1 looks like:

documentation/1.9/content/developer/buildWDT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If you are using an IDE for development and building, creating a `maven-config`
3131

3232
If you are making changes to the project, you can build the project using this command line:
3333

34-
`mvn -Dunit-test-wlst-dir=<wlst-directory> clean install`
34+
`$ mvn -Dunit-test-wlst-dir=<wlst-directory> clean install`
3535

3636
This will build the entire project and run the unit tests. Omit the `-Dunit-test-wlst-dir=` argument if you have created a `maven.config` file, as described above.
3737

@@ -40,6 +40,6 @@ the -D setting will take precedence.
4040

4141
If you are not making changes and are only interested in building the latest version, then you can skip the unit tests, using this command line:
4242

43-
`mvn -DskipTests clean install`
43+
`$ mvn -DskipTests clean install`
4444

4545
The resulting installer ZIP file built is under the `WLSDEPLOY_HOME/installer/target` directory.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Contribute to WDT"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 6
6+
---
7+
8+
Oracle welcomes contributions to this repository from anyone.
9+
10+
If you want to submit a pull request to fix a bug or enhance an existing feature,
11+
first open an issue and link to that issue when you submit your pull request.
12+
13+
If you have any questions about a possible submission, feel free to open an issue too.
14+
15+
### 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).
17+
18+
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.
19+
20+
Signed-off-by: Your Name <[email protected]>
21+
22+
This can be automatically added to pull requests by committing with:
23+
24+
$ git commit --signoff
25+
26+
Only pull requests from committers that can be verified as having signed the OCA can be accepted.
27+
28+
### Pull request process
29+
30+
1. Fork this repository.
31+
2. Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, for example, 1234-fixes.
32+
3. Ensure that any documentation is updated with the changes that are required by your fix.
33+
4. Ensure that any samples are updated if the base image has been changed.
34+
5. Squash your branch changes into a single commit.
35+
6. Submit the pull request.
36+
37+
a. Do not leave the pull request blank.
38+
39+
b. Explain exactly what your changes are meant to do and provide simple steps on how to validate your changes.
40+
41+
c. Ensure that you reference the issue you created as well.
42+
43+
7. We will assign someone to review the pull request before it is merged.

documentation/1.9/content/samples/cluster-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ topology:
4747
ClassPath: '/foo/bar,wlsdeploy/classpathLibraries/mylib.jar'
4848
```
4949
There are additional sub-folders and attributes available for more configuration options. These can be determined using the [Model Help Tool]({{< relref "/userguide/tools/model_help.md" >}}). For example, this command will list the attributes and sub-folders for the `Server` folder:
50-
```yaml
51-
${WDT_HOME}/bin/modelHelp.sh -oracle_home /tmp/oracle topology:/Server
50+
```bash
51+
$ ${WDT_HOME}/bin/modelHelp.sh -oracle_home /tmp/oracle topology:/Server
5252
```
5353

5454
For this sample, the machine named `machine-1` and the data source named `jdbc-1` should be defined elsewhere within this model, or should already exist in a domain that is being updated.

documentation/1.9/content/samples/jdbc-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ resources:
3131
Value: scott
3232
```
3333
There are additional sub-folders and attributes available for more configuration options. These can be determined using the [Model Help Tool]({{< relref "/userguide/tools/model_help.md" >}}). For example, this command will list the attributes and sub-folders for the `JDBCSystemResource/JdbcResource` folder:
34-
```yaml
35-
${WDT_HOME}/bin/modelHelp.sh -oracle_home /tmp/oracle resources:/JDBCSystemResource/JdbcResource
34+
```bash
35+
$ ${WDT_HOME}/bin/modelHelp.sh -oracle_home /tmp/oracle resources:/JDBCSystemResource/JdbcResource
3636
```
3737

3838
For this sample, the target cluster `cluster-1` should be defined elsewhere within this model, or should already exist in a domain that is being updated.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "A model for configuring Oracle Diagnostic Logging (ODL)."
77
---
88

99

10-
Oracle Diagnostic Logging (ODL) can be configured and updated with Create Domain, Update Domain, and Deploy Applications Tool, starting with WDT release 1.5.2.
10+
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.
1212
This example shows how some common configuration elements can be represented in the model.
1313

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

Lines changed: 4 additions & 4 deletions
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 Tool, 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.
1010

1111
#### Prerequisites
1212

@@ -24,7 +24,7 @@ The revised value would be:
2424
```
2525
The file name of this new domain type (without the `.json` extension) is used with the `-domain_type` argument on the WDT command line. For example, the command line to create a domain using the `HttpServer.json` file from the previous steps would look like:
2626
```
27-
WLSDEPLOY_HOME/bin/createDomain -oracle_home /etc/oracle ... -domain_type HttpServer
27+
$ WLSDEPLOY_HOME/bin/createDomain -oracle_home /etc/oracle ... -domain_type HttpServer
2828
```
2929

3030
#### Configuring the model
@@ -50,6 +50,6 @@ Each name under the `OHS` folder must match a name under the `SystemComponent` f
5050
The `ComponentType` field of the `SystemComponent` element must be set to `OHS` in order to allow configuration of the corresponding `OHS` folders.
5151

5252
You can use the [Model Help Tool]({{< relref "/userguide/tools/model_help.md" >}}) to determine the complete list of folders and attributes that can be used in these sections of the model. For example, this command will list the attributes in the `OHS` folder:
53-
```yaml
54-
${WDT_HOME}/bin/modelHelp.sh -oracle_home /tmp/oracle resources:/OHS
53+
```bash
54+
$ ${WDT_HOME}/bin/modelHelp.sh -oracle_home /tmp/oracle resources:/OHS
5555
```

documentation/1.9/content/samples/securityproviders-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ description: "Special handling and model semantics for WebLogic Server security
109109
Here is an example of how to prepare and install a schema file from its MBean Jar File (MJF):
110110

111111
```bash
112-
export CONFIG_JVM_ARGS=-DSchemaTypeSystemName=TrustServiceIdentityAsserter
112+
$ export CONFIG_JVM_ARGS=-DSchemaTypeSystemName=TrustServiceIdentityAsserter
113113
114-
ORACLE_HOME/oracle_common/common/bin/prepareCustomProvider.sh -mjf=ORACLE_HOME/oracle_common/modules/oracle.jps/jps-wls-trustprovider.jar -out ORACLE_HOME/oracle_common/lib/schematypes/jps-wls-trustprovider.schema.jar
114+
$ ORACLE_HOME/oracle_common/common/bin/prepareCustomProvider.sh -mjf=ORACLE_HOME/oracle_common/modules/oracle.jps/jps-wls-trustprovider.jar -out ORACLE_HOME/oracle_common/lib/schematypes/jps-wls-trustprovider.schema.jar
115115
116116
```
117117
For FMW versions 12.1.2 and 12.1.3, replace `oracle.jps` in the example path above with:

0 commit comments

Comments
 (0)