Skip to content

add doc for troubleshooting AT-TLS Zowe Desktop issues#4701

Merged
janan07 merged 11 commits intomasterfrom
user/markackert/attls-troubleshooting-additions
Sep 23, 2025
Merged

add doc for troubleshooting AT-TLS Zowe Desktop issues#4701
janan07 merged 11 commits intomasterfrom
user/markackert/attls-troubleshooting-additions

Conversation

@MarkAckert
Copy link
Copy Markdown
Member

@MarkAckert MarkAckert commented Sep 11, 2025

Describe your pull request here:

Adds doc describing possible issues with Zowe Desktop apps in AT-TLS mode, and their fixes.

Related PRs (fixes coming in 3.4.0):
zowe/zss#797
zowe/zlux-server-framework#617

List the file(s) included in this PR:
docs/user-guide/configuring-at-tls-for-zowe-server.md

Signed-off-by: MarkAckert <mark.ackert@broadcom.com>
Signed-off-by: MarkAckert <mark.ackert@broadcom.com>
@MarkAckert MarkAckert added area: docs Documentation issue or issues that have documentation impact area: apiml This issue is related to Zowe API Mediation Layer release: V3 Zowe V3 content review: doc Needs review by Doc Squad member review: sme Needs review by an SME labels Sep 11, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Sep 11, 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
Copy Markdown

github-actions Bot commented Sep 11, 2025

@github-actions github-actions Bot temporarily deployed to pull request September 11, 2025 15:55 Inactive
Comment thread docs/user-guide/configuring-at-tls-for-zowe-server.md
Comment on lines +426 to +430
Upgrade to Zowe 3.4.0 if available, OR add required metadata manually to the ZLUX app in the APIML Discovery service. The metadata will need to be added after any restart of Zowe. Contact your conformant support provider for assistance.

The metadata that should be added to the ZLUX eureka app:
- `apiml.corsEnabled`: `true`
- `apiml.corsAllowedOrigins` : `https://<your_zowe_host>:<catalog_port>,https://<your_zowe_host>:<gateway_port>`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is there no way to provide these via properties? I think it's quite complicated to add these after every restart considering it requires direct access to the eureka API and client certificate authentication.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

There's no way to provide this via properties that I could find. The metadata is all populated in code. I agree the workaround is possible but a huge pain; maybe it's better to simply say wait for 3.4.0?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it will be very difficult for customers to update the metadata of the zlux service based on these steps alone (I'm thinking about the client certificate requirement, finding the correct endpoint and parameters to provide). Maybe we should include those details to the instructions?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah, I omitted that in favor of Contact your conformant support provider for assistance. I can move this to the front of the statement. I'll take a stab at writing out the details in an expandable block, but my impression was this is too much for most users to work through on their own, even with some instruction in the doc.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@pablocarle are any specific user permissions required to update the service metadata? Is this endpoint protected by APIML.SERVICES ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No, only requirement is to provide client certificate authentication with a trusted cert

Signed-off-by: MarkAckert <mark.ackert@broadcom.com>
@github-actions github-actions Bot temporarily deployed to pull request September 12, 2025 12:38 Inactive
Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Copy link
Copy Markdown
Collaborator

@janan07 janan07 left a comment

Choose a reason for hiding this comment

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

Reviewed and edited by Doc Squad

@github-actions github-actions Bot temporarily deployed to pull request September 15, 2025 09:32 Inactive
Signed-off-by: Martin Zeithaml <66114686+Martin-Zeithaml@users.noreply.github.com>
@github-actions github-actions Bot temporarily deployed to pull request September 16, 2025 08:04 Inactive
@skurnevich skurnevich self-requested a review September 16, 2025 15:28
Copy link
Copy Markdown
Collaborator

@skurnevich skurnevich left a comment

Choose a reason for hiding this comment

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

Just realized that square brackets would not work here, should be written as other arrays

@MarkAckert
Copy link
Copy Markdown
Member Author

Just realized that square brackets would not work here, should be written as other arrays

😨 you're right - I got that array syntax working in a test environment, but had trouble with it in others. I'll switch it.

Signed-off-by: MarkAckert <mark.ackert@broadcom.com>
Signed-off-by: MarkAckert <mark.ackert@broadcom.com>
@skurnevich skurnevich self-requested a review September 23, 2025 11:13
janan07 and others added 2 commits September 23, 2025 13:14
@github-actions github-actions Bot temporarily deployed to pull request September 23, 2025 14:33 Inactive
Signed-off-by: MarkAckert <mark.ackert@broadcom.com>
@github-actions github-actions Bot temporarily deployed to pull request September 23, 2025 14:45 Inactive
@janan07 janan07 merged commit 3d63b1c into master Sep 23, 2025
4 checks passed
@janan07 janan07 deleted the user/markackert/attls-troubleshooting-additions branch September 23, 2025 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: apiml This issue is related to Zowe API Mediation Layer area: docs Documentation issue or issues that have documentation impact release: V3 Zowe V3 content review: doc Needs review by Doc Squad member review: sme Needs review by an SME

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants