|
1 | 1 | # WebLogic Image Tool |
2 | 2 |
|
3 | | -**NOTE: The upcoming change to Oracle Support's recommended patches list will require |
4 | | -Image Tool 1.9.11 in order to use `--recommendedPatches` or `--latestPSU`.** |
5 | | - |
6 | 3 | Oracle is finding ways for organizations using WebLogic Server to run important workloads, to move those workloads into |
7 | 4 | the cloud, and to simplify and speed up the application deployment life cycle. By adopting industry standards, such as Docker |
8 | 5 | and Kubernetes, WebLogic now runs in a cloud neutral infrastructure. To help simplify and automate the creation of |
9 | | -Docker images for WebLogic Server, we are providing this open source |
10 | | -WebLogic Image Tool. This tool let's you create a new Linux based image, with installations of a JDK and WebLogic Server, |
11 | | -and optionally, configure a WebLogic domain with your applications, apply WebLogic Server patches, or update an existing |
12 | | -image. |
13 | | - |
14 | | -## Features |
15 | | - |
16 | | -The Image Tool provides three functions within the main script: |
17 | | - - [Create Image](site/create-image.md) - The `create` command creates a new Docker image and installs the requested |
18 | | - Java and WebLogic software. Additionally, you can create a WebLogic domain in the image at the same time. |
19 | | - - [Rebase Image](site/rebase-image.md) - The `rebase` command creates a new Docker image using an existing WebLogic |
20 | | - domain from an existing image. The new Docker image can start from an existing image with a JDK and Oracle |
21 | | - middleware installation, or can install the JDK and Oracle Home as part of moving the domain. |
22 | | - - [Update Image](site/update-image.md) - The `update` command creates a new Docker image by applying WebLogic patches |
23 | | - to an existing image. Additionally, you can create a WebLogic domain if one did not exist previously, update an |
24 | | - an existing domain, or deploy an application. |
25 | | - - [Cache](site/cache.md) - The Image Tool maintains metadata on the local file system for patches and installers. |
26 | | - The `cache` command can be used to manipulate the local metadata. |
27 | | - |
28 | | -## Prerequisites |
29 | | - |
30 | | -- Docker client and daemon on the build machine, with minimum Docker version 18.03.1.ce. |
31 | | -- Installers for WebLogic Server and JDK from the [Oracle Software Delivery Cloud](https://edelivery.oracle.com). |
32 | | -- For patches, [Oracle Support](https://www.oracle.com/technical-resources/) credentials. |
33 | | -- Bash version 4.0 or later, to enable the `<tab>` command complete feature. |
34 | | - |
35 | | -## Setup |
36 | | - |
37 | | -- Build the project (`mvn clean package`) to create the ZIP installer in `./imagetool/target`. |
38 | | -- Unzip the release ZIP file to a desired location. |
39 | | -- For Linux environment, `cd your_unzipped_location/bin` and `source setup.sh`. |
40 | | -- For Windows environment, `cd your_unzipped_location\bin` and `.\imagetool.cmd`. |
41 | | -- Run `imagetool help` to show the help text. |
42 | | - |
43 | | -## Quick Start |
44 | | - |
45 | | -Use the [Quick Start](site/quickstart.md) guide to create a Linux based WebLogic Docker image. |
| 6 | +container images for WebLogic Server, we are providing this open source WebLogic Image Tool (WIT). |
46 | 7 |
|
47 | | -## Building From Source |
| 8 | +WIT let's you create a new Linux based image, with installations of a JDK and WebLogic Server, and optionally, |
| 9 | +configure a WebLogic domain with your applications, apply WebLogic Server patches, or update an existing image. |
48 | 10 |
|
49 | | -The Image Tool installer is available for download on the [Releases](https://github.com/oracle/weblogic-image-tool/releases) page. |
50 | | -If you want to build the installer from source instead of downloading it, follow these instructions: |
51 | | -- Download and install JDK 8u261+ |
52 | | -- Download and install Maven 3.6.3+ |
53 | | -- Clone this repository to your local environment using one of the options under `Code` near the top of this page. |
54 | | -- From inside the top-level directory of the cloned project, `weblogic-image-tool`, using Maven, execute one or |
55 | | -more of these phases: |
56 | | - - `validate` - Validate the project is correct and all necessary information is available. |
57 | | - - `compile` - Compile the source code. |
58 | | - - `test` - Test the compiled source code using the JUnit5 framework. |
59 | | - - `package` - Create the installer ZIP file, `imagetool.zip`. |
60 | | - - `verify` - Run integration tests using the JUnit5 framework (Pre-requisite: Docker installed). |
61 | | - - `clean` - Restore the source by removing any items created by `package` or another phase of the build. |
62 | 11 |
|
63 | | -**Note:** Maven executes build phases sequentially, `validate`, `compile`, `test`, `package`, `verify`, such that |
64 | | -running `verify` will run all of these phases from `validate` through `package` before executing `verify`. |
| 12 | +With the Image Tool you can: |
65 | 13 |
|
66 | | -Because the `package` phase comes before the `verify` phase, it is not necessary to run the integration tests to create |
67 | | -the Image Tool installer. If you are making changes and want to validate those changes in your environment, you will |
68 | | -need to do some additional setup before running the `verify` phase because several of the integration tests require |
69 | | -access to the Oracle Technology Network. To run the integration tests in the |
70 | | -`verify` phase, you must specify three environment variables, `ORACLE_SUPPORT_USERNAME`, `ORACLE_SUPPORT_PASSWORD`, |
71 | | -and `STAGING_DIR`. The first two, Oracle Support user name and password, are used to connect to Oracle OTN for patches. |
72 | | -The third, `STAGING_DIR`, should be a local folder where WebLogic Server installers, JDK installers, and pre-downloaded |
73 | | -patches can be found. The files required in the `STAGING_DIR` depend on which tests that you want to run. |
| 14 | +* Create a Docker image and install the requested Java and WebLogic software. And, you can create a |
| 15 | +WebLogic domain in the image, at the same time. |
| 16 | +* Create a new Docker image using an existing WebLogic domain from an existing image. The Docker |
| 17 | +image can start from an existing image with a JDK and Oracle middleware installation, or can install |
| 18 | +the JDK and Oracle Home as part of moving the domain. |
| 19 | +* Create a new Docker image by applying WebLogic patches to an existing image. In addition, |
| 20 | + if one did not exist previously, you can create a WebLogic domain, update an existing domain, or deploy an application. |
74 | 21 |
|
75 | | -Example: Run a set of integration tests (available groups are `cache`, `gate`, and `nightly`: |
76 | | -```shell script |
77 | | -mvn verify -Dtest.groups=cache |
78 | | -``` |
| 22 | +For detailed information, see [Image Tool]({{< relref "/userguide/tools/_index.md" >}}). |
79 | 23 |
|
80 | | -Example: Run a single integration test: |
81 | | -```shell script |
82 | | -mvn verify -Dtest.groups=gate,nightly -Dit.test=ITImagetool#createWlsImg |
83 | | -``` |
| 24 | +*** |
| 25 | +### Current production release |
84 | 26 |
|
85 | | -Integration Test groups: |
86 | | -- `cache` - Tests that build and manipulate the Image Tool cache. |
87 | | -- `gate` - A basic set of integration tests that are used to validate merge requests, including building several |
88 | | -Docker image (~20 minutes) |
89 | | -- `nightly` - The full set of integration tests building various Docker images including JRF and WLS |
90 | | -installations (~2 hours) |
| 27 | +WebLogic Image Tool version and release information can be found [here](https://github.com/oracle/weblogic-image-tool/releases). |
91 | 28 |
|
92 | | -**Note:** In order to run an integration test that builds an image like `createWlsImg`, you must run the `cache` |
93 | | -group first in order to populate the cache with the WLS and JDK installers. |
| 29 | +**NOTE**: The upcoming change to Oracle Support's recommended patches list will require |
| 30 | +Image Tool 1.9.11 in order to use `--recommendedPatches` or `--latestPSU`. |
94 | 31 |
|
95 | | -## Samples |
| 32 | +# Documentation |
96 | 33 |
|
97 | | -* [Create an image with full Internet access](site/create-image-with-internet.md) |
98 | | -* [Create an image with no Internet access](site/create-image-no-internet.md) |
99 | | -* [Patch an existing image](site/patching-image.md) |
100 | | -* [Create an image with a WebLogic domain using the WebLogic Deploy Tool](site/create-image-wdt.md) |
| 34 | +Documentation for WebLogic Image Tool is [available here](https://oracle.github.io/weblogic-image-tool/). |
101 | 35 |
|
102 | | -## Additional tasks |
| 36 | +This documentation includes information for users and for developers. |
103 | 37 |
|
104 | | -* [Cleanup](site/cleanup.md) |
105 | | -* [Logging](site/logging.md) |
| 38 | +# Related projects |
106 | 39 |
|
| 40 | +* [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/) |
| 41 | +* [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) |
| 42 | +* [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter) |
| 43 | +* [WebLogic Logging Exporter](https://github.com/oracle/weblogic-logging-exporter) |
| 44 | +* [WebLogic Remote Console](https://github.com/oracle/weblogic-remote-console) |
107 | 45 |
|
108 | | -## Copyright |
109 | | -Copyright (c) 2019, 2021, Oracle and/or its affiliates. |
| 46 | +# Contributing |
| 47 | +Those who wish to contribute to the WebLogic Image Tool code will find useful information [here](https://github.com/oracle/weblogic-image-tool/blob/main/CONTRIBUTING.md). |
0 commit comments