Skip to content

Commit bf7da3f

Browse files
committed
Improve create -o documentation
1 parent 9c11910 commit bf7da3f

File tree

4 files changed

+15
-25
lines changed

4 files changed

+15
-25
lines changed

site/creating-domain.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,17 +139,15 @@ Oracle intends to remove these limitations in a future release.
139139
To execute the script and create a domain, issue the following command:
140140

141141
```
142-
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /scratch/user-projects:
143-
export OUTPUT_DIR="/path/to/weblogic-operator-output-directory"
144-
mkdir -p $OUTPUT_DIR
145-
./create-weblogic-domain.sh –i create-domain-job-inputs.yaml -o $OUTPUT_DIR
142+
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
143+
./create-weblogic-domain.sh –i create-domain-job-inputs.yaml -o /path/to/weblogic-operator-output-directory
146144
```
147145

148146
## What the script does
149147

150148
The script will perform the following steps:
151149

152-
* Create a directory for the generated Kubernetes YAML files for this domain. The pathname is $OUTPUT_DIR/weblogic-domains/<domainUID parameter from create-weblogic-domain-inputs.yaml.
150+
* Create a directory for the generated Kubernetes YAML files for this domain. The pathname is /path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID parameter from create-weblogic-domain-inputs.yaml.
153151
* Create Kubernetes YAML files based on the provided inputs.
154152
* Create a persistent volume for the shared state.
155153
* Create a persistent volume claim for that volume.

site/developer.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,14 @@ To run the tests, uncomment the following `execution` element in the `pom.xml` f
7676
These tests assume that the RBAC definitions exist on the Kubernetes cluster. To create them, update the inputs file and run the operator installation script with the "generate only" option as shown below (see the [installation](installation.md) page for details about this script and the inputs):
7777

7878
```
79-
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /scratch/user-projects:
80-
export OUTPUT_DIR="/path/to/weblogic-operator-output-directory"
81-
mkdir -p $OUTPUT_DIR
82-
./create-weblogic-operator.sh -g -i create-weblogic-operator-inputs.yaml -o $OUTPUT_DIR
79+
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
80+
./create-weblogic-operator.sh -g -i create-weblogic-operator-inputs.yaml -o /path/to/weblogic-operator-output-directory
8381
```
8482

85-
This will create a file called `$OUTPUT_DIR/weblogic-operators/weblogic-operator/weblogic-operator-security.yaml`, which you will need to apply to your cluster:
83+
This will create a file called `/path/to/weblogic-operator-output-directory/weblogic-operators/weblogic-operator/weblogic-operator-security.yaml`, which you will need to apply to your cluster:
8684

8785
```
88-
kubectl apply -f $OUTPUT_DIR/weblogic-operators/webogic-operator/weblogic-operator-security.yaml
86+
kubectl apply -f /path/to/weblogic-operator-output-directory/weblogic-operators/webogic-operator/weblogic-operator-security.yaml
8987
```
9088

9189
After this is done, and the `execution` is uncommented, the tests will run against your cluster.
@@ -125,10 +123,8 @@ Verify that you have the right image by running `docker images | grep webloogic-
125123
To create the Kuberentes YAML file to deploy the operator, update the inputs file (`create-weblogic-operator-inputs.yaml`) and make sure the `imagePullPolicy` is set to `Never` and the `image` matches the name you used in your `docker build` command. Then run the operator installation script to deploy the operator:
126124

127125
```
128-
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /scratch/user-projects:
129-
export OUTPUT_DIR="/path/to/weblogic-operator-output-directory"
130-
mkdir -p $OUTPUT_DIR
131-
./create-weblogic-operator.sh -i create-weblogic-operator-inputs.yaml -o $OUTPUT_DIR
126+
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
127+
./create-weblogic-operator.sh -i create-weblogic-operator-inputs.yaml -o /path/to/weblogic-operator-output-directory
132128
```
133129

134130

site/installation.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,17 +122,15 @@ To enable the ELK integration, set the `elkIntegrationEnabled` option to `true`.
122122
To deploy the operator, run the deployment script and give it the location of your inputs file:
123123

124124
```
125-
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /scratch/user-projects:
126-
export OUTPUT_DIR="/path/to/weblogic-operator-output-directory"
127-
mkdir -p $OUTPUT_DIR
128-
./create-weblogic-operator.sh –i /path/to/create-weblogic-operator-inputs.yaml -o $OUTPUT_DIR
125+
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
126+
./create-weblogic-operator.sh –i /path/to/create-weblogic-operator-inputs.yaml -o /path/to/weblogic-operator-output-directory
129127
```
130128

131129
## What the script does
132130

133131
The script will carry out the following actions:
134132

135-
* Create a directory for the generated Kubernetes YAML files for this operator. The pathname is $OUTPUT_DIR/weblogic-operators/<namespace parameter from create-weblogic-operator-inputs.yaml.
133+
* Create a directory for the generated Kubernetes YAML files for this operator. The pathname is /path/to/weblogic-operator-output-directory/weblogic-operators/<namespace parameter from create-weblogic-operator-inputs.yaml.
136134
* A set of Kubernetes YAML files will be created from the inputs provided in this directory.
137135
* A namespace will be created for the operator.
138136
* A service account will be created in that namespace.

site/manually-creating-domain.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,11 @@ If creating the domain manually, using a WLST script for example, the domain mus
1414
The `create-weblogic-domain.sh` script described in the previous section can be executed with the “-g” option, which will cause it to generate the YAML files but take no action at all against the Kubernetes environment. This is a useful way to create the sample YAML files needed to manually create a domain. Execute the script as follows:
1515

1616
```
17-
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /scratch/user-projects:
18-
export OUTPUT_DIR="/path/to/weblogic-operator-output-directory"
19-
mkdir -p $OUTPUT_DIR
20-
./create-weblogic-domain.sh –i create-weblogic-domain-inputs.yaml –g -o $OUTPUT_DIR
17+
# Choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
18+
./create-weblogic-domain.sh –i create-weblogic-domain-inputs.yaml –g -o /path/to/weblogic-operator-output-directory
2119
```
2220

23-
The following YAML files will be generated in the $OUTPUT_DIR/weblogic-domains/<domainUID> directory:
21+
The following YAML files will be generated in the /path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID> directory:
2422

2523
* `weblogic-domain-persistent-volume.yaml` can be customized and used to create the persistent volume for this domain.
2624
* `weblogic-domain-persistent-volume-claim.yaml` can be customized and used to create the persistent volume claim for this domain.

0 commit comments

Comments
 (0)