Skip to content

OWLS-83537 - Update domain home in image samples to use WIT instead of docker-images samples #2290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 109 commits into from
May 17, 2021

Conversation

alai8
Copy link
Member

@alai8 alai8 commented Mar 30, 2021

Update domain home in image samples under both create-weblogic-domain and create-fmw-infrastructure-domain to use WebLogic Image tool to create domain in image instead of using https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples.

Both WDT model and offline WLST scripts to create the WebLogic domain are supported.

Fix create-fmw-infrastructure-domain/domain-home-on-pv when configured to use WDT to create the domain home.

Add missing documentation for FMW Infrastructure Domain Home in Image sample.

Update ItFmwSample test to test both wdt and wlst for domain on pv

https://build.weblogick8s.org:8443/job/weblogic-kubernetes-operator-kind-new/4933/

alai8 added 30 commits February 5, 2021 21:15
Copy link

@tbarnes-us tbarnes-us left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks quite nice to me. I've posted a couple more minor doc comments.

@@ -5,15 +5,15 @@ weight: 3
description: "Sample for creating a WebLogic domain home inside an image, and the Domain YAML file for deploying the generated WebLogic domain."
---

The sample scripts demonstrate the creation of a WebLogic domain home in an image using one of the domain home in image samples in the Oracle WebLogic Server images [GitHub project](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples). The sample scripts have the option of putting the WebLogic domain log, server logs, server output files, and the Node Manager logs on an existing Kubernetes PersistentVolume (PV) and PersistentVolumeClaim (PVC). The scripts also generate the domain YAML file, which can then be used by the scripts or used manually to start the Kubernetes artifacts of the corresponding domain, including the WebLogic Server pods and services.
The sample scripts demonstrate the creation of a WebLogic domain home in an image using [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool) (WIT). The sample scripts have the option of putting the WebLogic domain log, server logs, server output files, and the Node Manager logs on an existing Kubernetes PersistentVolume (PV) and PersistentVolumeClaim (PVC). The scripts also generate the domain YAML file, which can then be used by the scripts or used manually to start the Kubernetes artifacts of the corresponding domain, including the WebLogic Server pods and services.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...generate the domain YAML file... => ...generate the domain resource YAML file...
We need to differentiate between the domain YAML that WDT uses and the domain YAML that the Operator uses. I would like to start referring to the YAML that the Operator uses as the domain resource, but open to other suggestions.


#### Prerequisites

Before you begin, read this document, [Domain resource]({{< relref "/userguide/managing-domains/domain-resource/_index.md" >}}).

The following prerequisites must be met prior to running the create domain script:

* The WebLogic Deploy Tooling (WDT) sample requires that `JAVA_HOME` is set to a Java JDK version 1.8 or later.
* The WebLogic Image Tool requires that `JAVA_HOME` is set to a Java JDK version 8 or later.
* The operator requires either Oracle WebLogic Server 12.2.1.3.0 with patch 29135930 applied, or Oracle WebLogic Server 12.2.1.4.0, or Oracle WebLogic Server 14.1.1.0.0. The existing WebLogic Server image, `container-registry.oracle.com/middleware/weblogic:12.2.1.3`, has all the necessary patches applied. For details on how to obtain or create the image, see [WebLogic Server images]({{< relref "/userguide/base-images/_index.md#create-or-obtain-weblogic-server-images" >}}).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you meant to say "The operator requires an image with either Oracle WebLogic Server 12.2.1.3...."

Use the following command to delete an image tagged with `domain-home-in-image:12.2.1.4`:

```shell
$ docker rmi domain-home-in-image:12.2.1.4
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only deletes the local image. Are you assuming that the k8s cluster is running locally, and that the image is only local?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am assuming the image is local. Should we modify to something like the following?

+When no longer needed, delete the generated image.
+If the image in in a local repository, use the following command to delete an image tagged with domain-home-in-image:12.2.1.4:

@tbarnes-us

This comment has been minimized.

@tbarnes-us
Copy link

tbarnes-us commented May 12, 2021

LGTM, I've approved, but do have one last general comment:

The Quick Start sample documentation does not mention that the createDomain.sh script implicitly downloads and uses WIT and WDT under /tmp/(inputs toolsDir). This is important and somewhat surprising behavior for a new user IMO.

So I think it'd help significantly to summarize the information in the domain-in-image's "The script will perform the following steps:" bullet list directly in the Quick Start documentation itself, just before the current Quick Start wording "For the detailed steps that the create-domain.sh script performs, see Domain Home In Image." Alternatively, reword the latter sentence to be less anodyne (highly encourage the reader to click through the link).

This would make the behavior of createDomain.sh much less of a mystery to new users, who, I think, aren't necessarily likely to click through the 'detailed steps' link.

Copy link
Member

@rosemarymarano rosemarymarano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks.

@rosemarymarano
Copy link
Member

Took your suggestion. See #2360

Copy link
Member

@sankarpn sankarpn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rjeberhard rjeberhard merged commit 1b7e236 into main May 17, 2021
@alai8 alai8 deleted the update-samples branch May 19, 2021 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants