Skip to content

Commit 116a565

Browse files
authored
Documentation for OHS configuration (#606)
* Issue #143 - Add documentation for OHS configuration * Issue #143 - Add documentation for OHS configuration * Issue #143 - Add documentation for OHS configuration * Issue #143 - Changes from document review * Issue #143 - Changes from review
1 parent 3b42a21 commit 116a565

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Many organizations are using WebLogic Server, with or without other Oracle Fusio
2626
- [Custom Security Providers](site/security_providers.md#custom-security-providers)
2727
- [Modeling WebLogic Users, Groups, and Roles](site/security_users_groups_roles.md)
2828
- [ODL Configuration](site/odl_configuration.md)
29+
- [Configuring Oracle HTTP Server (OHS)](site/ohs_configuration.md)
2930
- [Configuring Oracle WebLogic Server Kubernetes Operator](site/kubernetes.md)
3031
- [Variable Injection](site/variable_injection.md)
3132
- [Model Samples](site/samples/samples.md)

site/ohs_configuration.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## Configuring Oracle HTTP Server (OHS)
2+
3+
Starting with WDT 1.8.0, you can configure and update Oracle HTTP Server (OHS) using the Create Domain, Update Domain, and Deploy Applications Tools, in offline mode only. To discover the OHS configuration, use the Discover Domain Tool, in offline mode only.
4+
5+
### Prerequisites
6+
7+
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).
8+
9+
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](type_def.md).
10+
11+
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:
12+
```
13+
"extensionTemplates": [ "Oracle Restricted JRF", "Oracle Enterprise Manager-Restricted JRF" ],
14+
```
15+
The revised value would be:
16+
```
17+
"extensionTemplates": [ "Oracle Restricted JRF", "Oracle Enterprise Manager-Restricted JRF", "Oracle HTTP Server (Restricted JRF)" ],
18+
```
19+
The file name of this new domain type (without the `.json` extension) is used with the `-domain_type` argument on the WDT command line. For example, the command line to create a domain using the `HttpServer.json` file from the previous steps would look like:
20+
```
21+
WLSDEPLOY_HOME/bin/createDomain -oracle_home /etc/oracle ... -domain_type HttpServer
22+
```
23+
24+
### Configuring the Model
25+
26+
Configuring OHS typically involves adding two top-level folders to the `resources` section of the model, `SystemComponent` and `OHS`. Here is an example:
27+
```yaml
28+
resources:
29+
SystemComponent:
30+
'my-ohs':
31+
ComponentType: 'OHS'
32+
Machine: 'my-machine'
33+
OHS:
34+
'my-ohs':
35+
AdminHost: '127.0.0.1'
36+
AdminPort: '9324'
37+
ListenAddress: '127.0.0.1'
38+
ListenPort: '7323'
39+
SSLListenPort: '4323'
40+
ServerName: 'http://localhost:7323'
41+
```
42+
Each name under the `OHS` folder must match a name under the `SystemComponent` folder in the model, or the name of a `SystemComponent` element that has been previously created. In this example, the name `my-ohs` is in both places.
43+
44+
The `ComponentType` field of the `SystemComponent` element must be set to `OHS` in order to allow configuration of the corresponding `OHS` folders.
45+
46+
You can use the [Model Help Tool](model_help.md) to determine the complete list of folders and attributes that can be used in these sections of the model. For example, this command will list the attributes in the `OHS` folder:
47+
```yaml
48+
${WDT_HOME}/bin/modelHelp.sh -oracle_home /tmp/oracle resources:/OHS
49+
```

0 commit comments

Comments
 (0)