Skip to content

Commit e3a714f

Browse files
more sections
1 parent 83fcc73 commit e3a714f

File tree

10 files changed

+144
-31
lines changed

10 files changed

+144
-31
lines changed

documentation/1.9/content/_index.md

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,26 @@
33
Many organizations are using WebLogic Server, with or without other Oracle Fusion Middleware components, to run their enterprise applications. As more and more organizations move toward Continuous Delivery of their applications, the importance of automated testing grows. Automating WebLogic Server domain creation and application deployment with hand-coded WLST scripts is challenging. After those scripts exist for a project, they must be maintained as the project evolves. WebLogic Deploy Tooling (WDT) removes the need for most users to write WLST scripts for routine domain creation and application deployment tasks. Instead, you can write a declarative, metadata model describing the domain and applications (with their dependent resources), and use one or more of the single-purpose tools that perform domain lifecycle operations based on the content of the model. This makes it easy to stand up environments and perform domain lifecycle operations in a repeatable fashion based on a metadata model that can be treated as source and evolve as the project evolves.
44

55

6-
WDT provides several single-purpose tools, all exposed as shell scripts (for both Windows and UNIX):
6+
WDT provides several single-purpose tools, all exposed as shell scripts (for both Windows and UNIX). For detailed information, see [WDT Tools]({{< relref "/userguide/tools/" >}}).
77

8-
- 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.
9-
- 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.
10-
- 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.
11-
- 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.
12-
- The [Encrypt Model Tool]({{< relref "/encrypt.md" >}}) (`encryptModel`) encrypts the passwords in a model (or its variable file) using a user-provided passphrase.
13-
- 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.
14-
- The [Compare Model Tool]({{< relref "/compare.md" >}}) (`compareModel`) compares two model files.
15-
- The [Prepare Model Tool]({{< relref "/prepare.md" >}}) (`prepareModel`) prepares model files for deploying to WebLogic Kubernetes Operator environment.
16-
- The [Extract Domain Resource Tool]({{< relref "/kubernetes.md" >}}) (`extractDomainResource`) generates a domain resource YAML for use with the WebLogic Kubernetes Operator.
17-
- The [Variable Injector Tool]({{< relref "/variable_injection.md" >}}) is used to tokenize a model with variables.
18-
- 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.
198

20-
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.
9+
### Current production release
2110

11+
The current [release](https://github.com/oracle/weblogic-deploy-tooling/releases) of WebLogic Deploy Tooling is 1.9.11. This release was published on March, 2021.
2212

13+
### Recent changes and known issues
2314

24-
### Supported WLS Versions
15+
See the [Release Notes]({{< relref "/release-notes.md" >}}) for recent changes, known issues, and workarounds.
2516

26-
For the supported WebLogic Server and JDK versions required to run WebLogic Deploy Tooling, see [Supported WLS Versions]({{< relref "/wls_versions.md" >}}).
17+
### About this documentation
2718

19+
This documentation includes sections targeted to different audiences. To help you find what you are looking for more easily, please consult this table of contents:
2820

29-
## Concepts
21+
3022

31-
- [The Model]({{< relref "/model.md" >}})
32-
- [The Archive File]({{< relref "/archive.md" >}})
33-
- [Model Use Cases]({{< relref "/use_cases.md" >}})
34-
- [Tools Configuration]({{< relref "/tool_configuration.md" >}})
3523

36-
## Developer Guide
3724

38-
For information for developers, see the [Developer Guide]({{< relref "/developer/_index.md" >}}).
3925

40-
## Known Issues
4126

42-
See the following list of [Known Issues]({{< relref "/KnownIssues.md" >}}) and workarounds.
27+
### Contributing
28+
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).
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
+++
2+
title = "Concepts"
3+
date = 2019-02-22T15:27:54-05:00
4+
weight = 1
5+
chapter = true
6+
pre = "<b>1. </b>"
7+
+++

documentation/1.9/content/archive.md renamed to documentation/1.9/content/concepts/archive.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# The Archive File
1+
---
2+
title: "Archive File"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 2
6+
---
7+
28

39
The archive file is used to deploy binaries and other file resources to the target domain. The archive is a ZIP file with a specific directory structure. Any file resources referenced in the model that are not already on the target system must be stored in the correct location in the archive, and the model must reflect the path into the archive. The model itself can also be stored inside the archive, if desired.
410

@@ -51,7 +57,7 @@ wlsdeploy/applications/myApp/WEB-INF/weblogic.xml
5157
\* Expanded application directories are supported after WebLogic Deploy Tooling release 1.6.2
5258

5359
### `wlsdeploy/classpathLibraries`
54-
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.
60+
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.
5561

5662
### `wlsdeploy/coherence`
5763
The root directory under which empty directories must exist for Coherence persistent stores.
@@ -84,7 +90,7 @@ The Create Domain, Update Domain, Deploy Applications, and Validate Model Tools
8490
weblogic-deploy\bin\createDomain.cmd -archive_file one.zip,two.zip,three.zip ...
8591

8692
File resources can be present in any of these archives. Resources in each archive will supersede resources found in previous archives.
87-
93+
8894
When the model references a resource that is present in multiple archives, the latest in the list takes precedence. For example, if the model references `wlsdeploy/applications/myapp.ear`, and that resource is present in archives `one.zip` and `two.zip`, the resource in `two.zip` will be used.
8995

9096
A similar rule applies for resources that have an assumed location, but are not specifically called out in the model. For example, if archive `two.zip` has a wallet in location `atpwallet/wallet2.zip`, and `three.zip` has a wallet in location `atpwallet/wallet3.zip`, the wallet `atpwallet/wallet3.zip` will be used.

documentation/1.9/content/model.md renamed to documentation/1.9/content/concepts/model.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
## The Metadata Model
1+
---
2+
title: "Metadata Model"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 1
6+
---
7+
28

39
The metadata model (or model, for short) is a version-independent description of a WebLogic Server domain configuration. The tools are designed to support a sparse model so that the model need only describe what is required for the specific operation without describing other artifacts. For example, to deploy an application that depends on a JDBC data source into an existing domain that may contain other applications or data sources, the model needs to describe only the application and the data source in question. If the data source was previously created, the `deployApps` tool will not try to recreate it but may update part of that data source's configuration if the model description is different than the existing values. If the application was previously deployed, the `deployApps` tool will compare the binaries to determine if the application needs to be redeployed or not.
410

documentation/1.9/content/config/target_env.md renamed to documentation/1.9/content/concepts/target_env.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
## Target environments
1+
---
2+
title: "Target environments"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 4
6+
---
7+
28

39
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:
410
- Using model tokens for some attributes in the model (see [Model Tokens]({{< relref "/model#model-tokens" >}}))

documentation/1.9/content/tool_configuration.md renamed to documentation/1.9/content/concepts/tool_configuration.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
## Tools Configuration
1+
---
2+
title: "Tools Configuration"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 4
6+
---
7+
8+
9+
## Contents
210
- [Tool Property File](#tool-property-file)
311
- [Model Filters](#model-filters)
412
- [Target Environments](config/target_env.md)

documentation/1.9/content/use_cases.md renamed to documentation/1.9/content/concepts/use_cases.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
## Model Use Cases
1+
---
2+
title: "Model Use Cases"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 3
6+
---
7+
8+
9+
## Contents
210

311
- [Customizing the Administration Server](#administration-server-configuration)
412
- [Modeling a Configured Cluster](#configured-cluster-sample)
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
#### WDT Version 1.9.11
3+
4+
Issues addressed in this release:
5+
6+
* Fixed validate process to recognize float values as strings.
7+
* Fixed JMS Server issue with jarray in store.
8+
* Fixed issue with recognizing NodeManager properties user and password as credentials.
9+
* Fixed discovery of SAFRemoteContext.
10+
* Fixed discovery of ServerTemplate DataSource.
11+
12+
#### Known Issues for WebLogic Deploy Tooling
13+
14+
The following list contains known issues. Each issue may contain a workaround or an associated issue number.
15+
16+
##### Discover Domain Tool SEVERE Messages
17+
18+
**ISSUE**:
19+
The `discoverDomain` STDOUT contains many SEVERE messages about `cd()` and `ls()` when it is run against a 12.2.1.0 domain. The Discover Domain Tool navigates through the domain MBeans using WLST to determine which MBeans are present in a domain. When it tests an MBean that is not present, an error message is logged by WLST. There is no 12.2.1.0 PSU available to address this WLST problem. It is resolved in 12.2.1.1.
20+
21+
**ACTION**:
22+
Ignore the following messages logged during discovery of a 12.2.1.0 domain.
23+
```
24+
<Jan 14, 2019 1:14:21 PM> <SEVERE> <CommandExceptionHandler> <handleException> <> <Error: cd() failed.>
25+
<Jan 14, 2019 1:14:21 PM> <SEVERE> <CommandExceptionHandler> <handleException> <> <Error: ls() failed.>
26+
```
27+
28+
##### Create Domain Tool with 11g JRF Domains
29+
30+
**ISSUE**:
31+
The Create Domain Tool cannot initialize RCU for 11g JRF domains. The tool will issue error messages in the log and terminate the create process.
32+
33+
**ACTION**:
34+
Run the WLS `rcu` command before executing `createDomain` for JRF domains
35+
36+
##### Credential in Security Configuration
37+
38+
**ISSUE**: For WLS versions prior to 14.1.1, there is a problem setting the `CredentialEncrypted` attribute in the `topology/SecurityConfiguration` folder. The value is not encrypted properly in the configuration and the domain will fail to start with the error:
39+
```
40+
java.lang.IllegalArgumentException: In production mode, it's not allowed to set a clear text value to the property: CredentialEncrypted of SecurityConfigurationMBean
41+
```
42+
**ACTION**: Contact Oracle Support to obtain the patch for bug number 30874677 for your WebLogic Server version before running the tool.
43+
44+
##### Assigning Security Groups to Users
45+
46+
**ISSUE**: For WLS versions prior to 14.1.1, there is a problem setting the `GroupMemberOf` attribute in the `topology/Security/User` folder. The value is not persisted correctly, and the assignment will not be present when the domain is started.
47+
48+
**ACTION**: Contact Oracle Support to obtain the patch for bug number 30319071 for your WebLogic Server version before running the tool.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title = "Samples"
3+
date = 2019-02-22T15:27:54-05:00
4+
weight = 3
5+
chapter = true
6+
pre = "<b>3. </b>"
7+
+++
8+
9+
The samples provide demonstrations of how to accomplish common tasks.
10+
These samples are provided for educational and demonstration purposes only; they are not intended to be used in production deployments or to be depended upon to create production environments.

documentation/1.9/content/userguide/install.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,38 @@ date: 2019-02-23T17:19:24-05:00
44
draft: false
55
weight: 1
66
---
7+
78
#### Download and Install the Software
89

910
The WebLogic Deploy Tooling project repository is located at [`https://github.com/oracle/weblogic-deploy-tooling`](https://github.com/oracle/weblogic-deploy-tooling).
1011
Binary distributions of the `weblogic-deploy.zip` installer can be downloaded from the [GitHub Releases page](https://github.com/oracle/weblogic-deploy-tooling/releases).
1112

1213
1. To install the software, simply unzip the `weblogic-deploy.zip` installer on a machine that has the desired versions of WebLogic Server installed.
1314
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.
15+
16+
#### Supported WLS Versions
17+
18+
The following table specifies the supported WebLogic Server versions, along with the JDK versions, that must be used to run the WDT tool. You must set the `JAVA_HOME` environment variable to specify a JDK version different from the system default version.
19+
20+
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.
21+
22+
**Note**: The WDT 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.
23+
24+
| WebLogic Server Version | Tool JDK Version |
25+
|--------------------------|-------------------|
26+
| 10.3.6 | 1.7 |
27+
| 12.1.1 | 1.7, 1.8 |
28+
| 12.1.2 <sup>[1]</sup><sup>[2]</sup> | 1.7, 1.8 |
29+
| 12.1.3 | 1.7, 1.8 |
30+
| 12.2.1 <sup>[3]</sup> | 1.8 |
31+
| 12.2.1.1 <sup>[4]</sup> | 1.8 |
32+
| 12.2.1.2 | 1.8 |
33+
| 12.2.1.3 | 1.8 |
34+
| 12.2.1.4 <sup>[5]</sup> | 1.8 |
35+
| 14.1.1 | 1.8, 1.11 |
36+
37+
***1*** First release dynamic clusters are supported
38+
***2*** First release Coherence clusters are supported
39+
***3*** First release WLS roles are supported
40+
***4*** First release multitenancy is supported
41+
***5*** Last release multitenancy is supported

0 commit comments

Comments
 (0)