Skip to content
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.

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

reorder table and topics to group required config for API ML #4276

Merged
merged 12 commits into from
Apr 7, 2025

Conversation

janan07
Copy link
Collaborator

@janan07 janan07 commented Apr 2, 2025

Describe your pull request here: reorder table and topics to group required config for API ML

List the file(s) included in this PR: configure-zos-system (v2.18), configuration-client-certificates, authenticating-with-client-certificates

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

Copy link

github-actions bot commented Apr 2, 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.

Copy link

github-actions bot commented Apr 2, 2025

📁 The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our Zowe Docs GitHub Slack channel.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

@janan07 janan07 added area: apiml This issue is related to Zowe API Mediation Layer area: install and config Issues related to z/OS install and config release: V2 Zowe V2 content review: doc Needs review by Doc Squad member labels Apr 2, 2025
Copy link

github-actions bot commented Apr 2, 2025

@github-actions github-actions bot temporarily deployed to pull request April 2, 2025 13:29 Inactive
@github-actions github-actions bot temporarily deployed to pull request April 3, 2025 08:36 Inactive
Signed-off-by: Andrew Jandacek <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request April 3, 2025 08:51 Inactive
@github-actions github-actions bot temporarily deployed to pull request April 3, 2025 09:29 Inactive
@github-actions github-actions bot temporarily deployed to pull request April 4, 2025 08:09 Inactive
@janan07 janan07 requested a review from balhar-jakub April 4, 2025 11:34

There are two methods to enable client certificate functionality:
There are two methods to enable x509 client certificate functionality:
Copy link
Member

Choose a reason for hiding this comment

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

Even though the certificates we use are x509 we also have x509 as the authentication scheme.

For the authentication scheme you need neither setups. For the client certificate authentication in general you need either one of them.

So maybe something like:
There are two methods to enable client certificate functionality integrated with the SAF:

@@ -3,9 +3,9 @@
:::info Roles: system programmer, system administrator, security administrator
Copy link
Member

Choose a reason for hiding this comment

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

Generally be careful with addition of the x509, while it is true that the certificates we support are x509 we also use the term in another way which may confuse people.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The reason behind this addition is that there is a terminology discrepancy between references in Zowe Docs to just client certificates and references in ESZ that describe x.509 client certificates. It should be clear that the certificates are x509 in the Zowe doc if that is where we are sending ESZ customers.
x509 config section in ESZ

Copy link
Member

Choose a reason for hiding this comment

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

Ok, Then we should use X.509 as the exact name in the Zowe Docs as well.

@github-actions github-actions bot temporarily deployed to pull request April 7, 2025 08:00 Inactive
@github-actions github-actions bot temporarily deployed to pull request April 7, 2025 08:11 Inactive
@github-actions github-actions bot temporarily deployed to pull request April 7, 2025 10:05 Inactive
janan07 added 2 commits April 7, 2025 12:24
Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request April 7, 2025 10:33 Inactive
@janan07 janan07 merged commit 9e0e780 into master Apr 7, 2025
3 of 4 checks passed
@janan07 janan07 deleted the janan07/reorg-zos-sys-security-for-apiml-install branch April 7, 2025 11:44
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: install and config Issues related to z/OS install and config release: V2 Zowe V2 content review: doc Needs review by Doc Squad member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants