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

remove central gateway reference from the docs for v3 #4038

Merged
merged 17 commits into from
Dec 20, 2024

Conversation

Shobhajayanna
Copy link
Contributor

Describe your pull request here:

This is to remove the 'central' from central gateway in trouble shooting section.

List the file(s) included in this PR:

docs/troubleshoot/troubleshoot-apiml-error-codes.md

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

💾 The release label is missing. Add a release: label so your content is published with the correct major Zowe release.

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

Copy link

📌 The subject area label is missing. Add an area: label so we know what your content is about.

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

Copy link

🔍 The review label is missing. Add a review: label so we can determine who needs to approve this PR.

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

Copy link

github-actions bot commented Dec 13, 2024

@github-actions github-actions bot temporarily deployed to pull request December 13, 2024 16:37 Inactive
@Shobhajayanna Shobhajayanna changed the title remove the central from trouble shooting remove the word 'central' from central gateway in the trouble shooting Dec 16, 2024
@github-actions github-actions bot temporarily deployed to pull request December 16, 2024 13:14 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 17, 2024 09:58 Inactive
@Shobhajayanna Shobhajayanna changed the title remove the word 'central' from central gateway in the trouble shooting remove central gateway reference from the docs for v3 Dec 17, 2024
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

* [Dynamic configuration via zowe.yaml](#dynamic-configuration-via-zoweyaml)
* [Dynamic configuration via Environment variables](#dynamic-configuration-via-environment-variables)
* [Validating successful configuration](#validating-successful-configuration)
* [Establishing a trust relationship between Domain API ML and Central API ML](#establishing-a-trust-relationship-between-domain-api-ml-and-central-api-ml)
* [Commands to establish trust between Domain and Central API MLs](#commands-to-establish-trust-between-domain-and-central-api-mls)
* [Using the `/registry` endpoint in the Central Gateway](#using-the-registry-endpoint-in-the-central-gateway)
* [Using the `/registry` endpoint in Gateway in the Central API ML](#using-the-registry-endpoint-in-the-central-gateway)
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to keep Central here in Central API ML?

@@ -4,13 +4,13 @@ Zowe supports management of multiple tenants, whereby different tenants can serv

* [Overview of Central and Domain API MLs](#overview-of-central-and-domain-api-mls)
* [Multitenancy component enablement settings](#multitenancy-component-enablement-settings)
* [Onboarding a Domain Gateway service to the Central Discovery service](#onboarding-a-domain-gateway-service-to-the-central-discovery-service)
* [Onboarding a Domain Gateway service to Discovery service in the Central API ML](#onboarding-a-domain-gateway-service-to-the-central-discovery-service)
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to keep Central here in Central API ML?

@@ -4,13 +4,13 @@ Zowe supports management of multiple tenants, whereby different tenants can serv

* [Overview of Central and Domain API MLs](#overview-of-central-and-domain-api-mls)
Copy link
Member

Choose a reason for hiding this comment

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

We do have Central API MLs mentioned here. What does this term mean now and should we use better one?

@@ -4,13 +4,13 @@ Zowe supports management of multiple tenants, whereby different tenants can serv

* [Overview of Central and Domain API MLs](#overview-of-central-and-domain-api-mls)
* [Multitenancy component enablement settings](#multitenancy-component-enablement-settings)
* [Onboarding a Domain Gateway service to the Central Discovery service](#onboarding-a-domain-gateway-service-to-the-central-discovery-service)
* [Onboarding a Domain Gateway service to Discovery service in the Central API ML](#onboarding-a-domain-gateway-service-to-the-central-discovery-service)
* [Dynamic configuration via zowe.yaml](#dynamic-configuration-via-zoweyaml)
* [Dynamic configuration via Environment variables](#dynamic-configuration-via-environment-variables)
* [Validating successful configuration](#validating-successful-configuration)
* [Establishing a trust relationship between Domain API ML and Central API ML](#establishing-a-trust-relationship-between-domain-api-ml-and-central-api-ml)
Copy link
Member

Choose a reason for hiding this comment

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

Domain and Central API ML

@github-actions github-actions bot temporarily deployed to pull request December 18, 2024 09:24 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 18, 2024 13:14 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 18, 2024 15:43 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 18, 2024 15:55 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 18, 2024 16:02 Inactive
Co-authored-by: Andrea Tabone <[email protected]>
Signed-off-by: ShobhaJayanna <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request December 18, 2024 20:54 Inactive
Shobhajayanna and others added 2 commits December 19, 2024 10:02
…ked-questions.md

Co-authored-by: Andrea Tabone <[email protected]>
Signed-off-by: ShobhaJayanna <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request December 19, 2024 09:09 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 19, 2024 10:56 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 19, 2024 11:48 Inactive

![Multi-domain architecture diagram](./diagrams/multi-domain_architecture_V3.svg)

As represented in the example diagram of Multitenacy environement where the APIMLs in Domain(2-N) are registered to APIML in Domain-1. The APIML in Domain-1 is running may be on z/OS, or off z/OS, for example in Kubernetes, this API ML serves as a single point of access to all API Mediation Layers registered in this and, by extension, to all services registered in those API MLs .
Copy link
Member

Choose a reason for hiding this comment

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

Update to one of the following, please:
Domain-1 is running on z/OS, or off z/OS
Domain-1 may be running on z/OS, or off z/OS

Signed-off-by: ShobhaJayanna <[email protected]>
For routing to work in a multitenancy configuration, the Central API Mediation Layer must trust the Domain API Mediation Layers for successful registration into the Discovery Service component.
The Domain API Mediation Layers must trust the Central API Mediation Layer Gateway to accept routed requests.
It is necessary that the root and, if applicable, intermediate public certificates be shared between the Central API Mediation Layer and Domain API Mediation Layers.
For routing to work in a multitenancy configuration, as represented in the example daigram above where "Domain APIML 2", "Domain APIML 3" are registered to "Domain APIML 1", the "Domain APIML 1" must trust the "Domain APIML 2", "Domain APIML 3" for successful registration into the it's Discovery Service component.
Copy link
Member

Choose a reason for hiding this comment

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

example diagram instead of daigram

The Domain API Mediation Layers must trust the Central API Mediation Layer Gateway to accept routed requests.
It is necessary that the root and, if applicable, intermediate public certificates be shared between the Central API Mediation Layer and Domain API Mediation Layers.
For routing to work in a multitenancy configuration, as represented in the example daigram above where "Domain APIML 2", "Domain APIML 3" are registered to "Domain APIML 1", the "Domain APIML 1" must trust the "Domain APIML 2", "Domain APIML 3" for successful registration into the it's Discovery Service component.
The "Domain APIML 2", "Domain APIML 3" must trust the "Domain APIML 1" Gateway where they are registed to, to accept routed requests.
Copy link
Member

Choose a reason for hiding this comment

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

registered to instead of registed to

It is necessary that the root and, if applicable, intermediate public certificates be shared between the Central API Mediation Layer and Domain API Mediation Layers.
For routing to work in a multitenancy configuration, as represented in the example daigram above where "Domain APIML 2", "Domain APIML 3" are registered to "Domain APIML 1", the "Domain APIML 1" must trust the "Domain APIML 2", "Domain APIML 3" for successful registration into the it's Discovery Service component.
The "Domain APIML 2", "Domain APIML 3" must trust the "Domain APIML 1" Gateway where they are registed to, to accept routed requests.
It is necessary that the root and, if applicable, intermediate public certificates be shared between the these domain API Mediation Layers.
Copy link
Member

Choose a reason for hiding this comment

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

remove 'the' before these domain


The following commands are examples of establishing a trust relationship between a Domain API ML and the Central API ML for both PKCS12 certificates and when using keyrings.
The following commands are examples of establishing a trust relationship between a API MLs in Multitenancy Configuration for both PKCS12 certificates and when using keyrings.
Copy link
Member

Choose a reason for hiding this comment

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

remove 'a' before API MLs

@github-actions github-actions bot temporarily deployed to pull request December 19, 2024 12:32 Inactive
@github-actions github-actions bot temporarily deployed to pull request December 19, 2024 12:53 Inactive
@Shobhajayanna Shobhajayanna merged commit d3ea8dc into docs-staging Dec 20, 2024
4 checks passed
@Shobhajayanna Shobhajayanna deleted the refactor-troubleshoot-cgw branch December 20, 2024 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants