|
1 | | -# Oracle WebLogic Server Deploy Tooling |
| 1 | +# WebLogic Deploy Tooling |
2 | 2 |
|
3 | | -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. The motivation for the Oracle WebLogic Server Deploy Tooling project is to remove the need for most users to write WLST scripts for routine domain creation and application deployment tasks. Instead, the project team 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 provided that perform domain lifecycle operations based on the content of the model. The goal is to make 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. |
| 3 | +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. The motivation for the WebLogic Deploy Tooling project is to remove the need for most users to write WLST scripts for routine domain creation and application deployment tasks. Instead, the project team 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 provided that perform domain lifecycle operations based on the content of the model. The goal is to make 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. |
4 | 4 |
|
5 | | -## Features of the Oracle WebLogic Server Deploy Tooling |
| 5 | +WDT provides several single-purpose tools, all exposed as shell scripts (for both Windows and UNIX), that can: |
6 | 6 |
|
7 | | -Currently, the project provides several single-purpose tools, all exposed as shell scripts (both Windows and UNIX scripts are provided): |
| 7 | +* Create or update a domain. |
| 8 | +* Populate a domain with all the resources and applications specified in a model. |
| 9 | +* Add resources and applications to an existing domain. |
| 10 | +* Introspect an existing domain and create a model file describing the domain and an archive file of the binaries deployed to the domain. |
| 11 | +* Encrypt the passwords in a model (or its variable file). |
| 12 | +* Validate a model as well as provide model usage information. |
| 13 | +* Compare model files. |
| 14 | +* Prepare model files for deploying to the WebLogic Kubernetes Operator environment. |
| 15 | +* Generate a domain resource YAML file for use with the WebLogic Kubernetes Operator. |
| 16 | +* Tokenize a model with variables. |
| 17 | +* Provide information about the folders and attributes that are valid for sections and folders of a domain model. |
8 | 18 |
|
9 | | -- The [Create Domain Tool](site/create.md) (`createDomain`) understands how to create a domain and populate the domain with all resources and applications specified in the model. |
10 | | -- The [Update Domain Tool](site/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. |
11 | | -- The [Deploy Applications Tool](site/deploy.md) (`deployApps`) understands how to add resources and applications to an existing domain, either in offline or online mode. |
12 | | -- The [Discover Domain Tool](site/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. |
13 | | -- The [Encrypt Model Tool](site/encrypt.md) (`encryptModel`) encrypts the passwords in a model (or its variable file) using a user-provided passphrase. |
14 | | -- The [Validate Model Tool](site/validate.md) (`validateModel`) provides both standalone validation of a model as well as model usage information to help users write or edit their models. |
15 | | -- The [Compare Model Tool](site/compare.md) (`compareModel`) compares two model files. |
16 | | -- The [Prepare Model Tool](site/prepare.md) (`prepareModel`) prepares model files for deploying to WebLogic Server Kubernetes Operator environment. |
17 | | -- The [Extract Domain Resource Tool](site/kubernetes.md) (`extractDomainResource`) generates a domain resource YAML for use with the Oracle WebLogic Server Kubernetes Operator. |
18 | | -- The [Variable Injector Tool](site/variable_injection.md) is used to tokenize a model with variables. |
19 | | -- The [Model Help Tool](site/model_help.md) (`modelHelp.sh`) provides information about the folders and attributes that are valid for sections and folders of a domain model. |
| 19 | +*** |
| 20 | +The [current release](https://github.com/oracle/weblogic-deploy-tooling/releases) of WebLogic Deploy Tooling is 1.9.12. |
20 | 21 |
|
21 | | -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. |
| 22 | +This release was published on April, 29, 2021. |
| 23 | +*** |
22 | 24 |
|
| 25 | +# Documentation |
23 | 26 |
|
24 | | -## Downloading and Installing the Software |
| 27 | +Documentation for WebLogic Deploy Tooling is [available here](https://oracle.github.io/weblogic-deploy-tooling/). |
25 | 28 |
|
26 | | -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. |
| 29 | +This documentation includes information for users and for developers. |
27 | 30 |
|
| 31 | +# Contributing |
28 | 32 |
|
29 | | -## Supported WLS Versions |
30 | | - |
31 | | -For the supported WebLogic Server and JDK versions required to run WebLogic Server Deploy Tooling, see [Supported WLS Versions](site/wls_versions.md). |
32 | | - |
33 | | - |
34 | | -## Concepts |
35 | | - |
36 | | -- [The Model](site/model.md) |
37 | | -- [The Archive File](site/archive.md) |
38 | | -- [Model Use Cases](site/use_cases.md) |
39 | | -- [Tools Configuration](site/tool_configuration.md) |
40 | | - |
41 | | -## Developer Guide |
42 | | - |
43 | | -For information for developers, see the [Developer Guide](site/developer/developer_guide.md). |
44 | | - |
45 | | -## Known Issues |
46 | | - |
47 | | -See the following list of [Known Issues](KnownIssues.md) and workarounds. |
| 33 | +Those who wish to contribute to the WebLogic Deploy Tooling code will find useful information [here](CONTRIBUTING.md). |
0 commit comments