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.

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

Native TLS documentation #3685

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Native TLS documentation #3685

wants to merge 4 commits into from
+106 −14

Conversation

1000TurquoisePogs
Copy link
Member

@1000TurquoisePogs 1000TurquoisePogs commented May 28, 2024 •
edited
Loading

Since zowe v2.13, it's been possible to configure some servers tls connections via zowe.network.server
But in v3, it's pretty much ALL the servers that support this now, so I've made v3 doc for this ability.
source

@1000TurquoisePogs 1000TurquoisePogs added type: enhancement New feature or request 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 May 28, 2024
@github-actions GitHub Actions
Copy link

😺 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.

1 similar comment
@github-actions GitHub Actions
Copy link

😺 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 GitHub Actions
Copy link

📁 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.

2 similar comments
@github-actions GitHub Actions
Copy link

📁 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.

@github-actions GitHub Actions
Copy link

📁 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.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 28, 2024 •
edited
Loading

🚀 Deployed on https://672203a37a714a5ad7587616--zowe-docs-master.netlify.app

@github-actions github-actions bot temporarily deployed to pull request May 28, 2024 14:05 Inactive
@balhar-jakub balhar-jakub mentioned this pull request May 28, 2024
Closed
@github-actions github-actions bot temporarily deployed to pull request October 23, 2024 17:35 Inactive
@1000TurquoisePogs 1000TurquoisePogs changed the base branch from docs-staging to master October 23, 2024 18:44
@1000TurquoisePogs 1000TurquoisePogs changed the base branch from master to docs-staging October 23, 2024 18:45
@1000TurquoisePogs 1000TurquoisePogs changed the base branch from docs-staging to master October 23, 2024 19:18
@1000TurquoisePogs 1000TurquoisePogs added the release: V3 Zowe V3 content label Oct 23, 2024
@github-actions github-actions bot temporarily deployed to pull request October 23, 2024 19:31 Inactive
@1000TurquoisePogs 1000TurquoisePogs removed the release: V2 Zowe V2 content label Oct 24, 2024
@1000TurquoisePogs 1000TurquoisePogs changed the title Draft of TLS documentation Native TLS documentation Oct 24, 2024
@1000TurquoisePogs 1000TurquoisePogs marked this pull request as ready for review October 24, 2024 16:55
@github-actions github-actions bot temporarily deployed to pull request October 24, 2024 17:12 Inactive
anaxceron
anaxceron reviewed Oct 24, 2024
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.

Made some comments re: spacing and style, otherwise it looks good to me. But I think others should also review this before merging this pr.

docs/user-guide/tls-configuration.md Show resolved Hide resolved
docs/user-guide/tls-configuration.md Show resolved Hide resolved
docs/user-guide/tls-configuration.md Show resolved Hide resolved
docs/user-guide/tls-configuration.md Outdated Show resolved Hide resolved
docs/user-guide/tls-configuration.md Outdated Show resolved Hide resolved
@1000TurquoisePogs
V3 guide for TLS configuration
ca77471 
Signed-off-by: 1000TurquoisePogs <sgrady@rocketsoftware.com>
@1000TurquoisePogs
Update tls-configuration.md for syntax
5786037 
Signed-off-by: 1000TurquoisePogs <sgrady@rocketsoftware.com>
@1000TurquoisePogs
Formatting updated to match Ana's review
7e2c4d4 
Signed-off-by: 1000TurquoisePogs <sgrady@rocketsoftware.com>
@1000TurquoisePogs
Fix AT-TLS ref link
d88f3a7 
Signed-off-by: 1000TurquoisePogs <sgrady@rocketsoftware.com>
pablocarle
pablocarle reviewed Oct 30, 2024
View reviewed changes
docs/user-guide/configuring-at-tls-for-zowe-server.md
@@ -1,4 +1,4 @@
# Configuring AT-TLS for Zowe Server
# Enabling AT-TLS
Copy link
Contributor

Choose a reason for hiding this comment

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

If the title changes I think it should change the name of the file and the item in sidebars cc. @janan07

Copy link
Member Author

Choose a reason for hiding this comment

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

I think changing filenames can break bookmarks and google indexing so in the past I have left filenames outdated just so users still end up on the right page.

Copy link
Contributor

Choose a reason for hiding this comment

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

Could be, we already changed this one once, since the original title was API ML only. I think the search is not working properly in stable version atm

Copy link
Member

Choose a reason for hiding this comment

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

Just a note: if we want to change the names of the files, we should move the file and keep only the link to the new file on the original page.

docs/user-guide/tls-configuration.md
Comment on lines +55 to +56
minTls: "TLSv1.2"
maxTls: "TLSv1.3"
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this still exclusive with attls being enabled?
It's for a separate issue, but we think it should be allowed to customize these values even with at-tls enabled. Although there are other restrictions (such as ICSF hardware keys). We are not assuming all onboarded services will be AT-TLS, it should be still possible to use Java TLS for these scenarios even with AT-TLS enabled in Zowe.

Copy link
Member Author

Choose a reason for hiding this comment

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

The schema does have these as exclusive. Maybe the doc should make this clear?

It's a good point about a hybrid scenario. It's also difficult to make intuitive because people might think these settings would control AT-TLS when AT-TLS is enabled, but they're unrelated.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think so if we are not planning on removing this exclusion, although I think we should.

@github-actions github-actions bot temporarily deployed to pull request October 30, 2024 10:01 Inactive
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

@pablocarle pablocarle pablocarle left review comments

@balhar-jakub balhar-jakub balhar-jakub left review comments

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

Assignees
No one assigned
Labels
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 type: enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@1000TurquoisePogs @balhar-jakub @pablocarle @anaxceron