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

Add missing block in AT-TLS configuration #3994

Merged
merged 7 commits into from
Nov 19, 2024

Conversation

pablocarle
Copy link
Contributor

Describe your pull request here:

  • Remove redundant table of contents from AT-TLS articles in v3 and v2.18 (already available in sidebar)
  • Add missing block from inbound AT-TLS rules

List the file(s) included in this PR:

  • docs/user-guide/configuring-at-tls-for-zowe-server.md
  • versioned_docs/version-v2.18.x/user-guide/configuring-at-tls-for-zowe-server.md

@pablocarle pablocarle 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 release: V3 Zowe V3 content review: doc Needs review by Doc Squad member labels Nov 12, 2024
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.

Copy link

github-actions bot commented Nov 12, 2024

@github-actions github-actions bot temporarily deployed to pull request November 12, 2024 17:22 Inactive
@taban03
Copy link
Contributor

taban03 commented Nov 13, 2024

I'd also add example of the TTLSKeyringParms parameter block that is currently missing in the doc. I.E.

{
    ...
    TTLSKeyringParmsRef ZoweKeyring
}

TTLSKeyringParms ZoweKeyring
{
  Keyring ZOWERING
}

@taban03
Copy link
Contributor

taban03 commented Nov 13, 2024

I've also noted that TTLSSignatureParms is not documented anywhere. Is it always required?

@pablocarle
Copy link
Contributor Author

TTLSSignatureParms

I believe this can be removed, can you also confirm in your setup? We should aim at the simplest setup possible

@pablocarle
Copy link
Contributor Author

I'd also add example of the TTLSKeyringParms parameter block that is currently missing in the doc. I.E.

{
    ...
    TTLSKeyringParmsRef ZoweKeyring
}

TTLSKeyringParms ZoweKeyring
{
  Keyring ZOWERING
}

Thanks, I'll check this one and add it

@github-actions github-actions bot temporarily deployed to pull request November 13, 2024 13:53 Inactive
@taban03
Copy link
Contributor

taban03 commented Nov 13, 2024

TTLSConnectionAction ClientConnectionAction  
{  
  HandshakeRole Client  
  TTLSCipherParmsRef CipherParms  
  TTLSConnectionAdvancedParmsRef ConnectionAdvancedParms  
  CertificateLabel  
}

Is CertificateLabel required? Also, it looks it misses the value

Signed-off-by: Andrew Jandacek <[email protected]>
Signed-off-by: Andrew Jandacek <[email protected]>
Copy link
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 November 13, 2024 14:21 Inactive
@taban03
Copy link
Contributor

taban03 commented Nov 13, 2024

TTLSConnectionAdvancedParms ApimlClientX509ConnAdvParms
{
  ApplicationControlled Off
  CertificateLabel Zowe Server
  SecondaryMap Off
}

ApplicationControlled Off is missing in our internal setup. Maybe that won't be necessary.

Signed-off-by: Pablo Hernán Carle <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request November 13, 2024 15:45 Inactive
@taban03
Copy link
Contributor

taban03 commented Nov 14, 2024

ClientEnvironmentAdvParms and ServerEnvironmentAdvParms are also not documented.

@github-actions github-actions bot temporarily deployed to pull request November 14, 2024 14:18 Inactive
@pablocarle
Copy link
Contributor Author

ClientEnvironmentAdvParms and ServerEnvironmentAdvParms are also not documented.

these are documented in the full example

@github-actions github-actions bot temporarily deployed to pull request November 19, 2024 09:30 Inactive
@janan07 janan07 merged commit 54cff7c into master Nov 19, 2024
3 of 4 checks passed
@janan07 janan07 deleted the reboot/fix/attls-missingblock branch November 19, 2024 10:08
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 release: V3 Zowe V3 content review: doc Needs review by Doc Squad member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants