Skip to content

Commit 89ca34c

Browse files
rosemarymaranoddsharpe
authored andcommitted
added arguments as a file documentation (#93)
1 parent d3be62a commit 89ca34c

File tree

5 files changed

+61
-11
lines changed

5 files changed

+61
-11
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Oracle is finding ways for organizations using WebLogic Server to run important workloads, to move those workloads into
44
the cloud, and to simplify and speed up the application deployment life cycle. By adopting industry standards, such as Docker
55
and Kubernetes, WebLogic now runs in a cloud neutral infrastructure. To help simplify and automate the creation of
6-
Docker images for WebLogic Server, we are providing this open-source
6+
Docker images for WebLogic Server, we are providing this open source
77
Oracle WebLogic Image Tool. This tool let's you create a new Linux based image, with installations of a JDK and WebLogic Server,
88
and optionally, configure a WebLogic domain with your applications, apply WebLogic Server patches, or update an existing
99
image.
@@ -36,7 +36,7 @@ The Image Tool provides three functions within the main script:
3636

3737
## Quick Start
3838

39-
Use the [Quick Start](site/quickstart.md) guide to create a Linux-based WebLogic Docker image.
39+
Use the [Quick Start](site/quickstart.md) guide to create a Linux based WebLogic Docker image.
4040

4141
## Samples
4242

site/create-image-with-internet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Create an image with full Internet access
22

3-
The Image Tool supports creating Linux-based WebLogic Docker images, applying WebLogic patches, and creating WebLogic domains. It can be used with or without Internet access.
3+
The Image Tool supports creating Linux based WebLogic Docker images, applying WebLogic patches, and creating WebLogic domains. It can be used with or without Internet access.
44

55
In this use case, the Image Tool will:
66

@@ -37,7 +37,7 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
3737

3838
Where ```--user --passwordEnv``` provides the credentials for a user who is entitled to download patches from Oracle Support.
3939

40-
**NOTE**: You can provide the password in one of the three ways:
40+
**NOTE**: You can provide the password in one of three ways:
4141

4242
* Plain text
4343
* Environment variable

site/create-image.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Usage: imagetool create [OPTIONS]
88

99
| Parameter | Definition | Default |
1010
| --- | --- | --- |
11-
|`--additionalBuildCommands`| Path to a file with additional build commands. For more details, see [Additional information](#additional_information). |
11+
|`--additionalBuildCommands`| Path to a file with additional build commands. For more details, see [Additional information](#additional-information). |
1212
|`--chown` | `userid:groupid` for JDK/Middleware installs and patches. | `oracle:oracle` |
1313
| `--docker` | Path to the Docker executable. | `docker` |
1414
| `--fromImage` | Docker image to use as a base image. | |
@@ -53,6 +53,30 @@ RUN rm /some/dir/unnecessary-file
5353
LABEL owner="middleware team"
5454
```
5555

56+
#### Use an argument file
57+
58+
You can save all arguments passed for the Image Tool in a file, then use the file as a parameter.
59+
60+
For example, create a file called `build_args`:
61+
62+
```bash
63+
create
64+
--type wls
65+
--version 12.2.1.3.0
66+
--tag wls:122130
67+
68+
--httpProxyUrl http://mycompany-proxy:80
69+
--httpsProxyUrl http://mycompany-proxy:80
70+
--passwordEnv MYPWD
71+
72+
```
73+
74+
Use it on the command line, as follows:
75+
76+
```bash
77+
imagetool @/path/to/build_args
78+
```
79+
5680

5781
## Usage scenarios
5882

site/quickstart.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
Use this Quick Start guide to create a Linux-based WebLogic Docker image.
3+
Use this Quick Start guide to create a Linux based WebLogic Docker image.
44

55
## Before you begin
66

@@ -34,9 +34,10 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
3434
```
3535

3636
You can verify the cache entries by:
37-
```bash
38-
imagetool cache listItems
39-
```
37+
38+
```bash
39+
imagetool cache listItems
40+
```
4041

4142
```bash
4243
Cache contents

site/update-image.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Update WebLogic Docker image with selected patches
2323
```
2424
| Parameter | Definition | Default |
2525
| --- | --- | --- |
26-
|`--additionalBuildCommands`| Path to a file with additional build commands. For more details, see [Additional information](#additional_information). |
26+
|`--additionalBuildCommands`| Path to a file with additional build commands. For more details, see [Additional information](#additional-information). |
2727
|`--chown` | `userid:groupid` for JDK/Middleware installs and patches. | `oracle:oracle` |
2828
| `--docker` | Path to the Docker executable. | `docker` |
2929
| `--fromImage` | (Required) Docker image to use as a base image. | |
@@ -54,7 +54,7 @@ Update WebLogic Docker image with selected patches
5454
## Additional information
5555
This section provides additional information for command-line parameters requiring more details or clarification.
5656

57-
#### `additionalBuildCommands`
57+
#### `--additionalBuildCommands`
5858

5959
This is an advanced option that let's you provide additional commands to the Docker build step.
6060
The input for this parameter is a simple text file that contains one or more of the valid sections: `before-jdk-install`, `after-jdk-install`, `before-fmw-install`, `after-fmw-install`, `before-wdt-command`, `after-wdt-command`, `final-build-commands`.
@@ -69,6 +69,31 @@ RUN rm /some/dir/unnecessary-file
6969
LABEL owner="middleware team"
7070
```
7171

72+
#### Use an argument file
73+
74+
You can save all arguments passed for the Image Tool in a file, then use the file as a parameter.
75+
76+
For example, create a file called `build_args`:
77+
78+
```bash
79+
create
80+
--type wls
81+
--version 12.2.1.3.0
82+
--tag wls:122130
83+
84+
--httpProxyUrl http://mycompany-proxy:80
85+
--httpsProxyUrl http://mycompany-proxy:80
86+
--passwordEnv MYPWD
87+
88+
```
89+
90+
Use it on the command line, as follows:
91+
92+
```bash
93+
imagetool @/path/to/build_args
94+
```
95+
96+
7297
## Usage scenarios
7398

7499
**Note**: Use `--passwordEnv` or `--passwordFile` instead of `--password`.

0 commit comments

Comments
 (0)