Skip to content

docs: clarify ZWES1601I message and explain fallback to legacy tokens #4397

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: clarify ZWES1601I message and explain fallback to legacy tokens #4397

wants to merge 3 commits into from

Conversation

@saurabh12nxf
Copy link
Contributor

Describe your pull request here:
This PR adds documentation for the ZWES1601I log message under the Zowe App Framework troubleshooting section.
It improves clarity by:

Stating explicitly that the ZSS server is ready.

Explaining what "fallback to legacy tokens" means.

Providing a link to relevant configuration documentation for enabling/disabling fallback.

This helps users better understand the message and what actions (if any) they can take.
Fixes #4386

List the file(s) included in this PR:
docs/stable/troubleshoot/app-framework/zss-error-codes.md

After creating the PR, follow the instructions in the comments.

@github-actions
Copy link

github-actions bot commented May 7, 2025

😺 Thank you for creating this PR!

Certain labels are needed to open a pull request in the docs-site repo, but it looks like you may not be able to add labels. That's because you either do not have permissions or you are using a fork in your PR. To publish your content to Zowe Docs, follow these steps.

  • Use comments to add labels to your pull request. Enter the /labels command in a comment to add the required review, area, and release label types.
    • Example: Enter /labels doc cli V2 to add the review: doc, area: cli, and version: V2 labels to your PR.
      • The review label indicates the kind of review your content requires. The area label indicates the content topic area. The release labels tells us the major release aligned with your content.
      • See the docs-site labels to see the labels are available for use.
    • To remove a label, use the minus sign: /labels -V2
  • Select the master branch if your PR updates content that is on the live site. Select docs-staging if your PR updates content for a future release. Use the v3-doc-branch for Zowe V3 content.
  • Notify the Doc Squad about this PR. If you don't know whom should review your content, message the #zowe-doc Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

Need help? Contact the Doc Squad in the #zowe-doc Slack channel.

@zowe-robot zowe-robot added the review: doc Needs review by Doc Squad member label May 7, 2025
@zowe zowe deleted a comment from saurabh12nxf May 7, 2025
@zowe-robot
Copy link
Contributor

/labels doc app-framework V2

The following labels are invalid: app-framework, V2

@zowe zowe deleted a comment from saurabh12nxf May 7, 2025
@zowe-robot
Copy link
Contributor

/labels doc area:app-framework release:stable

The following labels are invalid: area:app-framework, release:stable

@zowe-robot
Copy link
Contributor

/labels review: doc area: Zowe App Framework release: vNext

The following labels are invalid: review:, area:, Zowe, App, Framework, release:, vNext

@zowe zowe deleted a comment from saurabh12nxf May 7, 2025
@zowe zowe deleted a comment from saurabh12nxf May 7, 2025
@zowe-robot
Copy link
Contributor

/labels review: ,doc area:, Zowe, App, Framework ,release:, vNext

The following labels are invalid: review:, ,doc, area:,, Zowe,, App,, Framework, ,release:,, vNext

@zowe-robot
Copy link
Contributor

/labels area: Zowe App Framework release: vNext review: doc

The following labels are invalid: area:, Zowe, App, Framework, release:, vNext, review:, doc

@zowe zowe deleted a comment from saurabh12nxf May 7, 2025
@saurabh12nxf
Copy link
Contributor Author

/labels review: doc area: cli release: V3

anaxceron
anaxceron reviewed May 7, 2025
View reviewed changes
docs/appendix/zowe-glossary.md
A method of storing and managing Zowe CLI and Zowe Explorer *team* and *user* profiles introduced in Zowe Version 2.

This method saves team-specific profiles in the `zowe.config.json` configuration file and user-specific profiles in the `zowe.config.user.json` configuration file. The location of the configuration file determines whether these profiles are applied *globally* or *per project*.
This method saves team-specific profiles in the *zowe.config.json* configuration file and user-specific profiles in the *zowe.config.user.json* configuration file. These profiles are stored locally on the user's client system (e.g., in Visual Studio Code) and determine whether they are applied *globally* (to all projects) or *per project*. This configuration is for managing Zowe CLI and Explorer settings on the local client and does not store or affect z/OS configurations.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please undo this edit since it's already been addressed PR 4393

@anaxceron anaxceron requested a review from ArooshLele May 7, 2025 18:19
@anaxceron anaxceron added area: Zowe App Framework Related to the Zowe Application Framework release: V3 Zowe V3 content labels May 7, 2025
@ArooshLele ArooshLele added area: docs Documentation issue or issues that have documentation impact type: troubleshoot Troubleshooting tips and questions labels May 8, 2025
@github-actions
Copy link

github-actions bot commented May 8, 2025

🚀 Deployed on https://681ca8f858f5804ef881fa8d--zowe-docs-master.netlify.app

1000TurquoisePogs
1000TurquoisePogs requested changes May 8, 2025
View reviewed changes
docs/troubleshoot/app-framework/zss-error-codes.md
### ZWES1601I

Server is ready to accept JWT `with`(or `without`) fallback to legacy tokens
ZSS server is ready to accept JWT with (or without) fallback to legacy tokens.
Copy link
Member

Choose a reason for hiding this comment

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

You cannot made edits to this line.
This is the line the log prints out. If you edit it, it would be incorrect.

ZWES1601I Server is ready to accept JWT with fallback to legacy tokens

docs/troubleshoot/app-framework/zss-error-codes.md
**Reason:**

Server is ready to accept JWT `with` or `without` fallback to legacy tokens.
This message indicates that the ZSS (Zowe Security Server) has successfully started and is ready to accept JWT (JSON Web Token)-based authentication. Depending on your configuration, it may also accept legacy Zowe tokens as a fallback.
Copy link
Member

Choose a reason for hiding this comment

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

ZSS is not known as the "Zowe Security Server"
zowe.org and zss on github call it "Zowe System Services (ZSS)"

docs/troubleshoot/app-framework/zss-error-codes.md
**How to Configure Fallback:**

You can enable or disable fallback in your `zowe.yaml` configuration file.
Refer to: [Zowe Authentication Configuration](https://docs.zowe.org/stable/user-guide/configure-zowe-runtime/#authentication-configuration)
Copy link
Member

Choose a reason for hiding this comment

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

This link does not help explain this function.

docs/troubleshoot/app-framework/zss-error-codes.md

ZSS can support two types of authentication tokens:
- **JWT (JSON Web Tokens)** – the default and more secure method.
- **Legacy tokens** – used in older versions of Zowe.
Copy link
Member

Choose a reason for hiding this comment

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

"Legacy tokens" here means that something can log into ZSS with the non-JWT types of logins ( /login URL, basic auth, cert auth, etc)

@ArooshLele
Copy link
Collaborator

@saurabh12nxf
The text is reviewed by the SME and his feedback is provided. Please address his feedback.
Kindly note that you do not have an approval from @ArooshLele for now.

CC: @ArooshLele @anaxceron @janan07 @gauravs-20 @Gautham-coder @DivergentEuropeans

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anaxceron anaxceron anaxceron left review comments

@1000TurquoisePogs 1000TurquoisePogs 1000TurquoisePogs requested changes

@ArooshLele ArooshLele Awaiting requested review from ArooshLele

@Gautham-coder Gautham-coder Awaiting requested review from Gautham-coder

@DivergentEuropeans DivergentEuropeans Awaiting requested review from DivergentEuropeans

Requested changes must be addressed to merge this pull request.

Assignees

@saurabh12nxf saurabh12nxf

Labels

area: docs Documentation issue or issues that have documentation impact area: Zowe App Framework Related to the Zowe Application Framework release: V3 Zowe V3 content review: doc Needs review by Doc Squad member type: troubleshoot Troubleshooting tips and questions

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Issue with docs.zowe.org/stable/troubleshoot/app-framework/zss-error-codes/

6 participants

@saurabh12nxf @zowe-robot @ArooshLele @1000TurquoisePogs @anaxceron @Aura129