Skip to content
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

WINDUP-2261: Updated OS details to indicate shared storage. #247

Merged
merged 1 commit into from
Jan 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file modified docs/topics/images/webconsole-architecture-empty-dir.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 18 additions & 9 deletions docs/topics/web-openshift-environment.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@
[[understanding_web_console_openshift_image]]
= Understanding the {WebNameTitle} OpenShift Image

Red Hat offers a containerized image for {ProductShortName}'s {WebName} that is designed for use with OpenShift. Using this image, developers can quickly and easily manage migration projects and analyze applications.
Red Hat offers containerized images for {ProductShortName} that are designed for use with OpenShift. Using these images developers can quickly and easily manage migration projects and analyze applications.

The OpenShift image includes three separate pods:
The OpenShift images include three separate pods:

* The executor, responsible for generating the analysis
* The executor, responsible for running the analysis and generating the reports
* The {WebName} interface and SSO, which provide access to the web console itself
* The PostgreSQL database, which stores the project's configuraton and analysis tracking information

A separate persistent volume is used for the {WebName} interface and the PostgreSQL pods; however, the executor's storage is dependent on the template used.

* The `web-template.json` is the default template used, and configures the executor pod to use a separate persistent volume.
+
.`web-template.json`
image::webconsole-architecture.png[web-template.json]

* The `web-template-empty-dir-executor.json` configures the executor pod to use temporary storage on a single machine, and has no defined persistent volume.
* The `web-template-empty-dir-executor.json` is the recommended template. It configures the executor pod to use temporary storage on a single machine, and has no defined persistent volume. The analysis data is sent between the executor and web console pods using a RESTful web service.
+
.`web-template-empty-dir-executor.json`
image::webconsole-architecture-empty-dir.png[web-template-empty-dir-executor.json]

* The `web-template-empty-dir-executor-shared-storage.json` is an alternative template available for use. This template configures the executor pod and the web console pod to use a shared persistent volume. All instances of these pods read and write to the same persistent volume, mounted as `ReadWriteMany` in OpenShift.
+
.`web-template-empty-dir-executor-shared-storage.json`
image::webconsole-architecture-shared-storage.png[web-template-empty-dir-executor-shared-storage.json]

[discrete]
== OpenShift Template Environment Variables

The OpenShift image environment variables are configured as a baseline for application analysis, and work well in a variety of environments. No additional configuration is required to perform an analysis.

The most common environment variables modified are the CPU and memory resources allocated to each image. These contain a pattern of `__NODE_NAME__` followed by `REQUESTED___RESOURCE__`. For instance, `EXECUTOR_REQUESTED_CPU` indicates the number of CPU cores to request for the executor pod, while `EXECUTOR_REQUESTED_MEMORY` indicates the amount of memory to request for the executor pod.

All of the environment variables are found within each template, along with a description of each.