Skip to content

Commit

Permalink
Merge pull request #3476 from zowe/janan07-fix-broken-links-in-master
Browse files Browse the repository at this point in the history
Fix broken links after API ML using reorg
  • Loading branch information
janan07 authored Feb 28, 2024
2 parents a44c248 + edc5e2a commit eb26709
Show file tree
Hide file tree
Showing 20 changed files with 32 additions and 27 deletions.
2 changes: 1 addition & 1 deletion docs/appendix/zowe-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Refers to the desktop UI that is part of the [Zowe Application Framework](#zowe-

#### Zowe Embedded Browser for RMF/SMF and APIs (ZEBRA)

Provides re-usable and industry-compliant JSON-formatted RMF/SMF data records so that other ISV SW and users can exploit them using open-source SW for many ways. For more information, see the [ZEBRA documentation](https://github.com/zowe/zebra/tree/main/Documentation) or visit the [ZEBRA demo site](https://zebra.talktothemainframe.com:3390/).
Provides re-usable and industry-compliant JSON-formatted RMF/SMF data records so that other ISV SW and users can exploit them using open-source SW for many ways. For more information, see the [ZEBRA documentation](https://github.com/zowe/zebra/tree/main/Documentation) or visit [Real ZEBRA Use Cases in Large Production Systems](https://openmainframeproject.org/blog/real-zebra-use-cases-in-large-production-systems-video/) in the Open Mainframe Project website.

#### Zowe install packaging 

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,8 @@ The following schemes are supported by the API Gateway:
* When a Zowe JWT is provided, this scheme value specifies that the service accepts the Zowe JWT. No additional processing is done by the API Gateway.
* When a client certificate is provided, the certificate is transformed into a Zowe JWT, and the southbound service performs the authentication.
* If the southbound service needs to consume the JWT token from a custom HTTP request header to participate in the Zowe SSO, it is possible to provide a header in the Gateway configuration.
The HTTP header is then added to each request towards the southbound service and contains the Zowe JWT to be consumed by the service. See [Advanced Gateway features configuration](../../user-guide/api-mediation/api-gateway-configuration.md) for more information about the custom HTTP request header.
The HTTP header is then added to each request towards the southbound service and contains the Zowe JWT to be consumed by the service. See [Enabling single sign on for extending services via JWT token configuration](../../user-guide/api-mediation/configuration-extender-jwt).


* **httpBasicPassTicket**

Expand Down
2 changes: 1 addition & 1 deletion docs/extend/extend-apiml/onboard-plain-java-enabler.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Ensure that the prerequisites from the [Onboarding Overview](onboard-overview.md

* Following this guide enables REST services to be deployed on a z/OS environment. Deployment to a z/OS environment, however, is not required. As such, you can first develop on a local machine before you deploy on z/OS.

* The API Mediation Layer provides the sample application using the Plain Java Enabler in the [api-layer repository](https://github.com/zowe/api-layer/tree/master/onboarding-enabler-java-sample-app)
* The API Mediation Layer provides the sample application using the Plain Java Enabler in the [api-layer repository](https://github.com/zowe/api-layer/tree/v2.x.x/onboarding-enabler-java-sample-app)

## Configuring your project

Expand Down
2 changes: 1 addition & 1 deletion docs/extend/extend-apiml/zaas-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ This method has an added layer of security, whereby you do not have to provide a

In return, this method provides a valid pass ticket as a String to the authorized user.

**Tip:** For additional information about PassTickets in API ML see [Enabling PassTicket creation for API Services that Accept PassTickets](https://docs.zowe.org/stable/extend/extend-apiml/api-mediation-passtickets.html).
**Tip:** For additional information about PassTickets in API ML see [Enabling single sign on for extending services via PassTicket configuration](../../user-guide/api-mediation/configuration-extender-passtickets).

## Getting Started (Step by Step Instructions)

Expand Down
2 changes: 1 addition & 1 deletion docs/extend/extend-desktop/mvd-server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ ZWED_logLevels_org____zowe____terminal____tn3270_x2e_x2a:5
* objects are never values. They are the keys.

## Friendly names for environment variables
Some common configuration options have names that do not follow the above special syntax. These options get mapped to the special syntax when the server runs, so the same behavior can be configured in more than one way. Many of these values are listed here https://docs.zowe.org/stable/user-guide/configure-zowe-zosmf-workflow/#configure-the-zowe-instance-directory but for the App Server, the code that maps these values is contained within https://github.com/zowe/zlux-app-server/blob/v2.x/master/bin/convert-env.sh
Some common configuration options have names that do not follow the above special syntax. These options get mapped to the special syntax when the server runs, so the same behavior can be configured in more than one way. Many of these values are listed here https://docs.zowe.org/stable/user-guide/configure-zowe-zosmf-workflow/#configure-the-zowe-instance-directory.


Although overridden by both environment variables and CLI arguments, for convenience the App server and ZSS read from a configuration file with a common structure. ZSS reads this directly as a startup argument, while the App Server as defined in the [zlux-server-framework](https://github.com/zowe/zlux-server-framework) repository accepts several parameters which are intended to be read from a YAML file through an implementer of the server, such the default provided in the [zlux-app-server](https://github.com/zowe/zlux-app-server) repository, namely the [lib/zluxServer.js](https://github.com/zowe/zlux-app-server/blob/v2.x/master/lib/zluxServer.js) file. This file accepts a YAML file that specifies most if not all parameters needed, but some other parameters can be provided via flags if desired.
Expand Down
2 changes: 1 addition & 1 deletion docs/extend/k8s-extend.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ An extension must have a container image to run in a Zowe container environment.

The core components define component Dockerfiles and use GitHub Actions to build images. For example,

- `jobs-api` is a component which has built-in web service. To build the images, this component defines a Dockerfile at https://github.com/zowe/jobs/blob/v2.x/master/container/Dockerfile and defines a GitHub Actions workflow at https://github.com/zowe/jobs/blob/v2.x/master/.github/workflows/jobs-api-images.yml.
- `jobs-api` is a component which has built-in web service. To build the images, this component defines a Dockerfile at https://github.com/zowe/jobs/blob/v2.x/master/container/Dockerfile and defines a GitHub Actions workflow at https://github.com/zowe/jobs/tree/v2.x/master/.github/workflows.
- `explorer-jes` is a Zowe App Server Framework plug-in but does not have a built-in web service. It follows Zowe's [container conformance criteria](https://github.com/zowe/zowe-install-packaging/blob/v2.x/staging/containers/conformance.md). It defines a Dockerfile at https://github.com/zowe/explorer-jes/blob/v2.x/master/container/Dockerfile. Similar to `jobs-api`, it also defines a GitHub Actions workflow at https://github.com/zowe/explorer-jes/blob/v2.x/master/.github/workflows/build_test.yml to build the images.

The following GitHub Actions are used by the core components to build conformant images. They might not be completely reusable for you, but are provided as an example.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The Zowe Launcher makes it possible to launch Zowe z/OS server components in a h

### API Mediation Layer

The API Mediation Layer provides a single point of access for APIs of mainframe services, and provides a [Single Sign On (SSO)](../extend/extend-apiml/api-mediation-sso.md) capability for mainframe users.
The API Mediation Layer provides a single point of access for APIs of mainframe services, and provides a [Single Sign On (SSO)](../user-guide/api-mediation-sso) capability for mainframe users.

The API Mediation Layer (API ML) facilitates secure communication between loosely coupled clients and services through a variety of API types, such as REST, GraphQL or Web-Socket.
API ML consists of these core components: the API Gateway, the Discovery Service, the API Catalog, and the Caching service:
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-apiml.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The following definition of skill levels about Zowe assist you with gathering th

This article describes how API ML uses Transport Layer Security (TLS). Use this guide to familiarize yourself with the API ML security concepts.

- [**Zowe API Mediation Layer Single-Sign-On Overview**](../extend/extend-apiml/api-mediation-sso.md)
- [**Zowe API Mediation Layer Single Sign On Overview**](../user-guide/api-mediation-sso)

This article provides an overview of the API ML single-sign-on feature, the principle participants in the SSO process, and links to detailed Zowe SSO documentation.

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshoot/ze/troubleshoot-ze.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ As a Zowe Explorer user, you may encounter problems when using Visual Studio Cod
2. Review the current list of [Known issues](known-ze.md) in documentation. Also, try searching using the Zowe Docs search bar (keyboard shortcut `ctrl` + `k`).
3. Collect the following information to help diagnose the issue:
- The Zowe Explorer and Visual Studio Code versions installed
- See [Checking your Zowe version release number](troubleshoot/troubleshoot-check-your-zowe-version.md#zowe-explorer-for-visual-studio-code) for information.
- See [Checking your Zowe version release number](../troubleshoot-check-your-zowe-version/#zowe-explorer-for-visual-studio-code) for information.
- Node.js and NPM versions installed
- Whether you have Zowe CLI and the Secure Credential Store (SCS) Zowe CLI plug-in installed

Expand Down
5 changes: 3 additions & 2 deletions docs/user-guide/address-authentication-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@ For information about using MFA in Zowe Application Framework, see [Application
Multi-factor authentication requires configuration with Single-Sign-On (SSO). Ensure that SSO is configured before you use MFA in Zowe.
:::

## Single Sign-On (SSO)
## Single Sign On (SSO)

Zowe has an SSO scheme with the goal that each time you use multiple Zowe components you should only be prompted to login once.

Requirements:

- IBM z/OS Management Facility (z/OSMF)

For more information about single-sign-on (SSO), see [Zowe API Mediation Layer Single-Sign-On Overview](../extend/extend-apiml/api-mediation-sso.md).
For more information about single sign on (SSO), see [Zowe API Mediation Layer Single Sign On Overview](./api-mediation-sso).


## API Mediation Layer OIDC Authentication

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ The API Gateway provides different functionalities and implements several REST A

* [Update User Password](api-mediation-update-password.md)
* [JWT token refresh endpoint](api-mediation-jwt-token-refresh.md)
* [Personal Access Tokens](api-mediation-personal-access-token.md)
* [Personal Access Tokens](../api-mediation/authenticating-with-personal-access-token)
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,26 @@ Information from cached APIs is stored as a JSON in the following format:

The Caching Service supports the following storage solutions, which provide the option to add custom implementation.

For information about configuring your storage method for the Caching Service for high availability, see [Configuring the Caching Service for high availability](../../user-guide/configure-caching-service-ha)

### Infinispan (recommended)

Infinispan is a storage solution that can also run on the z/OS platform. It can store data structures in key-value pairs, has high-availability support, and is highly performant.

For more information about the Infinispan storage access method, see [Using Infinispan as a storage solution through the Caching service](../extend/extend-apiml/api-mediation-infinispan).
For more information about the Infinispan storage access method, see [Using Infinispan as a storage solution through the Caching service](../../extend/extend-apiml/api-mediation-infinispan).

### VSAM

VSAM can be used to organize records into four types of data sets: key-sequenced, entry-sequenced, linear, or relative record. Use VSAM as the storage solution for production. VSAM is used primarily for applications and is not used for source programs, JCL, or executable modules. ISPF cannot be used to display or edit VSAM files.

For more information about the VSAM storage access method, see [Using VSAM as a storage solution through the Caching Service](../extend/extend-apiml/api-mediation-vsam).
For more information about the VSAM storage access method, see [Using VSAM as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-vsam)

### Redis

Redis is a common storage solution that runs outside of the z/OS platform. It can store data structures in key-value pairs, has high-availability support, and is highly performant.

For more information about the Redis storage access method, see [Using Redis as a storage solution through the Caching Service](../extend/extend-apiml/api-mediation-redis).
For more information about the Redis storage access method, see [Using Redis as a storage solution through the Caching Service](../../extend/extend-apiml/api-mediation-redis).


### InMemory

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/api-mediation/api-mediation-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The most important part of the ecosystem are the real API services that provide
## Caching service

The Caching service aims to provide an API which offers the possibility to store, retrieve and delete data associated with keys. The service is used only by internal Zowe applications and is not exposed to the internet. The URL of the Caching service is `https://<ZOWE_HOST_IP>:7555`.
For more information, see the [Caching service documentation](../../extend/extend-apiml/api-mediation-caching-service.md).
For more information, see [Using the Caching Service](../api-mediation/api-mediation-caching-service).

## Metrics service (Techincal Preview)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
As a system administrator, you can customize the API Catalog UI to have a similar interface to your organization's service, or with your existing visualization portal.

* To customize the logotype and selected syle options in the zowe.yaml file, see [API Catalog branding](#api-catalog-branding).
* To replace or remove the API Catolog service from the Gateway home page and health checks, see [Replace or remove the Catalog with another service](./api-mediation/api-gateway-configuration/#replace-or-remove-the-catalog-with-another-service).
* To replace or remove the API Catolog service from the Gateway home page and health checks, see [Replace or remove the Catalog with another service](../api-mediation/configuration-customizing-the-api-catalog-ui/#replace-or-remove-the-catalog-with-another-service).

## API Catalog branding

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@
:::info Roles: system programmer, system administrator, security administrator
:::

By default the API Mediation Layer does not provide the ability to use personal access tokens. For more information about about
this functionality, see [Personal Access Tokens](api-mediation-personal-access-token.md).

Use the following procedure to enable personal access tokens.

1. Open the file `zowe.yaml`.
2. Find or add the property with the value `components.gateway.apiml.security.personalAccessToken.enabled: true`.
3. Restart Zowe.
3. Restart Zowe.

For more information about using personal access tokens, see [Authenticating with a Personal Access Token](./authenticating-with-personal-access-token).
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The caching services for each Zowe instance, whether on the same LPAR, or distri

For simplification of the diagram above, the Jobs and Files API servers are not shown as being started. If the user defines Jobs and Files API servers to be started in the `zowe.yaml` configuration file, these servers behave the same as the servers illustrated. In other words, these services register to their API discovery server which then communicates with other discovery servers on other Zowe instances on either the same or other LPARs. The API traffic received by any API gateway on any Zowe instance is routed to any of the Jobs or Files API components that are available.

To learn more about Zowe with high availability enablement, see [Configuring Sysplex for high availability](../user-guide/configure-sysplex.md).
To learn more about Zowe with high availability enablement, see [Configuring Sysplex for high availability](../configure-sysplex).

## API Versioning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ Update the z/OSMF configuration with the following parameter:
`allowBasicAuthLookup="false"`

After applying this change, each authentication call results in generating a new JWT.
For more information, see [Configuring z/OSMF](./systemrequirements-zosmf/#configuring-zosmf-to-properly-work-with-api-ml) to properly work with API ML, and [Multi-factor authentication configuration](./mvd-configuration/#multi-factor-authentication-configuration) in Configuring Zowe Application Framework.
For more information, see [Configuring z/OSMF](../../user-guide/systemrequirements-zosmf).
to properly work with API ML, and [Multi-factor authentication configuration](../mvd-configuration/#multi-factor-authentication-configuration) in Configuring Zowe Application Framework.

### No Notification when Additional Input is Required

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/configure-caching-service-ha.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In an HA setup the different Zowe API Mediation Gateway servers share the same n

Zowe uses the Caching Service to centralize the state data persistent in high availability (HA) mode. If you are runnning the caching service on z/OS there are three storage methods: `inMemory`, `infinispan` or `VSAM`. If you are running the caching service off platform, such as a Linux or Windows container image, it is also possible to specify `redis` or `infinispan`.

To learn more about Caching Service, see [Using the Caching Service](../extend/extend-apiml/api-mediation-caching-service.md).
To learn more about how the Caching Service can be used, see [Using the Caching Service](../user-guide/api-mediation/api-mediation-caching-service).

:::note
The Infinispan storage method is recommended for production usage.
Expand All @@ -30,7 +30,7 @@ The Infinispan storage method is recommended for production usage.
size: 10000
```
## infinispan
## Infinispan
Infinispan is designed to be run mainly on z/OS since it offers good performance. To enable this method, set the value of `zowe.components.caching-service.storage.mode` to `infinispan` in the `zowe.yaml` configuration file.
Infinispan environment variables are not currently following the v2 naming convention, so they must be defined into `zowe.environments` section. For more information on these properties and their values see [Infinispan configuration](../extend/extend-apiml/api-mediation-infinispan.md#infinispan-configuration).
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/install-zowe-smpe-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Publication Title | Form Number
[IBM SMP/E for z/OS Reference](https://www-01.ibm.com/servers/resourcelink/svc00100.nsf/pages/zOSV2R3sa232276/$file/gim2000_v2r3.pdf) | SA23-2276
[IBM SMP/E for z/OS Messages, Codes, and Diagnosis](https://www-01.ibm.com/servers/resourcelink/svc00100.nsf/pages/zOSV2R3ga320883/$file/gim0000_v2r3.pdf) | GA32-0883

These and other publications can be obtained from [https://www.ibm.com/shop/publications/order](https://www.ibm.com/shop/publications/order).
These and other publications can be obtained from [IBM Publications Center](https://www.ibm.com/resources/publications/?mhsrc=ibmsearch_a&mhq=publications).

## Program support

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/install-zowe-smpe.md
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@ In this step, you run the sample job ZWE7APLY to apply Zowe. This step can take
1. Ensure that you have the latest HOLDDATA; then edit and submit sample job ZWE7APLY to perform an SMP/E APPLY CHECK for Zowe. Consult the instructions in the sample job for more information.
The latest HOLDDATA is available through several different portals, including [https://service.software.ibm.com/holdata/390hdfaq.html](https://service.software.ibm.com/holdata/390hdfaq.html). The latest HOLDDATA may identify HIPER and FIXCAT APARs for the FMIDs you will be installing. Use the **APPLY CHECK** command to assist you to determine whether any HIPER or FIXCAT APARs are applicable to the FMIDs you are installing.
The latest HOLDDATA is available through several different portals, and may identify HIPER and FIXCAT APARs for the FMIDs you will be installing. Use the **APPLY CHECK** command to assist you to determine whether any HIPER or FIXCAT APARs are applicable to the FMIDs you are installing.
If there are any applicable HIPER of FIXCAT APARs, the **APPLY CHECK** also identifies fixing PTFs that will resolve the APARs, if a fixing PTF is available.
Expand Down

0 comments on commit eb26709

Please sign in to comment.