Skip to content

Commit 3c246f9

Browse files
committed
Sample cleanup and minor changes.
1 parent d9d0739 commit 3c246f9

32 files changed

+354
-1955
lines changed

documentation/4.1/content/samples/domains/domain-home-on-pv/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Domain on PV"
33
date: 2019-02-23T17:32:31-05:00
44
weight: 4
5-
description: "Sample for creating a WebLogic domain home on a persistent volume (PV) for deploying the generated WebLogic domain."
5+
description: "Sample for creating and deploying a WebLogic domain on a persistent volume (PV)."
66
---
77

88
{{< table_of_contents >}}
@@ -14,15 +14,15 @@ This sample demonstrates deploying a
1414
with [Domain creation images]({{< relref "/managing-domains/domain-on-pv/domain-creation-images.md" >}}).
1515
The Domain on PV sample uses a WebLogic Deploy Tooling (WDT) model to specify your initial WebLogic configuration.
1616

17-
WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using model files, variable properties files, and application archives files. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/).
17+
WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using model files, variable properties files, and application archive files. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/).
1818

1919
For more information on Domain on PV, see the [Domain on PV]({{< relref "/managing-domains/domain-on-pv/_index.md" >}}) user documentation.
2020

2121
#### Domain on PV domain types (WLS and JRF)
2222

2323
Domain on PV is supported on two types of domains: a standard Oracle WebLogic Server (WLS) domain and an Oracle Fusion Middleware Infrastructure, Java Required Files (JRF) domain. This sample demonstrates both WLS and JRF domain types.
2424

25-
The JRF domain path through the sample includes additional steps required for JRF: deploying an infrastructure database, initializing the database using the Repository Creation Utility (RCU) tool, referencing the infrastructure database from the WebLogic configuration, setting an Oracle Platform Security Services (OPSS) wallet password, and exporting or importing an OPSS wallet file. JRF domains may be used by Oracle products that layer on top of WebLogic Server, such as SOA and OSB.
25+
The JRF domain path through the sample includes additional steps required for JRF: deploying an infrastructure database, referencing the infrastructure database from the WebLogic configuration, setting an Oracle Platform Security Services (OPSS) wallet password, and exporting or importing an OPSS wallet file. JRF domains may be used by Oracle products that layer on top of WebLogic Server, such as SOA and OSB.
2626

2727
#### Sample directory structure
2828

@@ -32,10 +32,10 @@ Location | Description |
3232
------------- | ----------- |
3333
`kubernetes/samples/scripts/create-weblogic-domain/domain-on-pv/domain-resources` | JRF and WLS Domain YAML files. |
3434
`kubernetes/samples/scripts/create-weblogic-domain/wdt-artifacts/archives` | Source code location for WebLogic Deploy Tooling application ZIP archives. |
35-
`kubernetes/samples/scripts/create-weblogic-domain/wdt-artifacts/wdt-model-files` | Staging for each model image's WDT YAML files, WDT properties, and WDT archive ZIP files. The directories in `model images` are named for their respective images. |
35+
`kubernetes/samples/scripts/create-weblogic-domain/wdt-artifacts/wdt-model-files` | Staging for each domain creation image's WDT YAML files, WDT properties, and WDT archive ZIP files. The directories in `wdt-model-files` are named for their respective images. |
3636
`kubernetes/samples/scripts/create-weblogic-domain/ingresses` | Ingress resources. |
3737
`kubernetes/samples/scripts/domain-lifecycle/opss-wallet.sh` | Utility script for exporting or importing a JRF domain OPSS wallet file. |
38-
`kubernetes/samples/scripts/domain-lifecycle/waitForDomain.sh` | Utility script that optionally waits for the pods in a domain to reach their expected `restartVersion`, `introspectVersion`, `Completed`, `image`, and `ready` state. |
38+
`kubernetes/samples/scripts/domain-lifecycle/waitForDomain.sh` | Utility script that optionally waits for the pods in a domain to reach their expected `Completed`, `image`, and `ready` state. |
3939
`kubernetes/samples/scripts/domain-lifecycle/domain-on-pv-helper.sh` | Utility script to examine or clean up the contents of shared directories on the persistent volume. |
4040

4141
#### Ensuring your Kubernetes cluster can access images

documentation/4.1/content/samples/domains/domain-home-on-pv/prerequisites.md

