Skip to content

Commit e58a0fe

Browse files
authored
Documentation changes for target type changes (#1091)
* Added use_persistent_volume for target env file; other updates * Corrected typo * Corrected wording
1 parent 404e69d commit e58a0fe

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

documentation/2.0/content/userguide/target_env.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ In addition, the `wko` target will replace credentials in the model with referen
5656

5757
#### The Verrazzano targets
5858

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/):
59+
You can use these targets to customize the model and create a Kubernetes 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/):
6060

6161
- `vz` for [Model in Image](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/model-in-image/) deployments
6262
- `vz-dii` for Domain in Image deployments
@@ -111,13 +111,13 @@ create_paired_k8s_secret weblogic-credentials <user> <password>
111111
```
112112
The script should be updated with correct `<user>` and `<password>` values as required. It may be necessary to change the `NAMESPACE` and `DOMAIN_UID` variables at the top of the script if they are different in the target environment.
113113

114-
The script performs a check to determine if any generated secret names are more than 63 characters in length, because that will prevent them from being mounted correctly in the Kubernetes environment. If any secret names exceed this limit, they will need to be shortened in this script, in the model files, and in the domain resource file. Each shortened name should be distinct from other secret names.
114+
The script performs a check to determine if any generated secret names are more than 63 characters in length, because that will prevent them from being mounted correctly in the Kubernetes environment. If any secret names exceed this limit, they will need to be shortened in this script, in the model files, and in the Kubernetes resource file. Each shortened name should be distinct from other secret names.
115115

116116
### Target environment configuration files
117117

118118
A target environment is configured in a JSON file at this location:
119119
```
120-
$WLSDEPLOY_HOME/lib/target/<target-name>/target.json
120+
$WLSDEPLOY_HOME/lib/targets/<target-name>/target.json
121121
```
122122
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:
123123
- [WebLogic Kubernetes Operator](#the-weblogic-kubernetes-operator-targets)
@@ -143,6 +143,7 @@ Here is an example of a target environment file:
143143
"credentials_output_method" : "script",
144144
"exclude_domain_bin_contents": true,
145145
"wls_credentials_name" : "__weblogic-credentials__",
146+
"use_persistent_volume" : true,
146147
"additional_secrets": "runtime-encryption-secret",
147148
"additional_output" : "vz-application.yaml"
148149
}
@@ -179,6 +180,18 @@ This field specifies how the domain's `bin` directory contents should be handled
179180

180181
This field specifies a name for use with the WDT_MODEL_SECRETS_NAME_DIR_PAIRS environment variable to identify administration credential Secrets for the domain. This is useful when those Secrets are stored in a directory that does not follow the `<directory>/<name>/<key>` convention. For more information about using the WDT_MODEL_SECRETS_NAME_DIR_PAIRS environment variable, see [Model tokens]({{< relref "/concepts/model#model-tokens" >}}).
181182

183+
#### `use_persistent_volume`
184+
185+
This field specifies if the domain is to be created for the Domain in PV [domain home source type](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/choosing-a-model/). If set to `true`, volume information will be added to the Kubernetes resource file that is generated.
186+
187+
#### `additional_secrets`
188+
189+
This field specifies a comma-separated list of secret types that are to be included in the Kubernetes resource file and the create secrets script. There is one secret type available:
190+
- `runtime-encryption-secret` - this will add a `runtimeEncryptionSecret` attribute to the Kubernetes resource file with the value `<DOMAIN_UID>-runtime-encryption-secret`, and that secret name will be added to the [create secrets script](#the-create-secrets-script).
191+
182192
#### `additional_output`
183193

184-
You can use this field to create additional output for use in the target environment. The value is a comma-separated list of template files in the `$WLSDEPLOY_HOME/lib/target/<target-name>` directory. These templates are populated with information derived from the model, and written to a file with the same name in the specified output directory.
194+
You can use this field to create additional output for use in the target environment. The value is a comma-separated list of template files in the `$WLSDEPLOY_HOME/lib/targets/templates` directory. These templates are populated with information derived from the model, and written to a file with the same name in the specified output directory.
195+
196+
**Note: Prior to release 2.0.1, template files were stored in the `$WLSDEPLOY_HOME/lib/targets/<target-name>` directory.**
197+

0 commit comments

Comments
 (0)