zowe / docs-site

Documentation for the Zowe project
https://docs.zowe.org/
Creative Commons Attribution 4.0 International
70 stars 134 forks source link

Document tips on (server) install verification #3092

Open 1000TurquoisePogs opened 1 year ago

1000TurquoisePogs commented 1 year ago

How do you know when Zowe is correctly installed? I encountered a user who was trying a zwe command recently, assuming it would do install verification, to prove that their install was fully operational.

When I interact with users, I have some things I look for in logs and in the browser to determine that the majority of the server configuration is correct and operational.

I don't think we have a page on this in the doc, and it could be pretty useful! Let's collect the tips we do have, and make a page out of that, and place it at the end of the install steps.

The same is true for the CLI & Explorers - users should have a way to know that their install is good.

1000TurquoisePogs commented 1 year ago

For me:

Good:

If you have the desktop enabled, log into it and open the editor. If you see your home folder and files in the editor, then you know that zss is working, the desktop is working, and if enabled the gateway is working.

If you have the gateway enabled, go to it in the browser. You should see 3 green checkmarks after a period of time, especially after ZWES1601I

ZWES1601I means Zowe is fully loaded (not guaranteed error free, just done with startup), but is only seen when both ZSS and gateway are enabled.

ZWED0031I means app-server is fully loaded, but you should verify the plugin load percent success is 100%, or else errors in the log will explain what plugins may be missing and why.

ZWEAM000I is a sign of Api gateway/discovery/catalog health, but does not indicate the servers are fully ready.

Bad:

If you see continuous ZWES1606W for a long time (ex 5 minutes) without a ZWES1601I, then something is wrong with SSO, check ZSS and gateway logs.

ZWES1014I should have RC=0, or else the ZSS-ZIS connection has some issue.

ZWES1060W would indicate a keystore misconfiguration, incompatibility, or lack of permissions with ZSS.

ZWEAG108E should not be seen, but usually means there is a zosmf certificate issue, or zosmf is not running.