Skip to content

Dividing mvd-configuration.md file into smaller topics #4787

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
ArooshLele wants to merge 65 commits into
base: master
Choose a base branch
from
Open

Dividing mvd-configuration.md file into smaller topics #4787

ArooshLele wants to merge 65 commits into from

Conversation

@ArooshLele
Copy link
Collaborator

@ArooshLele ArooshLele commented Nov 17, 2025 •
edited
Loading

List the file(s) included in this PR:
mvd-configuration.md

Describe your pull request here:
The mvd-configuration.md file has the Advanced Application Framework Configuration topic.
It is a large topic.
Following my discussion with Sean @1000TurquoisePogs , this large topic could be divided into smaller chunks/subtopics. The content stays the same.

The subtopic files would be as follows:

  • accessing-zss.md
  • configuration-file.md
  • configuring-the-framework-as-a-mediation-layer-client.md
  • setting-up-terminal-app-plugins.md
  • network-configuration.md
  • configuration-directories.md
  • app-plugin-configuration.md
  • logging-configuration.md
  • zss-configuration-1.md
  • using-multiple-zis-instances.md
  • controlling-access-to-apps.md
  • controlling-access-to-dataservices.md
  • customizing-security-plugins.md
  • administering-the-servers-and-plugins-using-an-api.md
  • managing-cluster-mode-for-app-server.md

After creating the PR, follow the instructions in the comments.
@gauravs-20 @ArooshLele

@ArooshLele ArooshLele self-assigned this Nov 17, 2025
@ArooshLele ArooshLele added area: docs Documentation issue or issues that have documentation impact priority-medium area: install and config Issues related to z/OS install and config release: V3 Zowe V3 content review: doc Needs review by Doc Squad member labels Nov 17, 2025
@github-actions
Copy link

github-actions bot commented Nov 17, 2025

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.

  • Add the label review: doc.
  • Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
  • Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
    • If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
  • 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.
  • 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.

@github-actions
Copy link

github-actions bot commented Nov 17, 2025 •
edited
Loading

🚀 Deployed on https://6937b52cd054d22736980a20--zowe-docs-master.netlify.app

@github-actions github-actions bot temporarily deployed to pull request November 17, 2025 11:00 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 17, 2025 11:10 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 17, 2025 17:22 Inactive
@ArooshLele
Updating accessing-zss.md
529999c 
Signed-off-by: arooshlele <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request November 18, 2025 05:03 Inactive
@ArooshLele
Updating configuration-file.md, configuring-the-framework-as-a-mediat…
ee41299 
…ion-layer-client.md, setting-up-terminal-app-plugins.md

Signed-off-by: arooshlele <[email protected]>
@ArooshLele
Updating network-configuration.md, configuration-directories.md, app-…
3cd7374 
…plugin-configuration.md, logging-configuration.md

Signed-off-by: arooshlele <[email protected]>
@ArooshLele
Updating zss-configuration-1.md, using-multiple-zis-instances.md, con…
29251ad 
…trolling-access-to-apps.md

Signed-off-by: arooshlele <[email protected]>
@ArooshLele
Updating controlling-access-to-dataservices.md, customizing-security-…
0ffc7de 
…plugins.md

Signed-off-by: arooshlele <[email protected]>
@ArooshLele
Updating administering-the-servers-and-plugins-using-an-api.md
5e3495e 
Signed-off-by: arooshlele <[email protected]>
anaxceron
anaxceron reviewed Dec 12, 2025
View reviewed changes
Copy link
Collaborator

@anaxceron anaxceron left a comment

Choose a reason for hiding this comment

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

Left comments for edits, lmk if you have questions

docs/user-guide/accessing-zss.md Outdated

Although you access the ZSS server via the Gateway port, the ZSS server still needs a port assigned to it which is the value of the *components.zss.port* variable in the Zowe configuration file.

If the mediation layer is not used, ZSS directly at `https://<zowe.externalDomain>:<components.zss.port>/`.
Copy link
Collaborator

@anaxceron anaxceron Dec 10, 2025

Choose a reason for hiding this comment

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

If "mediation layer" = API ML, we should say "API ML" (w/o the "the")

docs/user-guide/administering-the-servers-and-plugins-using-an-api.md Outdated
@@ -0,0 +1,28 @@
# Administering the servers and plugins using an API
Copy link
Collaborator

@anaxceron anaxceron Dec 10, 2025

Choose a reason for hiding this comment

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

plug-ins -- please fix all use of "plugins" in this PR

