Skip to content

Commit 717f30d

Browse files
authored
Added documentation for new target types (#1083)
* Added documentation for new target types * Provided link for "domain home resource types"
1 parent 3a583cc commit 717f30d

File tree

1 file changed

+28
-14
lines changed

1 file changed

+28
-14
lines changed

documentation/2.0/content/userguide/target_env.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,31 +37,45 @@ If a variable file is specified on the tool's command line using the `-variable_
3737

3838
These target environment configurations are included in the WebLogic Deploy Tooling installation.
3939

40-
#### The WebLogic Kubernetes Operator target
40+
#### The WebLogic Kubernetes Operator targets
4141

42-
You can apply this target environment by providing the command-line argument `-target wko`. It will provide this additional processing:
42+
You can use these targets to customize the model and create a domain resource file for use with WebLogic Kubernetes Operator. There are three targets for specific [domain home source types](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/choosing-a-model/):
4343

44-
- The `wko_operator_filter.py` filter will be applied to remove model elements that are not compatible with the Kubernetes environment
44+
- `wko` for [Model in Image](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/model-in-image/) deployments
45+
- `wko-dii` for Domain in Image deployments
46+
- `wko-pv` for Domain in PV deployments
47+
48+
Each of these targets provides this additional processing:
49+
50+
- The `wko_filter` filter will be applied to remove model elements that are not compatible with the Kubernetes environment, and adjust some attribute values
4551
- Variables will be injected into the model for port, host, and URL attributes
4652
- `lax` validation will be applied for the resulting model
47-
- Credentials in the model will be replaced with references to Kubernetes secrets, and a script to create those secrets will be produced
4853
- An additional Kubernetes resource file, `wko-domain.yaml`, will be produced, with cluster and naming information derived from the model
4954

50-
#### The Verrazzano target
55+
In addition, the `wko` target will replace credentials in the model with references to Kubernetes secrets, and produce a script to create those secrets. The `wko-dii` and `wko-pv` targets will replace credentials in the model with variable references.
56+
57+
#### The Verrazzano targets
5158

52-
You can apply this target environment by providing the command-line argument `-target vz`. It will provide this additional processing:
59+
You can use these targets to customize the model and create a domain resource file for use with Verrazzano. There are three targets for specific [domain home source types](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/choosing-a-model/):
5360

54-
- The `vz_filter.py` filter will be applied to remove model elements that are not compatible with the Kubernetes environment
61+
- `vz` for [Model in Image](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/model-in-image/) deployments
62+
- `vz-dii` for Domain in Image deployments
63+
- `vz-pv` for Domain in PV deployments
64+
65+
Each of these targets provides this additional processing:
66+
67+
- The `vz_filter` filter will be applied to remove model elements that are not compatible with the Kubernetes environment, and adjust some attribute values
5568
- Variables will be injected into the model for port, host, and URL attributes
5669
- `lax` validation will be applied for the resulting model
57-
- Credentials in the model will be replaced with references to Kubernetes secrets, and a script to create those secrets will be produced
58-
- One additional Kubernetes resource file, `vz-application.yaml`, will be produced, with cluster and data source information derived from the model
70+
- An additional Kubernetes resource file, `vz-application.yaml`, will be produced, with cluster and data source information derived from the model
71+
72+
In addition, the `vz` target will replace credentials in the model with references to Kubernetes secrets, and produce a script to create those secrets. The `vz-dii` and `vz-pv` targets will replace credentials in the model with variable references.
5973

6074
#### Generic Kubernetes target
6175

6276
You can apply this target environment by providing the command-line argument `-target k8s`. It will provide this additional processing:
6377

64-
- The `k8s_operator_filter.py` filter will be applied to remove model elements that are not compatible with the Kubernetes environment
78+
- The `k8s_filter` filter will be applied to remove model elements that are not compatible with the Kubernetes environment, and adjust some attribute values
6579
- Variables will be injected into the model for port, host, and URL attributes
6680
- `lax` validation will be applied for the resulting model
6781
- Credentials in the model will be replaced with references to Kubernetes secrets, and a script to create those secrets will be produced
@@ -105,10 +119,10 @@ A target environment is configured in a JSON file at this location:
105119
```
106120
$WLSDEPLOY_HOME/lib/target/<target-name>/target.json
107121
```
108-
The `<target-name>` value corresponds to the value of the `-target` argument on the tool's command line. The WLS installation includes three pre-defined targets:
109-
- [WebLogic Kubernetes Operator](#the-weblogic-kubernetes-operator-target) (named `wko`)
110-
- [Verrazzano](#the-verrazzano-target) (named `vz`)
111-
- [Kubernetes](#generic-kubernetes-target) (named `k8s`)
122+
The `<target-name>` value corresponds to the value of the `-target` argument on the tool's command line. The WLS installation includes pre-defined targets for these environments:
123+
- [WebLogic Kubernetes Operator](#the-weblogic-kubernetes-operator-targets)
124+
- [Verrazzano](#the-verrazzano-targets)
125+
- [Kubernetes](#generic-kubernetes-target)
112126

113127
You can define a new or extended target environment with a new `target-name` in the above location, or using a [Custom configuration]({{< relref "/userguide/tools-config/custom_config.md" >}}) directory, such as `$WDT_CUSTOM_CONFIG/target/<my-target-name>/target.json`.
114128

0 commit comments

Comments
 (0)