Skip to content

Commit d3d4975

Browse files
reorg ala Derek
1 parent 4c6e61b commit d3d4975

File tree

14 files changed

+50
-95
lines changed

14 files changed

+50
-95
lines changed

documentation/1.9/content/KnownIssues.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

documentation/1.9/content/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ For detailed information, see [WDT Tools]({{< relref "/userguide/tools/" >}}).
2222
***
2323
### Current production release
2424

25-
The current [release](https://github.com/oracle/weblogic-deploy-tooling/releases) of WebLogic Deploy Tooling is 1.9.12. This release was published on April, 29, 2021.
25+
WebLogic Deploy Tooling version and release information is found [here](https://github.com/oracle/weblogic-deploy-tooling/releases).
2626
***
2727
### Recent changes and known issues
2828

29-
See the [Release Notes]({{< relref "/release-notes.md" >}}) for recent changes, known issues, and workarounds.
29+
See the [Release Notes]({{< relref "/release-notes.md" >}}) for known issues and workarounds.
3030

3131
### About this documentation
3232

3333
This documentation includes sections targeted to different audiences:
3434

35-
* [Concepts]({{< relref "/concepts/" >}}) explains the underlying metadata models, archive files, tool configuration, and target environments.
35+
* [Concepts]({{< relref "/concepts/" >}}) explains the underlying metadata models and archive files.
3636
* The [User guide]({{< relref "/userguide/" >}}) contains detailed usage information, including how to install and configure WebLogic Deploy Tooling, and how to use each tool.
37-
* The [Samples]({{< relref "/samples/" >}}) provide detailed example code and instructions that show you how to perform various tasks.
37+
* The [Samples]({{< relref "/samples/" >}}) provide informative use case scenarios.
3838
* The [Developer guide]({{< relref "/developer/" >}}) provides details for people who want to understand how WDT is built, its features mapped and implemented.
3939

4040

documentation/1.9/content/concepts/model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ This feature can also remove items that were created by WebLogic Server template
257257
...
258258
```
259259

260-
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 "/concepts/use_cases#modeling-security-providers" >}}) for detailed information.
260+
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/use_cases#modeling-security-providers" >}}) for detailed information.
261261

262262
This feature cannot be use to un-deploy applications or remove libraries.
263263

documentation/1.9/content/ReleaseProcess.md renamed to documentation/1.9/content/developer/ReleaseProcess.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# WebLogic Deploy Tooling Project Release Process
1+
---
2+
title: "WDT Project Release Process"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 5
6+
---
7+
28
This document describes the process that should be followed to create a WebLogic Deploy Tooling (WDT) release.
39

4-
## Prerequisites
10+
### Prerequisites
511
- A local installation of WebLogic Server 12.2.1.x must be available.
6-
- The person running the release process must have admin privileges on the [WebLogic Deploy Tooling GitHub repo](https://github.com/oracle/weblogic-deploy-tooling) since the release process pushes to the master branch directly.
12+
- The person running the release process must have admin privileges on the [WebLogic Deploy Tooling GitHub repo](https://github.com/oracle/weblogic-deploy-tooling) because the release process pushes to the master branch directly.
713
- The person running the release process needs to create a GitHub Personal Access Token for the repository with (at least) the `repo:status`, `repo_deployment`, `public_repo`, and `security_events` privileges.
8-
- The person running the release needs a server added to their Maven `settings.xml` where the GitHub Personal Access Token is stored, as shown below. Note that this token can either be stored in plain text of encrypted using [Maven password encryption](https://maven.apache.org/guides/mini/guide-encryption.html).
14+
- The person running the release needs a server added to their Maven `settings.xml` file, where the GitHub Personal Access Token is stored, as shown below. Note that this token can either be stored in plain text or encrypted using [Maven password encryption](https://maven.apache.org/guides/mini/guide-encryption.html).
915

1016
```xml
1117
<servers>
@@ -16,23 +22,23 @@ This document describes the process that should be followed to create a WebLogic
1622
</servers>
1723
```
1824

19-
## Software Release Process
25+
### Software Release Process
2026
The best practice is to write the release notes that will be published to GitHub prior to starting the steps below.
2127

2228
1. Set (and export) the environment variable `WLST_DIR` to `<WLS-install-dir>/oracle_common/common/bin`, replacing `<WLS-install-dir>` with the full path to the WLS 12.2.1.x installation directory.
23-
2. In the weblogic-deploy-tooling project directory, create a file called `release.properties` with content similar to the example shown below. Note that the example is configured to cut the 1.9.11 release.
29+
2. In the `weblogic-deploy-tooling` project directory, create a file called `release.properties` with content similar to the example shown below. Note that the example is configured to cut the 1.9.11 release.
2430

2531
```properties
2632
tag=release-1.9.11
2733
releaseVersion=1.9.11
2834
developmentVersion=1.9.12-SNAPSHOT
2935
```
3036

31-
3. In the weblogic-deploy-tooling project directory, run the `mvn -B -P release release:prepare release:perform` command. If your SSH private key has a passphrase, watch the build closely since it will prompt for your passphrase multiple times. Failure to enter it in a timely manner may result in a failure.
32-
4. If the build fails, run the `mvn -B -P release release:rollback` command to undo it and start over from Step 2 after correcting the issue.
33-
5. Once the software has been released, move on to the GitHub Release Process.
37+
3. In the `weblogic-deploy-tooling` project directory, run the `mvn -B -P release release:prepare release:perform` command. If your SSH private key has a passphrase, watch the build closely because it will prompt for your passphrase multiple times. Failure to enter it in a timely manner may result in a failure.
38+
4. If the build fails, run the `mvn -B -P release release:rollback` command to undo it and start over from Step 2., after correcting the issue.
39+
5. After the software has been released, move on to the GitHub Release Process.
3440

35-
## GitHub Release Process
41+
### GitHub Release Process
3642
Note that this process relies on the WDT installers being in your local Maven repository. As such, it is critical for the same user to run these steps on the same machine as the steps from the previous section!
3743

3844
1. Save the release notes in the file `<wdt-project-directory>/target/ReleaseNotes.md`.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
+++
2+
title = "Reference"
3+
date = 2019-02-22T15:27:54-05:00
4+
weight = 5
5+
chapter = true
6+
pre = "<b>5. </b>"
7+
+++
8+
9+
# Reference

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: "Tools Configuration"
33
date: 2019-02-23T17:19:24-05:00
44
draft: false
5-
weight: 4
5+
weight: 2
66
---
77

88

99
#### Contents
1010
- [Tool Property File](#tool-property-file)
1111
- [Model Filters](#model-filters)
12-
- [Target Environments]({{< relref "/concepts/target_env.md" >}})
12+
- [Target Environments]({{< relref "/userguide/target_env.md" >}})
1313
- [Type Definitions](#domain-type-definitions)
1414
- [Variable Injection]({{< relref "/userguide/tools/variable_injection.md" >}})
1515
- [Custom Configuration](#custom-configuration)

documentation/1.9/content/release-notes.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,3 @@
1-
#### WDT Version 1.9.12
2-
3-
Additional features in this release:
4-
5-
* FMW Platform specific patches are now included in `--recommendedPatches` for all WLS-based installer types.
6-
* Java Required Files specific patches are now included in `--recommendedPatches` for all FMW-based installer types.
7-
8-
Issues addressed in this release:
9-
10-
* Increased the default version of HTTP retries to 10 to improve reliability with retrieving patch information from Oracle.
11-
12-
13-
#### WDT Version 1.9.11
14-
15-
Issues addressed in this release:
16-
17-
* Fixed validate process to recognize float values as strings.
18-
* Fixed JMS Server issue with jarray in store.
19-
* Fixed issue with recognizing NodeManager properties user and password as credentials.
20-
* Fixed discovery of SAFRemoteContext.
21-
* Fixed discovery of ServerTemplate DataSource.
22-
231
#### Known Issues for WebLogic Deploy Tooling
242

253
The following list contains known issues. Each issue may contain a workaround or an associated issue number.

documentation/1.9/content/samples/_index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ weight = 3
55
chapter = true
66
pre = "<b>3. </b>"
77
+++
8-
# Samples
8+
# Model Use Cases
99

10-
The samples provide demonstrations of how to accomplish common tasks.
11-
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.
10+
These typical use case scenarios show you how some common configurations can be represented in the model.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Model Use Cases"
33
date: 2019-02-23T17:19:24-05:00
44
draft: false
5-
weight: 3
5+
weight: 1
66
---
77

88

@@ -22,7 +22,7 @@ weight: 3
2222

2323
### Administration Server Configuration
2424

25-
The Create Domain Tool allows you to configure the Administration Server using a domain model. These examples show how some common configurations can be represented in the model.
25+
The Create Domain Tool lets you configure the Administration Server using a domain model. These examples show how some common configurations can be represented in the model.
2626

2727
#### Using the Default Administration Server Configuration
2828

@@ -80,7 +80,7 @@ weight: 3
8080
The name of the Administration Server cannot be changed after domain creation, so any changes to the `AdminServerName` attribute will be ignored by the Update Domain Tool.
8181

8282

83-
#### Configured Cluster Sample
83+
### Configured Cluster Sample
8484

8585
This WDT domain model sample section has a typical configuration for a configured cluster with a single managed server, including connection information, logging setup, and other details.
8686

@@ -130,7 +130,7 @@ weight: 3
130130
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.
131131

132132

133-
#### JDBC Sample
133+
### JDBC Sample
134134

135135
This WDT domain model sample section has a typical configuration for a JDBC data source, including targeting information, connection pool parameters, and other details.
136136

@@ -166,7 +166,7 @@ weight: 3
166166
It is recommended that credential fields, such as `PasswordEncrypted`, should not be stored as clear text in the model. Those values can be referenced in a separate variables file or in Kubernetes secrets, or the model can be encrypted using the [Encrypt Model Tool]({{< relref "/userguide/tools/encrypt.md" >}}).
167167

168168

169-
#### Work Manager Sample
169+
### Work Manager Sample
170170

171171
This WDT domain model sample section has typical configurations for a Work Manager and its related request classes and constraints. These elements are configured in the `SelfTuning` folder in the `resources` section of the model.
172172
```yaml
@@ -518,7 +518,7 @@ domainInfo:
518518

519519
In order to configure and use OHS, it must be installed in the Oracle Home directory used to create the domain. You can download OHS [here](https://www.oracle.com/middleware/technologies/webtier-downloads.html).
520520

521-
The OHS template must be present in the WDT domain type definition file used to create or update the domain. For more information on creating a custom definition, see [Domain Type Definitions]({{< relref "/concepts/tool_configuration#domain-type-definitions" >}}).
521+
The OHS template must be present in the WDT domain type definition file used to create or update the domain. For more information on creating a custom definition, see [Domain Type Definitions]({{< relref "/reference/tool_configuration#domain-type-definitions" >}}).
522522

523523
You create a copy of an existing domain type definition file, add the template to that file, and then reference that file on the WDT command line. For example, if you want to create a domain with Oracle HTTP Server based on a Restricted JRF domain, then you would first create a copy of the file `WLSDEPLOY_HOME/lib/typedefs/RestrictedJRF.json` in the same directory, such as `WLSDEPLOY_HOME/lib/typedefs/HttpServer.json`. In this example, you would change the existing `extensionTemplates` section to include the additional OHS template. The original value is:
524524
```

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: "Target environments"
33
date: 2019-02-23T17:19:24-05:00
44
draft: false
5-
weight: 5
5+
weight: 2
66
---
77

88

99
The [Discover Domain]({{< relref "/userguide/tools/discover.md" >}}) and [Prepare Model]({{< relref "/userguide/tools/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:
1010
- Using model tokens for some attributes in the model. See [Model Tokens]({{< relref "/concepts/model#model-tokens" >}}).
1111
- Using Kubernetes secrets for credentials in the model.
12-
- Applying filters to the model. See [Model Filters]({{< relref "/concepts/tool_configuration#model-filters" >}}).
12+
- Applying filters to the model. See [Model Filters]({{< relref "/reference/tool_configuration#model-filters" >}}).
1313
- Creating additional configuration files for the target system.
1414

1515
### Specifying a target environment
@@ -34,7 +34,7 @@ The `<target-name>` value corresponds to the value of the `-target` argument on
3434
- [Weblogic Kubernetes Operator](#the-weblogic-kubernetes-operator-target) (named `k8s`)
3535
- [Verrazzano](#the-verrazzano-target) (named `vz`)
3636

37-
You can define a new or extended target environment with a new `target-name` in the above location, or using a [Custom Configuration]({{< relref "/concepts/tool_configuration#custom-configuration" >}}) directory, such as `$WDT_CUSTOM_CONFIG/target/<my-target-name>/target.json`.
37+
You can define a new or extended target environment with a new `target-name` in the above location, or using a [Custom Configuration]({{< relref "/reference/tool_configuration#custom-configuration" >}}) directory, such as `$WDT_CUSTOM_CONFIG/target/<my-target-name>/target.json`.
3838

3939
Here is an example of a target environment file:
4040
```
@@ -55,7 +55,7 @@ Each of the fields in this example is optional, and can be customized.
5555

5656
#### `model_filters`
5757

58-
This field specifies the filters to be applied to the resulting model. This follows the same format and rules as the [Model Filters]({{< relref "/concepts/tool_configuration#model-filters" >}}) configuration. The `discover` type should always be used here.
58+
This field specifies the filters to be applied to the resulting model. This follows the same format and rules as the [Model Filters]({{< relref "/reference/tool_configuration#model-filters" >}}) configuration. The `discover` type should always be used here.
5959

6060
The `@@TARGET_CONFIG_DIR@@` token can be used to indicate that the specified filter is in the same directory as the target configuration file.
6161

0 commit comments

Comments
 (0)