Skip to content

Documentation for Create Auxiliary Image feature #323

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 9 commits into from
Nov 22, 2021
Merged

Documentation for Create Auxiliary Image feature #323

merged 9 commits into from
Nov 22, 2021

Conversation

ddsharpe
Copy link
Member

Update documentation version and project version to 1.10.0 for the release of createAuxImage.

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.

Few edits/one comment



The `createAuxImage` command helps build a container image from a given base OS image.
The required option for the command is marked. There are a number of optional parameters for the create feature.
Copy link
Member

@rosemarymarano rosemarymarano Nov 19, 2021

Choose a reason for hiding this comment

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

Just as a suggestion, I would reverse the order of these two sentences: There are a number of optional parameters for this feature. The required option for the command is marked.

| `--pull` | Always attempt to pull a newer version of base images during the build. | |
| `--tag` | (Required) Tag for the final build image. Example: `store/oracle/mydomain:1` | |
| `--target` | Select the target environment in which the created image will be used. Supported values: `Default` (Docker/Kubernetes), `OpenShift` | `Default` |
| `--wdtArchive` | A WDT archive zip file or comma-separated list of files. | |
Copy link
Member

Choose a reason for hiding this comment

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

zip -> ZIP


### Usage scenarios

The commands below assume that all the required WDT installer has been downloaded and added to the cache.
Copy link
Member

Choose a reason for hiding this comment

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

The commands below -> The following commands
assume that all the required WDT installer has been downloaded -> (this doesn't make sense to me, maybe) assume that the required WDT installer has been downloaded

@ddsharpe ddsharpe changed the title [WIP] Documentation for Create Auxiliary Image feature Documentation for Create Auxiliary Image feature Nov 19, 2021
| `--wdtModel` | A WDT model file or a comma-separated list of files. | |
| `--wdtModelHome` | The target location in the image to copy WDT model, variable, and archive files. | `{wdtHome}/models` |
| `--wdtVariables` | A WDT variables file or comma-separated list of files. | |
| `--wdtVersion` | WDT version to use. | `latest` |

Choose a reason for hiding this comment

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

WDT version to use --> WDT version to install in {wdtHome}/weblogic-deploy.

Does this support a none option? It's conceivable MII aux image users won't need a WDT install - it could already be available in a different aux image...

Copy link
Member

Choose a reason for hiding this comment

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

We can not assume that the WLS binary mage has WDT, most likely it will not have it. WLS images in OCR do not have WDT. Aux images are only for the MII use case which require WDT.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated --wdtVersion description. No, there is no none option included at this time.

Choose a reason for hiding this comment

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

MII use case requires WDT yes, but it can have multiple aux images, and only one of them needs to have a WDT install, if any (it could be none of them, since the main image could have the install).

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.

Approve with caveat: It's certainly not a showstopper, but I continue to think a "none" option for wdtVersion could be useful (or have a different setting like "--wdtInstall "included|none"). It's easily possible to need an aux image with only model files/archives where the WDT install is already included in a different aux image. (The WKO MII domain home source type supports using multiple aux images in the same domain.)

@ddsharpe ddsharpe merged commit 1fc1ecb into main Nov 22, 2021
@ddsharpe ddsharpe deleted the doc-1.10.0 branch November 22, 2021 16:32
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.

6 participants