Skip to content

Commit 30a28b8

Browse files
ddsharpeddsharpe
committed
preparing for 2.0 documentation
1 parent f9fe49c commit 30a28b8

File tree

185 files changed

+9098
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

185 files changed

+9098
-0
lines changed

‎documentation/2.0/.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"git.ignoreLimitWarning": true
3+
}

‎documentation/2.0/archetypes/default.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
draft: false
5+
---
6+

‎documentation/2.0/config.toml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# analytics
2+
googleAnalytics = "UA-129126578-2"
3+
4+
baseURL = "/weblogic-deploy-tooling/"
5+
languageCode = "en-us"
6+
title = "WebLogic Deploy Tooling"
7+
8+
# Change the default theme to be use when building the site with Hugo
9+
theme = "hugo-theme-learn"
10+
11+
publishDir = "docs"
12+
13+
# For search functionality
14+
[outputs]
15+
home = [ "HTML", "RSS", "JSON"]
16+
17+
[params]
18+
# disable the copy to clipboard links
19+
disableInlineCopyToClipBoard = true

‎documentation/2.0/content/_index.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
## WebLogic Deploy Tooling
2+
3+
WebLogic Deploy Tooling (WDT) makes it easy to stand up WebLogic environments and perform
4+
domain lifecycle operations in a repeatable fashion based on a metadata model that
5+
can be treated as source and evolve as the project evolves.
6+
7+
Many organizations use WebLogic Server, with or without other Oracle Fusion Middleware components,
8+
to run their enterprise applications. And, as more and more of these organizations move toward Continuous Delivery
9+
of their applications, the importance of automated configuration application deployment grows. This automation
10+
is often implemented using the WebLogic Scripting Tool (WLST) configuration and deployment scripting language, but this is challenging.
11+
Such scripts must be carefully updated as the project evolves or the project is deployed to different environments,
12+
such as test to production.
13+
14+
WebLogic Deploy Tooling removes the need for most WebLogic Server deployments to rely on hand-coded WLST
15+
scripts for automating routine domain creation and application deployment tasks. It lets you write a
16+
declarative, metadata model, describing the domain and applications (with their dependent resources),
17+
and provides single-purpose tools that perform domain lifecycle operations based on the content of
18+
the model. It also lets you specify simple mutations suitable for moving your model between
19+
different environments, such as between test and production.
20+
21+
22+
WDT provides several single-purpose tools, all exposed as shell scripts (for both Windows and UNIX), that can:
23+
24+
* Create or update a domain.
25+
* Populate a domain with all the resources and applications specified in a model.
26+
* Add resources and applications to an existing domain.
27+
* Introspect an existing domain and create a model file describing the domain and an archive file of the binaries deployed to the domain.
28+
* Encrypt the passwords in a model (or its variable file).
29+
* Validate a model as well as provide model usage information.
30+
* Compare model files.
31+
* Prepare model files for deploying to the WebLogic Kubernetes Operator environment.
32+
* Generate a domain resource YAML file for use with the WebLogic Kubernetes Operator.
33+
* Tokenize a model with variables.
34+
* Provide information about the folders and attributes that are valid for sections and folders of a domain model.
35+
36+
For detailed information, see [WDT Tools]({{< relref "/userguide/tools/" >}}).
37+
38+
***
39+
### Current production release
40+
41+
WebLogic Deploy Tooling version and release information can be found [here](https://github.com/oracle/weblogic-deploy-tooling/releases).
42+
43+
***
44+
### Recent changes and known issues
45+
46+
See the [Release Notes]({{< relref "/release-notes.md" >}}) for known issues and workarounds.
47+
48+
### About this documentation
49+
50+
This documentation includes sections targeted to different audiences:
51+
52+
* [Concepts]({{< relref "/concepts/" >}}) explains the underlying metadata models and archive files.
53+
* The [User Guide]({{< relref "/userguide/" >}}) contains detailed usage information, including how to install and configure WebLogic Deploy Tooling, and how to use each tool.
54+
* The [Samples]({{< relref "/samples/" >}}) provide informative use case scenarios.
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" >}}).
58+
59+
### Related projects
60+
61+
* [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/)
62+
* [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/)
63+
* [WebLogic Kubernetes Toolkit UI](https://oracle.github.io/weblogic-toolkit-ui/)
64+
* [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter)
65+
* [WebLogic Logging Exporter](https://github.com/oracle/weblogic-logging-exporter)
66+
* [WebLogic Remote Console](https://github.com/oracle/weblogic-remote-console)

‎documentation/2.0/content/concepts/_index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
+++
2+
title = "Concepts"
3+
date = 2019-02-22T15:27:54-05:00
4+
weight = 1
5+
chapter = true
6+
pre = "<b> </b>"
7+
+++
8+
9+
# Concepts

‎documentation/2.0/content/concepts/archive.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: "Archive File"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 2
6+
---
7+
8+
9+
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.
10+
11+
Note that file resources that already exist on the target system need not be included in the archive, provided that the model specifies the correct location on the target system.
12+
13+
### Contents
14+
15+
- [Example](#example)
16+
- [Archive structure](#archive-structure)
17+
- [Using multiple archive files](#using-multiple-archive-files)
18+
19+
#### Example
20+
21+
This example shows an application with a `SourcePath` value referencing an EAR file resource contained in the archive.
22+
23+
```yaml
24+
appDeployments:
25+
Application:
26+
simpleear :
27+
SourcePath: wlsdeploy/applications/simpleear.ear
28+
Target: 'my-cluster'
29+
ModuleType: ear
30+
```
31+
32+
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 in the domain, in this case `<domain-home>/wlsdeploy/applications/simpleear.ear`.
33+
34+
### Archive structure
35+
36+
These are the paths within the archive that are used for different types of resources. Users can create further directory structures underneath these locations to organize the files and directories as they see fit.
37+
38+
#### `atpwallet`
39+
40+
The directory where a wallet can be stored for use with Oracle Autonomous Transaction Processing Cloud Database. 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.
41+
42+
#### `model`
43+
The directory where the model is optionally located. Only one model file, either in YAML or JSON, is allowed, and it must have the appropriate YAML or JSON file extension.
44+
45+
#### `opsswallet`
46+
47+
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.
48+
49+
#### `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.
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+
57+
```
58+
wlsdeploy/applications/myApp/index.jsp
59+
wlsdeploy/applications/myApp/META-INF/MANIFEST.MF
60+
wlsdeploy/applications/myApp/WEB-INF/classes/MyClass.class
61+
wlsdeploy/applications/myApp/WEB-INF/web.xml
62+
wlsdeploy/applications/myApp/WEB-INF/weblogic.xml
63+
```
64+
65+
#### `wlsdeploy/classpathLibraries`
66+
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.
67+
68+
#### `wlsdeploy/coherence`
69+
The root directory under which empty directories must exist for Coherence persistent stores.
70+
71+
#### `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.
73+
74+
#### `wlsdeploy/domainBin`
75+
The root directory under which `$DOMAIN_HOME/bin` scripts are stored. Only scripts referenced in the `domainInfo/domainBin` section of the model are extracted.
76+
77+
#### `wlsdeploy/domainLibraries`
78+
The root directory under which `$DOMAIN_HOME/lib` libraries are stored. Only libraries referenced in the `domainInfo/domainLibraries` section of the model are extracted.
79+
80+
#### `wlsdeploy/nodeManager`
81+
The root directory under which Node Manager file resources, such as keystore files, are stored.
82+
83+
#### `wlsdeploy/scripts`
84+
The root directory under which scripts are stored. These can include JDBC create scripts, and WLDF action scripts.
85+
86+
#### `wlsdeploy/servers`
87+
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`.
88+
89+
#### `wlsdeploy/sharedLibraries`
90+
The root directory under which shared libraries are stored. These are stored as JAR files within the archive.
91+
92+
#### `wlsdeploy/stores`
93+
The root directory under which empty directories must exist for `FileStore` elements in the model.
94+
95+
### Using multiple archive files
96+
97+
The Create Domain, Update Domain, Deploy Applications, and Validate Model Tools allow the specification of multiple archive files on the command line. For example:
98+
99+
$ weblogic-deploy\bin\createDomain.cmd -archive_file one.zip,two.zip,three.zip ...
100+
101+
File resources can be present in any of these archives. Resources in each archive will supersede resources found in previous archives.
102+
103+
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.
104+
105+
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.
106+
107+
Resources that are extracted without being referenced directly are extracted from the archives in the order specified in the `archive_file` argument. For example, if `one.zip` and `two.zip` have resources under `wlsdeploy/classpathLibraries`, the resources in `one.zip` will be extracted to `<domain-home>/wlsdeploy/classpathLibraries`, then the resources of `two.zip` will be extracted to the same location, overwriting any overlapping files.

0 commit comments

Comments
 (0)