docs/user-guide/administering-the-servers-and-plugins-using-an-api.md Outdated
@@ -0,0 +1,28 @@
# Administering the servers and plugins using an API
The App Server has a REST API to retrieve and edit both the App Server and ZSS server configuration values, and list, add, update, and delete plugins. Most of the features require RBAC to be enabled and for your user to have RBAC access to utilize these endpoints. For more information see documentation on how to [use RBAC](https://docs.zowe.org/stable/user-guide/mvd-configuration.html#controlling-access-to-dataservices)
Copy link
Collaborator

@anaxceron anaxceron Dec 10, 2025

Choose a reason for hiding this comment

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

comma after "For more information"

docs/user-guide/administering-the-servers-and-plugins-using-an-api.md
The API returns the following information in a JSON response:

| API | Description |
| --------------------------------------------------------- | ------------------------------------------------------------ |
Copy link
Collaborator

@anaxceron anaxceron Dec 10, 2025

Choose a reason for hiding this comment

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

No need to keep saying "Returns" if we're saying "returns" in Line 4. I would rewriter either Line 4 or the descriptions for each of these items.

Copy link
Collaborator Author

@ArooshLele ArooshLele Dec 15, 2025

Choose a reason for hiding this comment

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

@anaxceron I agree. It has been edited accordingly.

docs/user-guide/administering-the-servers-and-plugins-using-an-api.md Outdated

Swagger API documentation is provided in the `<zowe.runtimeDirectory>/components/app-server/share/zlux-app-server/doc/swagger/server-plugins-api.yaml` file. To see it in HTML format, you can paste the contents into the Swagger editor at https://editor.swagger.io/.

**Note:** The "agent" end points interact with the agent specified in the zowe configuration file. By default this is ZSS.
Copy link
Collaborator

@anaxceron anaxceron Dec 10, 2025

Choose a reason for hiding this comment

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

Use the docusaurus syntax for the note

Copy link
Collaborator Author

@ArooshLele ArooshLele Dec 16, 2025

Choose a reason for hiding this comment

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

@anaxceron I agree with Ana. Done.

docs/user-guide/zss-configuration-1.md Outdated
@@ -0,0 +1,59 @@
# ZSS configuration

ZSS provides APIs that any server or client can use. By default, the Zowe Desktop includes Apps which rely upon ZSS APIs, and therefore it's recommended that whenever the `app-server` is enabled in the Zowe YAML, that `zss` is also enabled.
Copy link
Collaborator

@anaxceron anaxceron Dec 11, 2025

Choose a reason for hiding this comment

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

  • Apps shouldn't be capitalized
  • spell out "it's"

Copy link
Collaborator Author

@ArooshLele ArooshLele Dec 15, 2025

Choose a reason for hiding this comment

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

Done.

docs/user-guide/zss-configuration-1.md Outdated

### Verifying which ZSS mode plugins support

You can check if a ZSS plugin supports 64 bit or 31 bit ZSS by reading the pluginDefinition.json file of the plugin.
Copy link
Collaborator

@anaxceron anaxceron Dec 11, 2025

Choose a reason for hiding this comment

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

pluginDefinition.json should be in backticks

Copy link
Collaborator Author

@ArooshLele ArooshLele Dec 15, 2025

Choose a reason for hiding this comment

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

Done.

docs/user-guide/zss-configuration-1.md Outdated

You can check if a ZSS plugin supports 64 bit or 31 bit ZSS by reading the pluginDefinition.json file of the plugin.
In each component or extension you have, its manifest file will state if there are `appFw` plugin entries.
In each folder referenced by the `appFw` section, you will see a pluginDefinition.json file.
Copy link
Collaborator

@anaxceron anaxceron Dec 11, 2025

Choose a reason for hiding this comment

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

backticks

Copy link
Collaborator Author

@ArooshLele ArooshLele Dec 15, 2025

Choose a reason for hiding this comment

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

Done.

docs/user-guide/zss-configuration-1.md Outdated

In a standard Zowe installation, all Zowe servers utilize the API Mediation Layer's token-based, single-sign on authentication. This authentication in turn cooperates with z/OSMF, and the session duration is typically that of z/OSMF's, which defaults to 8 hours before the session expires. In that situation, customization of session duration is best done by customizing z/OSMF's session duration, as a part of its Liberty configuration.

If you are not using the API Mediation Layer, or are trying to contact ZSS directly, then ZSS's own session logic is used. When authenticated directly to ZSS, it will respond to authenticated HTTP requests with a cookie which is valid by default for 1 hour. This can be customized by creating and editing a file named "timeouts.json" within ZSS's instance directory. The default location is `<zowe.workspaceDirectory>/app-server/serverConfig/timeouts.json`, because the default instance directory is `<zowe.workspaceDirectory>/app-server`, but can be customized by editing the value of `components.zss.instanceDir`.
Copy link
Collaborator

@anaxceron anaxceron Dec 11, 2025

Choose a reason for hiding this comment

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

"timeouts.json" should be in backticks

Copy link
Collaborator Author

@ArooshLele ArooshLele Dec 15, 2025

Choose a reason for hiding this comment

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

Done.

docs/user-guide/zss-configuration-1.md Outdated

If you are not using the API Mediation Layer, or are trying to contact ZSS directly, then ZSS's own session logic is used. When authenticated directly to ZSS, it will respond to authenticated HTTP requests with a cookie which is valid by default for 1 hour. This can be customized by creating and editing a file named "timeouts.json" within ZSS's instance directory. The default location is `<zowe.workspaceDirectory>/app-server/serverConfig/timeouts.json`, because the default instance directory is `<zowe.workspaceDirectory>/app-server`, but can be customized by editing the value of `components.zss.instanceDir`.

The timeouts.json file has the following layout:
Copy link
Collaborator

@anaxceron anaxceron Dec 11, 2025

Choose a reason for hiding this comment

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

backticks

Copy link
Collaborator Author

@ArooshLele ArooshLele Dec 15, 2025

Choose a reason for hiding this comment

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

Done.

@ArooshLele
Update accessing-zss.md (#4824)
5f1dda4 
@anaxceron @gauravs-20

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update controlling-access-to-apps.md (#4827)
3d8d1f2 
I made some minor edits.

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update administering-the-servers-and-plugins-using-an-api.md (#4825)
84bcbcb 
Yes, I edited plugin to plug-in wherever applicable.
In the table:
-In the Description (right side) column, I removed "Returns" from the rows.
-In the API (left side) column, I did not change plugin to plug-ins as that's the API's unique name, wherever applicable.
Thanks !

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update controlling-access-to-apps.md (#4828)
876a8df 
Plugin changed to plug-in.

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update controlling-access-to-dataservices.md (#4829)
cd060c1 
Changed plugin to plug-in.

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update app-plugin-configuration.md (#4830)
a1a1543 
I edited plugin to plug-in, enclosed variable in backticks, rewrote Components as "components". (from Uppercase to Lowercase).

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update configuration-directories.md (#4831)
080eac3 
Edits are done.

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update logging-configuration.md (#4832)
0c583bc 
Variables are enclosed in backticks.

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update configuring-the-framework-as-a-mediation-layer-client.md (#4833)
4ffa795 
Edits

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update controlling-access-to-apps.md (#4834)
00491e4 
Edits

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update controlling-access-to-dataservices.md
8289f2c 
Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update managing-cluster-mode-for-app-server.md (#4835)
fc385ce 
Edits

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update zss-configuration-1.md (#4837)
9b8cdec 
Edits.

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update using-multiple-zis-instances.md (#4836)
e94ac30 
Edits

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update zss-configuration-1.md (#4838)
bf3503c 
Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update zss-configuration-1.md (#4839)
f68e425 
Edits

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Updating network-configuration.md
41661ff 
Signed-off-by: arooshlele <[email protected]>
@ArooshLele
Update administering-the-servers-and-plugins-using-an-api.md (#4844)
30b53c6 
The Docsaurus syntax is applied on the note.

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update controlling-access-to-apps.md (#4845)
e4f0a23 
Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Update controlling-access-to-apps.md (#4846)
1708583 
The Note is now as per Docasaurus's syntax.

Signed-off-by: ArooshLele <[email protected]>
@ArooshLele
Merge branch 'master' into MVD-7317_Split_Advanced_Application_Framew…
d4e62ef 
…ork_Configuration_Page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@1000TurquoisePogs 1000TurquoisePogs 1000TurquoisePogs left review comments

@Martin-Zeithaml Martin-Zeithaml Martin-Zeithaml left review comments

@anaxceron anaxceron anaxceron left review comments

@janan07 janan07 Awaiting requested review from janan07

@DivergentEuropeans DivergentEuropeans Awaiting requested review from DivergentEuropeans

At least 1 approving review is required to merge this pull request.

Assignees

@ArooshLele ArooshLele

Labels

area: docs Documentation issue or issues that have documentation impact area: install and config Issues related to z/OS install and config priority-medium release: V3 Zowe V3 content review: doc Needs review by Doc Squad member review: sme Needs review by an SME

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@ArooshLele @1000TurquoisePogs @Martin-Zeithaml @anaxceron