Lines changed: 13 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,6 @@ To do this, follow the same steps as the [Quick Start](https://oracle.github.io/
120120
```
121121
$ kubectl apply -f https://raw.githubusercontent.com/oracle/weblogic-kubernetes-operator/{{< latestMinorVersion >}}/kubernetes/samples/scripts/create-weblogic-domain/ingresses/traefik-ingress-sample-domain1-admin-server.yaml
122122
$ kubectl apply -f https://raw.githubusercontent.com/oracle/weblogic-kubernetes-operator/{{< latestMinorVersion >}}/kubernetes/samples/scripts/create-weblogic-domain/ingresses/traefik-ingress-sample-domain1-cluster-cluster-1.yaml
123-
$ kubectl apply -f https://raw.githubusercontent.com/oracle/weblogic-kubernetes-operator/{{< latestMinorVersion >}}/kubernetes/samples/scripts/create-weblogic-domain/ingresses/traefik-ingress-sample-domain2-cluster-cluster-1.yaml
124123
```
125124
126125
**NOTE**: We give each cluster ingress a different host name that is decorated using both its operator domain UID and its cluster name. This makes each cluster uniquely addressable even when cluster names are the same across different clusters. When using `curl` to access the WebLogic domain through the ingress, you will need to supply a host name header that matches the host names in the ingress.
@@ -160,19 +159,19 @@ for the Domain on PV sample.
160159
161160
**NOTE**: The requirements in this section are in addition to [Prerequisites for WLS and JRF domain types](#prerequisites-for-wls-and-jrf-domain-types).
162161
163-
A JRF domain requires an infrastructure database, initializing this database with RCU, and configuring your domain to access this database. For more details, see [JRF domain]({{< relref "/managing-domains/working-with-wdt-models/jrf-domain.md" >}}) in user documentation. You must perform all these steps _before_ you create your domain.
162+
A JRF domain requires an infrastructure database, and configuring your domain to access this database. For more details, see [JRF domain]({{< relref "/managing-domains/working-with-wdt-models/jrf-domain.md" >}}) in user documentation. You must perform all these steps _before_ you create your domain.
164163
165164
##### Set up and initialize an infrastructure database
166165
167-
A JRF domain requires an infrastructure database and requires initializing this database with a schema and a set of tables for each different domain. The following example shows how to set up a database and use the RCU tool to create the infrastructure schemas for two JRF domains. The database is set up with the following attributes:
166+
A JRF domain requires an infrastructure database and requires initializing this database with a schema and a set of tables for each different domain. The following example shows how to set up a database. The database is set up with the following attributes:
168167
169168
| Attribute | Value |
170169
| --------- | ----- |
171170
| database Kubernetes namespace | `default` |
172171
| database Kubernetes pod | `oracle-db` |
173172
| database image | `container-registry.oracle.com/database/enterprise:12.2.0.1-slim` |
174173
| database password | MY_DBA_PASSWORD |
175-
| infrastructure schema prefixes | `FMW1` and `FMW2` (for domain1 and domain2) |
174+
| infrastructure schema prefix | `FMW1` (for domain1) |
176175
| infrastructure schema password | MY_RCU_SCHEMA_PASSWORD |
177176
| database URL | `oracle-db.default.svc.cluster.local:1521/devpdb.k8s` |
178177
@@ -213,66 +212,25 @@ A JRF domain requires an infrastructure database and requires initializing this
213212
214213
**WARNING:** The Oracle Database images are supported only for non-production use. For more details, see My Oracle Support note: Oracle Support for Database Running on Docker (Doc ID 2216342.1).
215214
216-
217-
1. Use the sample script `create-rcu-schema.sh` in `/tmp/weblogic-kubernetes-operator/kubernetes/samples/scripts/create-rcu-schema` to create an RCU schema for each domain (schema prefixes `FMW1` and `FMW2`) in the database.
218-
219-
This script starts a pod named `rcu` in the `default` namespace (the same namespace as the database)
220-
and executes RCU setup script `createRepository.sh`.
221-
It assumes that the database URL is `oracle-db.default.svc.cluster.local:1521/devpdb.k8s` and the namespace is `default` by default.
222-
223-
- First, create a secret in the `default` namespace
224-
which contains the database's SYSDBA username and password
225-
in the secret's `sys_username` and `sys_password` fields,
226-
and also contains the password of your choice for RCU schemas:
227-
- In the local shell:
228-
```shell
229-
$ kubectl -n default create secret generic oracle-rcu-secret \
230-
--from-literal='sys_username=sys' \
231-
--from-literal='sys_password=MY_DBA_PASSWORD' \
232-
--from-literal='password=MY_RCU_SCHEMA_PASSWORD'
233-
```
234-
- Replace MY_DBA_PASSWORD with the same value that you chose when deploying the database.
235-
- Replace MY_RCU_SCHEMA_PASSWORD with your choice of RCU schema password.
236-
- Oracle passwords can contain upper case, lower case, digits, and special characters.
237-
Use only `_` and `#` as special characters to eliminate potential parsing errors in Oracle connection strings.
238-
- __Note__: Record or memorize the values you chose for MY_DBA_PASSWORD and MY_RCU_SCHEMA_PASSWORD. They will be be needed again in other parts of this sample.
239-
240-
- Second, run the script twice, once for each RCU schema prefix:
241-
```shell
242-
$ cd /tmp/weblogic-kubernetes-operator/kubernetes/samples/scripts/create-rcu-schema
243-
```
244-
```shell
245-
$ ./create-rcu-schema.sh -s FMW1 -i container-registry.oracle.com/middleware/fmw-infrastructure:12.2.1.4
246-
```
247-
```shell
248-
$ ./create-rcu-schema.sh -s FMW2 -i container-registry.oracle.com/middleware/fmw-infrastructure:12.2.1.4
249-
```
250-
251-
__NOTES__:
252-
- If your Kubernetes cluster nodes do not all have access to the FMW infrastructure image in a local cache, then deploy a Kubernetes `docker secret` to the default namespace with login credentials for `container-registry.oracle.com`, and pass the name of this secret as a parameter to `./create-rcu-schema.sh` using `-p your-image-pull-secret`. Alternatively, copy the FMW infrastructure image to each local Docker cache in the cluster. For more information, see the [Cannot pull image FAQ]({{<relref "/faq/cannot-pull-image">}}).
253-
- If you need to drop the repositories, use these commands:
254-
```shell
255-
$ ./drop-rcu-schema.sh -s FMW1
256-
```
257-
```shell
258-
$ ./drop-rcu-schema.sh -s FMW2
259-
```
260-
The drop command implicitly uses the same `rcu` pod and the same database credentials `oracle-rcu-secret` secret that
261-
you set up when you created the RCU schema.
262-
263-
264215
##### Important considerations for RCU model attributes, Domain fields, and secrets
265216
266217
To allow the operator to access the database and OPSS wallet, you must create an RCU access secret containing the database connect string, user name, and password that's referenced from your model and an OPSS wallet password secret that's referenced from your Domain before deploying your domain. It's also necessary to define an `RCUDbInfo` stanza in your model.
267218
268-
The sample includes examples of JRF models and Domain YAML files in the `/tmp/sample/model-images` and `/tmp/sample/domain-resources` directories, and instructions in the following sections will describe setting up the RCU and OPSS secrets.
219+
The sample includes examples of JRF models and Domain YAML files in the `/tmp/sample/wdt-artifacts/wdt-model-files` and `/tmp/sample/domain-resources` directories, and instructions in the following sections will describe setting up the RCU and OPSS secrets.
269220
270221
When you follow the instructions in the samples, avoid instructions that are `WLS` only, and substitute `JRF` for `WLS` in the corresponding model image tags and Domain YAML file names.
271222
272223
For example, in this sample:
273224
274-
- JRF Domain YAML files have an `configuration.opss.walletPasswordSecret` field that references a secret named `sample-domain1-opss-wallet-password-secret`, with a `walletPassword` of your choice.
225+
- [JRF Domain YAML](https://raw.githubusercontent.com/oracle/weblogic-kubernetes-operator/{{< latestMinorVersion >}}/kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/domain-resources/JRF/domain-on-pv-JRF-v1.yaml) file has an `configuration.opss.walletPasswordSecret` field that references a secret named `sample-domain1-opss-wallet-password-secret`, with a `walletPassword` of your choice.
226+
227+
- JRF domain creation image models have below `domainInfo -> RCUDbInfo` stanza that reference a `sample-domain1-rcu-access` secret with appropriate values for attributes `rcu_prefix`, `rcu_schema_password`, and `rcu_db_conn_string` for accessing the Oracle database that you deployed to the default namespace as one of the prerequisite steps.
275228
276-
- JRF image models have a `domainInfo -> RCUDbInfo` stanza that reference a `sample-domain1-rcu-access` secret with appropriate values for attributes `rcu_prefix`, `rcu_schema_password`, and `rcu_db_conn_string` for accessing the Oracle database that you deployed to the default namespace as one of the prerequisite steps.
229+
```
230+
RCUDbInfo:
231+
rcu_prefix: '@@SECRET:@@ENV:DOMAIN_UID@@-rcu-access:rcu_prefix@@'
232+
rcu_schema_password: '@@SECRET:@@ENV:DOMAIN_UID@@-rcu-access:rcu_schema_password@@'
233+
rcu_db_conn_string: '@@SECRET:@@ENV:DOMAIN_UID@@-rcu-access:rcu_db_conn_string@@'
234+
```
277235
278236
For important JRF domain information, refer to [JRF domains]({{< relref "/managing-domains/working-with-wdt-models/jrf-domain.md" >}}).

documentation/4.1/content/samples/domains/domain-home-on-pv/sample.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,6 @@ Run the following `kubectl` commands to deploy the required secrets:
6060
__NOTE:__ Substitute a password of your choice for `MY_WEBLOGIC_ADMIN_PASSWORD`. This
6161
password should contain at least seven letters plus one digit.
6262

63-
__NOTE:__ Substitute a password of your choice for `MY_RUNTIME_PASSWORD`. It should
64-
be unique and different than the admin password, but this is not required.
65-
6663
```shell
6764
$ kubectl -n sample-domain1-ns create secret generic \
6865
sample-domain1-weblogic-credentials \

documentation/4.1/content/samples/domains/model-in-image/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ your WebLogic domain home prior to deploying your Domain YAML file.
1616
Instead, Model in Image uses a
1717
WebLogic Deploy Tooling (WDT) model to specify your WebLogic configuration.
1818

19-
WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using model files, variable properties files, and application archives files. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/).
19+
WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using model files, variable properties files, and application archive files. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/).
2020

2121
Furthermore, the Model in Image auxiliary image option lets you supply your WDT models files, WDT variable files, and WDT archives files
2222
in a small separate image separate from your WebLogic image.

documentation/4.1/content/samples/domains/model-in-image/auxiliary-image-creation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ description: "Create WebLogic images using the WebLogic Image Tool and WebLogic
1313

1414
Auxiliary image creation step uses the WebLogic Image Tool to create a Model in Image `auxiliary image`. This image contains:
1515
- A WebLogic Deploy Tooling installation (expected in an image's `/auxiliary/weblogic-deploy` directory by default).
16-
- WDT model YAML file (model), WDT variable (property), and WDT archive ZIP (archive) files (expected in directory `/auxiliary/models` by default).
16+
- WDT model YAML file (model), WDT variable (property), and WDT archive ZIP (archive) files, expected in directory `/auxiliary/models` by default,
17+
which can include the following file types:
18+
- WDT model YAML file - A declarative definition of the domain configuration.
19+
- WDT variable file - A property file that maps names to values. These names can be referenced from the model file to allow a model to be used across environments by applying the variable file for a particular environment to the model.
20+
- WDT archive file - A ZIP file containing application binaries and other files and directories needed to run the domain.
1721

1822
### Auxiliary image creation
1923

documentation/4.1/content/samples/domains/model-in-image/cleanup.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To remove the resources you have created in these samples:
2929
$ kubectl delete namespace traefik
3030
```
3131

32-
3. If you set up a database for JRF or the Update 4 use case:
32+
3. If you set up a database for the Update 4 use case:
3333
```shell
3434
$ /tmp/weblogic-kubernetes-operator/kubernetes/samples/scripts/create-oracle-db-service/stop-db-service.sh
3535
```
@@ -54,9 +54,3 @@ To remove the resources you have created in these samples:
5454
```shell
5555
$ docker image rm wdt-domain-image:WLS-AI-v2
5656
```
57-
```shell
58-
$ docker image rm model-in-image:JRF-AI-v1
59-
```
60-
```shell
61-
$ docker image rm model-in-image:JRF-AI-v2
62-
```

documentation/4.1/content/samples/domains/model-in-image/initial.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@ weight: 2
1010

1111
In this use case, you set up an initial WebLogic domain. This involves:
1212

13-
- Using the [auxiliary image](#auxiliary-image) that you previously created, it contains:
14-
- A WDT archive ZIP file that contains your applications.
15-
- A WDT model that describes your WebLogic configuration.
16-
- A WDT installation that contains the binaries for running WDT.
13+
- Using the [auxiliary image](#auxiliary-image) that you previously created.
1714
- Creating secrets for the domain.
1815
- Creating a Domain YAML file for the domain that references your Secrets, auxiliary image, and a WebLogic image.
1916

documentation/4.1/content/samples/domains/model-in-image/update3.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,8 @@ Here are the steps for this use case:
5959
```shell
6060
$ cd /tmp/sample/wdt-artifacts/archives/archive-v2
6161
```
62-
```
63-
# Using the [WDT archive helper tool](#https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/archive_helper/), create the archive in the location that we will use later when we run the WebLogic Image Tool.
64-
```
62+
Using the [WDT archive helper tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/archive_helper/), create the archive in the location that we will use later when we run the WebLogic Image Tool.
63+
`
6564
```shell
6665
$ /tmp/sample/wdt-artifacts/weblogic-deploy/bin/archiveHelper.sh add application -archive_file=/tmp/sample/wdt-artifacts/wdt-model-files/WLS-v2/archive.zip -source=wlsdeploy/applications/myapp-v2
6766
```

0 commit comments

Comments
 (0)