Skip to content

Commit 37cc9c7

Browse files
cleanup
1 parent 10ec511 commit 37cc9c7

File tree

14 files changed

+45
-35
lines changed

14 files changed

+45
-35
lines changed

documentation/1.9/content/concepts/model.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ draft: false
55
weight: 1
66
---
77

8+
### Contents
9+
10+
- [Overview](#overview)
11+
- [Top-Level Sections](#top-level-model-sections)
12+
- [Simple Example](#simple-example)
13+
- [Model Names](#model-names)
14+
- [Model Tokens](#model-tokens)
15+
- [Model Semantics](#model-semantics)
16+
- [Declaring Named MBeans to Delete](#declaring-named-mbeans-to-delete)
17+
- [Using Multiple Models](#using-multiple-models)
18+
19+
### Overview
820

921
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.
1022

@@ -31,15 +43,6 @@ The model is written in YAML (or optionally, JSON). The YAML parser, built into
3143

3244
All assignment statements must have one or more spaces between the colon and the value. All comments must have a space after the pound sign (also known as hash) to be considered a comment. YAML doesn't allow comments in all locations. While the YAML parser used by the framework does not try to enforce these restrictions, it is likely that putting comments in some locations may cause parse errors since YAML is a difficult language to parse due to its complex indention rules.
3345

34-
### Contents
35-
36-
- [Top-Level Sections](#top-level-model-sections)
37-
- [Simple Example](#simple-example)
38-
- [Model Names](#model-names)
39-
- [Model Tokens](#model-tokens)
40-
- [Model Semantics](#model-semantics)
41-
- [Declaring Named MBeans to Delete](#declaring-named-mbeans-to-delete)
42-
- [Using Multiple Models](#using-multiple-models)
4346

4447
### Top-Level Model Sections
4548
The tooling has five top-level model sections:

documentation/1.9/content/concepts/target_env.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ $WLSDEPLOY_HOME/lib/target/<target-name>/target.json
3232
```
3333
The `<target-name>` value corresponds to the value of the `-target` argument on the tool's command line. The WLS installation includes two pre-defined targets:
3434
- [Weblogic Kubernetes Operator](#the-weblogic-kubernetes-operator-target) (named `k8s`)
35-
- [Verrazzano](#the-verrazzano-target) (named `vz`).
35+
- [Verrazzano](#the-verrazzano-target) (named `vz`)
3636

3737
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`.
3838

documentation/1.9/content/concepts/use_cases.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,8 @@ weight: 3
326326
```
327327
#### Trust Service Identity Asserter
328328

329-
**NOTE:** The Trust Identity Asserter Security Provider is installed by JRF in 12c versions and newer.
329+
{{% notice note %}} The Trust Identity Asserter Security Provider is installed by JRF in 12c versions and newer.
330+
{{% /notice %}}
330331

331332
The JRF installed Trust Identity Asserter does not supply a schema file by default. Before you can configure this asserter with WLST offline or WDT offline, you must first build the schema file using the `prepareCustomProvider` script.
332333

@@ -343,7 +344,8 @@ weight: 3
343344

344345
#### Custom Security Providers
345346

346-
**NOTE:** Creating and updating domains with custom security providers is limited to WebLogic version 12.1.2 and newer.
347+
{{% notice note %}} Creating and updating domains with custom security providers is limited to WebLogic version 12.1.2 and newer.
348+
{{% /notice %}}
347349

348350
Prior to using this tooling to create or update a domain with a custom security provider, there are several prerequisites. First, WebLogic Server requires the custom MBean JAR to be in the Oracle Home directory before it can be configured, `WLSERVER/server/lib/mbeantypes`. Second, WebLogic Scripting Tool, WLST, requires that the schema JAR be placed in the Oracle Home directory before WLST offline can be used to discover it or configure it, `ORACLEHOME/oracle_common/lib/schematypes`. Generating an MBean JAR documentation can be found in the WebLogic Server [documentation](https://docs.oracle.com/en/middleware/standalone/weblogic-server/14.1.1.0/devsp/generate_mbeantype.html). Generating the schema JAR can be done with the `prepareCustomProvider` script provided in the WebLogic Server installation.
349351

@@ -366,10 +368,10 @@ weight: 3
366368

367369

368370
### Modeling WebLogic Users, Groups, and Roles
369-
WebLogic Server has the ability to establish a set of users, groups, and global roles as part of the WebLogic domain creation. The WebLogic global roles become part of the WebLogic role mapper (i.e. `XACMLRoleMapper`) and are specified under `domainInfo` in the `WLSRoles` section. The users and groups become part of the Embedded LDAP server (i.e. `DefaultAuthenticator`) and are specified under `topology` in the `Security` section.
371+
WebLogic Server has the ability to establish a set of users, groups, and global roles as part of the WebLogic domain creation. The WebLogic global roles become part of the WebLogic role mapper (for example, `XACMLRoleMapper`) and are specified under `domainInfo` in the `WLSRoles` section. The users and groups become part of the Embedded LDAP server (for example, `DefaultAuthenticator`) and are specified under `topology` in the `Security` section.
370372

371373
#### WebLogic Global Roles
372-
The model allows for the definition of WebLogic roles that can augment the well known WebLogic global roles (e.g. `Admin`, `Deployer`, `Monitor`, ...) in addition to defining new roles. When updating the well known WebLogic roles, an `UpdateMode` can be specified as `{ append | prepend | replace }` with the default being `replace` when not specified. Also, when updating the well known roles, the specified `Expression` will be a logical `OR` with the default expression. The `Expression` value for the role is the same as when using the WebLogic `RoleEditorMBean` for a WebLogic security role mapping provider.
374+
The model allows for the definition of WebLogic roles that can augment the well known WebLogic global roles (for example, `Admin`, `Deployer`, `Monitor`, ...) in addition to defining new roles. When updating the well known WebLogic roles, an `UpdateMode` can be specified as `{ append | prepend | replace }` with the default being `replace` when not specified. Also, when updating the well known roles, the specified `Expression` will be a logical `OR` with the default expression. The `Expression` value for the role is the same as when using the WebLogic `RoleEditorMBean` for a WebLogic security role mapping provider.
373375

374376
For example, the `WLSRoles` section below updates the well known `Admin`, `Deployer` and `Monitor` roles while adding a new global role with `Tester` as the role name:
375377

@@ -394,7 +396,7 @@ weight: 3
394396
In addition, the `Expression` value can use the variable placeholder syntax specified when running the [Create Tool]({{< relref "/userguide/tools/create.md" >}}) as shown in the above example.
395397

396398
#### WebLogic Users and Groups
397-
The model allows for the definition of a set of users and groups that will be loaded into the WebLogic Embedded LDAP Server (i.e. `DefaultAuthenticator`). New groups can be specified and users can be added as members of the new groups or existing groups such as the `Administrators` group which is defaulted to be in the WebLogic `Admin` global role. Please see Known Limitations below for additional information on users and groups.
399+
The model allows for the definition of a set of users and groups that will be loaded into the WebLogic Embedded LDAP Server (for example, `DefaultAuthenticator`). New groups can be specified and users can be added as members of the new groups or existing groups such as the `Administrators` group which is defaulted to be in the WebLogic `Admin` global role. Please see Known Limitations below for additional information on users and groups.
398400

399401
The user password can be specified with a placeholder or encrypted with the [Encrypt Tool](encrypt.md). An example `Security` section that adds an additional group `AppMonitors`, adds two new users and places the users into groups is as follows:
400402

@@ -415,9 +417,9 @@ weight: 3
415417

416418
#### Known Limitations
417419

418-
- The processing of users, groups, and roles will only take place when using the [Create Domain Tool]({{< relref "/userguide/tools/create.md" >}})
419-
- WebLogic global roles are only supported with WebLogic Server version 12.2.1 or greater
420-
- WebLogic global roles are only updated for the WebLogic security XACML role mapping provider (i.e. `XACMLRoleMapper`)
420+
- The processing of users, groups, and roles will only take place when using the [Create Domain Tool]({{< relref "/userguide/tools/create.md" >}}).
421+
- WebLogic global roles are only supported with WebLogic Server version 12.2.1 or greater.
422+
- WebLogic global roles are only updated for the WebLogic security XACML role mapping provider (for example, `XACMLRoleMapper`).
421423
- The user and group processing is not complete, currently, users cannot be assigned to groups. Users created using the `Security` section are automatically added to the `Administrators` group and are not added to the groups specified. See [Known Issues]({{< relref "/release-notes#assigning-security-groups-to-users" >}}) for information about a patch for this issue.
422424

423425
### Modeling WebLogic User Password Credential Mapping

documentation/1.9/content/developer/buildWDT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Execution of the unit tests requires a WebLogic Server installation, because the
1919

2020
The WLST directory can be specified in one of two ways:
2121

22-
- Specify the `-Dunit-test-wlst-dir=<wlst-directory>` on the mvn command line.
22+
- Specify the `-Dunit-test-wlst-dir=<wlst-directory>` on the `mvn` command line.
2323

2424
- Create a file `.mvn/maven.config` file in the project directory, containing a single line with the `-Dunit-test-wlst-dir=<wlst-directory>` value. The `.mvn` directory contains a `maven.config-template` file that can be copied and used as a starting point.
2525

documentation/1.9/content/userguide/install.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ The following table specifies the supported WebLogic Server versions, along with
1919

2020
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.
2121

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.
22+
{{% notice 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+
{{% /notice %}}
2324

2425
| WebLogic Server Version | Tool JDK Version |
2526
|--------------------------|-------------------|

documentation/1.9/content/userguide/tools/compare.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To use the Compare Model Tool, simply run the `compareModel` shell script with t
1414

1515
For example, comparing the following models.
1616

17-
##### New Model
17+
#### New Model
1818

1919
```yaml
2020
domainInfo:
@@ -108,7 +108,7 @@ resources:
108108
JNDIName: jms/myUDQ
109109
```
110110
111-
##### Old Model
111+
#### Old Model
112112
113113
```yaml
114114
domainInfo:

documentation/1.9/content/userguide/tools/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Create Domain Tool"
33
date: 2019-02-23T17:19:24-05:00
44
draft: false
55
weight: 1
6-
description: "Understands how to create a domain and populate the domain with all resources and applications specified in the model."
6+
description: "Creates a domain and populates the domain with all the resources and applications specified in the model."
77
---
88

99

documentation/1.9/content/userguide/tools/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Deploy Applications Tool"
33
date: 2019-02-23T17:19:24-05:00
44
draft: false
55
weight: 3
6-
description: "Understands how to add resources and applications to an existing domain, either in offline or online mode."
6+
description: "Adds resources and applications to an existing domain, either in offline or online mode."
77
---
88

99

documentation/1.9/content/userguide/tools/discover.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ An example of using the domain type argument:
4141

4242
weblogic-deploy\bin\discoverDomain.cmd -oracle_home c:\wls12213 -domain_home domains\DemoDomain -archive_file DiscoveredDemoDomain.zip -model_file DiscoveredDemoDomain.yaml -domain_type RestrictedJRF
4343

44-
Before the model is persisted to the model file, any variable injectors or model filters are run, in that order. The final step is validation, which validates the contents of the model, archive and variable file. If the validation is successful, the model is persisted. For more information on these three topics, go to:
44+
Before the model is persisted to the model file, any variable injectors or model filters are run, in that order. The final step is validation, which validates the contents of the model, archive and variable file. If the validation is successful, the model is persisted. For more information on these three topics, see:
4545

4646
- [Variable Injection]({{< relref "/userguide/tools/variable_injection.md" >}})
4747
- [Model Filters]({{< relref "/concepts/tool_configuration#model-filters" >}})
@@ -68,10 +68,10 @@ Total: WARNING : 1 SEVERE : 0
6868
### Environmental Variables
6969
The following environment variables may be set.
7070

71-
- JAVA_HOME The location of the JDK. This must be a valid Java 7 or later JDK.
72-
- WLSDEPLOY_HOME The location of the WebLogic Deploy Tooling installation. By default, the location is calculated
71+
- `JAVA_HOME` The location of the JDK. This must be a valid Java 7 or later JDK.
72+
- `WLSDEPLOY_HOME` The location of the WebLogic Deploy Tooling installation. By default, the location is calculated
7373
from the location of the discoverDomain script.
74-
- WLSDEPLOY_PROPERTIES System properties that will be passed to WLST.
74+
- `WLSDEPLOY_PROPERTIES` System properties that will be passed to WLST.
7575

7676
### Opening an Issue against Discover Domain
7777

documentation/1.9/content/userguide/tools/encrypt.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ description: "Encrypts the passwords in a model (or its variable file) using a u
77
---
88

99

10-
**NOTE: To meet Oracle's security standards, the encryption algorithms require JDK 8 to execute.**
10+
{{% notice note %}} To meet Oracle's security standards, the encryption algorithms require JDK 8 to execute.
11+
{{% /notice %}}
1112

1213
Models contain WebLogic Server domain configuration. Certain types of resources and other configurations require passwords; for example, a JDBC data source requires the password for the user establishing the database connection. When creating or configuring a resource that requires a password, that password must be specified either in the model directly or in the variable file. Clear-text passwords are not conducive to storing configurations as source, so the Encrypt Model Tool gives the model author the ability to encrypt the passwords in the model and variable file using passphrase-based, reversible encryption. When using a tool with a model containing encrypted passwords, the encryption passphrase must be provided, so that the tool can decrypt the password in memory to set the necessary WebLogic Server configuration (which supports its own encryption mechanism based on a domain-specific key). While there is no requirement to use the WebLogic Deploy Tooling encryption mechanism, it is highly recommended because storing clear text passwords on disk is never a good idea.
1314

0 commit comments

Comments
 (0)