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

Update documentation with diagram describing behavior #135

Open
wants to merge 3 commits into
base: v3.x/staging
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Launcher.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ Copyright Contributors to the Zowe Project.
The Zowe launcher is a part of the Zowe server architecture that was added as an optional program for HA/FT usage in v1.
In v2, the Zowe laucher became the sole way to start the Zowe servers.
The launcher's purpose is to start, restart, and stop each Zowe server component which has a `start` command,
And in doing so it watches over such components for health (restarting them if they crash) and log management.
and in doing so it watches over such components for health (restarting them if they crash) and log management.

## Current features
* Stopping Zowe using the conventional `P` operator command
* Ability to handle modify commands
* Ability to handle `MODIFY` commands
* Stopping and starting specific Zowe components without restarting the entire Zowe

## Future features
* Issuing WTOs indicating the start and termination of specific components (this should simplify the integration with z/OS automation)
* Passing modify commands to Zowe components
* Passing `MODIFY` commands to Zowe components
* Clean termination of the components in case if the launcher gets cancelled

## Building
Expand Down Expand Up @@ -49,25 +49,33 @@ The launcher binary will be saved into the bin directory.

* To start the launcher use the `S` operator command:
```
S ZWELNCH
S ZWESLSTC
```
* To stop use the `P` operator command:
```
P ZWELNCH
P ZWESLSTC
```
* To stop a specific component use the following modify command:
* To stop a specific component use the following `MODIFY` command:
```
F ZWELNCH,APPL=STOP(component_name)
F ZWESLSTC,APPL=STOP(component_name)
```
* To start a specific component use the following modify command:
* To start a specific component use the following `MODIFY` command:
```
F ZWELNCH,APPL=START(component_name)
F ZWESLSTC,APPL=START(component_name)
```
* To list the components use the following modify command:
* To list the components use the following `MODIFY` command:
```
F ZWELNCH,APPL=DISP
F ZWESLSTC,APPL=DISP
```

## Community

This part of Zowe is currently developed by the zOS squad, which you can find on Slack at #zowe-zos-interface or
This part of Zowe is currently developed by the zOS squad, which you can find on Slack at [#zowe-zos-interface](https://openmainframeproject.slack.com/archives/C034VLT3W2G).

## Architecture

The launcher is a z/OS program which utilizes [configmgr](https://github.com/zowe/zowe-common-c/blob/v3.x/staging/c/configmgr.c) to read the Zowe config in order to determine which components to start, and then prepares Zowe to run, starts the components, and manages their unix processes.

It's behavior is summarized in this flow chart diagram.

![Launcher flow chart](./Launcher.svg)
Loading