Skip to content

Commit accfab7

Browse files
authored
redo introduction page (#7)
* redo introduction page
1 parent 0dcdb31 commit accfab7

File tree

3 files changed

+42
-38
lines changed

3 files changed

+42
-38
lines changed

README.md

Lines changed: 39 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,58 @@
11
# Oracle WebLogic Image Tool
22

3-
Containerization is taking over the software world. In this modern age of software development, Docker and Kubernetes
4-
have become the gold standard. To help customers stay at the forefront of this, Oracle has released the
5-
[WebLogic Server Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator). The operator helps
6-
customers move their workloads to the cloud via the Kubernetes (cloud neutral) route. Customers get to decide how
7-
to create the Docker images and apply patches to these images deployed by the Kubernetes operator. To help them
8-
with this effort, we have created the [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool).
9-
10-
## Table of Contents
11-
12-
- [Features](#features-of-the-oracle-weblogic-image-tool)
13-
- [Prerequisites](#prerequisites)
14-
- [Setup](#setup)
15-
- [Create Image](site/create-image.md)
16-
- [Update Image](site/update-image.md)
17-
- [Cache](site/cache.md)
18-
19-
## Features of the Oracle WebLogic Image Tool
20-
21-
The Oracle WebLogic Image Tool can create a WebLogic Docker image from any base image (for example, Oracle Linux, Ubuntu), install a given version of
22-
WebLogic (for example, 12.2.1.3.0), install a given JDK (for example, 8u202), apply selected patches, and create a domain with a given
23-
version of [WDT](https://github.com/oracle/weblogic-deploy-tooling). The tool can also update a Docker image either
24-
created using this tool or a Docker image built by the user (you should have an `ORACLE_HOME` `env` variable defined by
25-
applying selected patches).
26-
3+
Oracle is finding ways for organizations using WebLogic Server to run important workloads, to move those workloads into
4+
the cloud, and simplify and speedup application deployment lifecycle. By adopting on industry standards, such as Docker
5+
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
7+
Oracle WebLogic Image Tool. This tool let's you create a new image, with installations of a JDK and WebLogic Server,
8+
and optionally, configure a WebLogic domain with your applications, apply WebLogic Server patches, or update an existing
9+
image.
10+
11+
## Features
12+
13+
The Image Tool provides three functions within the main script:
14+
- [Create Image](site/create-image.md) - The `create` command helps build a WebLogic Docker image from a given base OS
15+
image.
16+
- [Update Image](site/update-image.md) - The `update` command can be used to apply WebLogic patches to an existing
17+
WebLogic Docker image.
18+
- [Cache](site/cache.md) - The Image Tool maintains a local file cache for patches and installers. The `cache`
19+
command can be used to manipulate the local file cache.
20+
2721
## Prerequisites
2822

29-
- Active Internet connection. The tool needs to communicate with Oracle support system.
30-
- Oracle support credentials. These are used to validate and download patches.
31-
- WebLogic and JDK installers from OTN / e-delivery. These should be available on local disk.
32-
- Docker client and daemon on the build machine.
23+
- Docker client and daemon on the build machine, with minimum Docker version 17.05+ to support multi-stage builds.
24+
- WebLogic Server and JDK installers from OTN / Oracle e-Delivery.
25+
- (For patches) Oracle support credentials.
3326
- Bash version 4.0 or higher to enable `<tab>` command complete feature
3427

3528
## Setup
3629

3730
- Build the project (`mvn clean package`) to generate artifacts `imagetool-0.1-SNAPSHOT.zip`.
38-
- Unzip to a desired location. This action should create lib, bin directories and LICENSE.txt.
31+
- Unzip the release ZIP file to a desired location.
3932
- If running an OS with bash, run `cd your_unzipped_location/bin` and `source setup.sh`.
4033
- On Windows, set up with `imagetool.cmd` or the `imagetool.bat` script:
4134
```cmd
4235
@ECHO OFF
4336
java -cp "your_unzipped_folder/lib" com.oracle.weblogic.imagetool.cli.CLIDriver %*
4437
```
45-
- Then, execute `imagetool help` to get the help screen.
38+
39+
## Help Command
40+
- After completing the [Setup](#Setup) steps, execute `imagetool help` to show the help screen.
4641
- You can execute the JAR directly using the command `java -cp "your_unzipped_folder/lib" com.oracle.weblogic.imagetool.cli.CLIDriver help`.
47-
- After you are familiar with the commands, you will be able to create and update WebLogic Docker images.
42+
43+
## Simple Example
44+
Let's give this a try!
45+
- Get the installers from Oracle e-Delivery
46+
- Add those installers to the Image Tool file cache
47+
- Assuming Docker is installed, run `imagetool create`!
48+
```bash
49+
unzip imagetool-0.1.zip
50+
cd imagetool-0.1/bin
51+
source setup.sh
52+
imagetool cache addInstaller --type jdk --version 8u202 --path /tmp/jdk-8u202-linux-x64.tar.gz
53+
imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /tmp/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
54+
imagetool create --tag sample:wls
55+
```
4856

4957
## Copyright
5058
Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.

site/cache.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Cache
22

3-
Use the `cache` command to add or edit the required metadata for the tool. Cache helps the tool to identify where the
4-
required installers (WLS, FMW, JDK) are located and where to download the patches. There are several subcommands:
3+
The image tool maintains a local file cache for patches and installers. The `cache` command can be used to manipulate
4+
the local file cache. There are several subcommands of the cache feature:
55

66
```
77
Usage: imagetool cache [COMMAND]

site/create-image.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
# Create Image
22

33
The `create` command helps build a WebLogic Docker image from a given base OS image. The required options for the command
4-
are marked with an asterisk (*). You can provide the password in one of the three ways:
5-
6-
* Plain text
7-
* Environment variable
8-
* File containing the password
4+
are marked with an asterisk (*). There are a number of optional parameters for the create feature.
95

106
```
117
Usage: imagetool create [OPTIONS]

0 commit comments

Comments
 (0)