Dividing mvd-configuration.md file into smaller topics#4787
Open
ArooshLele wants to merge 65 commits intomasterfrom
Open
Dividing mvd-configuration.md file into smaller topics#4787ArooshLele wants to merge 65 commits intomasterfrom
ArooshLele wants to merge 65 commits intomasterfrom
Conversation
Signed-off-by: arooshlele <alele@rocketsoftware.com>
ArooshLele
added
area: docs
|
😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.
Need help? Contact the Doc Squad in the #zowe-doc Slack channel. |
…ork_Configuration_Page
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
…ion-layer-client.md, setting-up-terminal-app-plugins.md Signed-off-by: arooshlele <alele@rocketsoftware.com>
…plugin-configuration.md, logging-configuration.md Signed-off-by: arooshlele <alele@rocketsoftware.com>
…trolling-access-to-apps.md Signed-off-by: arooshlele <alele@rocketsoftware.com>
…plugins.md Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
anaxceron
reviewed
Dec 12, 2025
Collaborator
anaxceron
left a comment
anaxceron
left a comment
There was a problem hiding this comment.
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>/`. |
Collaborator
There was a problem hiding this comment.
If "mediation layer" = API ML, we should say "API ML" (w/o the "the")
| @@ -0,0 +1,28 @@ | |||
| # Administering the servers and plugins using an API | |||
Collaborator
There was a problem hiding this comment.
plug-ins -- please fix all use of "plugins" in this PR
| @@ -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) | |||
Collaborator
There was a problem hiding this comment.
comma after "For more information"
| The API returns the following information in a JSON response: | ||
|
|
||
| | API | Description | | ||
| | --------------------------------------------------------- | ------------------------------------------------------------ | |
Collaborator
There was a problem hiding this comment.
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.
Collaborator
Author
There was a problem hiding this comment.
@anaxceron I agree. It has been edited accordingly.
|
|
||
| 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. |
Collaborator
There was a problem hiding this comment.
Use the docusaurus syntax for the note
| @@ -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. | |||
Collaborator
There was a problem hiding this comment.
- Apps shouldn't be capitalized
- spell out "it's"
|
|
||
| ### 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. |
Collaborator
There was a problem hiding this comment.
pluginDefinition.json should be in backticks
|
|
||
| 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. |
|
|
||
| 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`. |
Collaborator
There was a problem hiding this comment.
"timeouts.json" should be in backticks
|
|
||
| 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: |
@anaxceron @gauravs-20 Signed-off-by: ArooshLele <alele@rocketsoftware.com>
I made some minor edits. Signed-off-by: ArooshLele <alele@rocketsoftware.com>
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 <alele@rocketsoftware.com>
Plugin changed to plug-in. Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Changed plugin to plug-in. Signed-off-by: ArooshLele <alele@rocketsoftware.com>
I edited plugin to plug-in, enclosed variable in backticks, rewrote Components as "components". (from Uppercase to Lowercase). Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Edits are done. Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Variables are enclosed in backticks. Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Edits Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Edits Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Edits Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Edits. Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Edits Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Edits Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Signed-off-by: arooshlele <alele@rocketsoftware.com>
The Docsaurus syntax is applied on the note. Signed-off-by: ArooshLele <alele@rocketsoftware.com>
Signed-off-by: ArooshLele <alele@rocketsoftware.com>
The Note is now as per Docasaurus's syntax. Signed-off-by: ArooshLele <alele@rocketsoftware.com>
…ork_Configuration_Page
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
After creating the PR, follow the instructions in the comments.
@gauravs-20 @ArooshLele