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

Doc re-branding across all Zowe versions #1908

Merged
merged 8 commits into from
Dec 2, 2021
5 changes: 3 additions & 2 deletions docs/extend/extend-apiml/api-mediation-passtickets.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ The API Gateway provides the user ID and password in the Authorization header of

- [Outline for enabling PassTicket support](#outline-for-enabling-passticket-support)
- [Security configuration that allows the Zowe API Gateway to generate PassTickets for an API service](#security-configuration-that-allows-the-zowe-api-gateway-to-generate-passtickets-for-an-api-service)
- [ACF2](#ca-acf2)
- [Top Secret](#ca-top-secret)

- [ACF2](#acf2)
- [Top Secret](#top-secret)
- [RACF](#racf)
- [API services that support PassTickets](#api-services-that-support-passtickets)
- [API Services that register dynamically with API ML that provide authentication information](#api-services-that-register-dynamically-with-api-ml-that-provide-authentication-information)
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 @@ -108,7 +108,7 @@ The API Catalog is the catalog of published API services and their associated do

**Catalog Security**

Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, CA ACF2, or CA Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the z/OSMF API.
Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, ACF2, or Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the z/OSMF API.

**Caching Service**

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 @@ -36,7 +36,7 @@ The API Catalog is the catalog of published API services and their associated do

#### Catalog Security

Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, CA ACF2, or CA Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the zOSMF API.
Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, ACF2, or Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the zOSMF API.

## Onboarding APIs
The most important part of the ecosystem are the real API services that provide useful APIs. Use the following topics to understand what options you have for adding new APIs to the Mediation Layer:
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/configure-certificates-keyring.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To customize the `ZWEKRING` JCL, edit the JCL variables at the beginning of the

### `PRODUCT` variable

The `PRODUCT` variable specifies the z/OS security manager. The default value is `RACF`. Change the value to `ACF2` or `TSS` if you are using Access Control Facility CA-ACF2 or CA Top Secret for z/OS as your z/OS security manager.
The `PRODUCT` variable specifies the z/OS security manager. The default value is `RACF`. Change the value to `ACF2` or `TSS` if you are using ACF2 or Top Secret for z/OS as your z/OS security manager.

```
// SET PRODUCT=RACF * RACF, ACF2, or TSS
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/configure-certificates-keystore.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ To customize the `ZWESSOTK` JCL, edit the JCL variables at the beginning of the

#### `PRODUCT` variable

The `PRODUCT` variable specifies the z/OS security manager. The default value is `RACF`. Change the value to `ACF2` or `TSS` if you are using Access Control Facility CA-ACF2 or CA Top Secret for z/OS as your z/OS security manager.
The `PRODUCT` variable specifies the z/OS security manager. The default value is `RACF`. Change the value to `ACF2` or `TSS` if you are using ACF2 or Top Secret for z/OS as your z/OS security manager.

```
// SET PRODUCT=RACF * RACF, ACF2, or TSS
Expand Down
28 changes: 14 additions & 14 deletions docs/user-guide/configure-zos-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ For every TSO user ID that is going to log on to Zowe and use services that requ
CONNECT (userid) GROUP(IZUUSER)
```

- If you use CA ACF2, issue the following commands:
- If you use ACF2, issue the following commands:

```
ACFNRULE TYPE(TGR) KEY(IZUUSER) ADD(UID(<uid string of user>) ALLOW)
F ACF2,REBUILD(TGR)
```

- If you use CA Top Secret, issue the following commands:
- If you use Top Secret, issue the following commands:

```
TSS ADD(userid) PROFILE(IZUUSER)
Expand Down Expand Up @@ -95,7 +95,7 @@ Define or check the following configurations depending on whether ICSF is alread
```
SETROPTS RACLIST(CSFSERV) REFRESH
```
- If you use CA ACF2, issue the following commands (note that `profile-prefix` and `profile-suffix` are user-defined):
- If you use ACF2, issue the following commands (note that `profile-prefix` and `profile-suffix` are user-defined):
```
SET CONTROL(GSO)
```
Expand All @@ -119,7 +119,7 @@ Define or check the following configurations depending on whether ICSF is alread
```
F ACF2,REBUILD(CSF)
```
- If you use CA Top Secret, issue the following command (note that `profile-prefix` and `profile-suffix` are user defined):
- If you use Top Secret, issue the following command (note that `profile-prefix` and `profile-suffix` are user defined):
```
TSS ADDTO(owner-acid) RESCLASS(CSFSERV)
```
Expand Down Expand Up @@ -156,14 +156,14 @@ You can issue the following commands first to check whether you already have the
```
RLIST FACILITY BPX.DAEMON AUTHUSER
```
- If you use CA Top Secret, issue the following commands:
- If you use Top Secret, issue the following commands:
```
TSS WHOHAS IBMFAC(BPX.SERVER)
```
```
TSS WHOHAS IBMFAC(BPX.DAEMON)
```
- If you use CA ACF2, issue the following commands:
- If you use ACF2, issue the following commands:
```
SET RESOURCE(FAC)
```
Expand Down Expand Up @@ -208,7 +208,7 @@ If the user `ZWESVUSR` who runs the Zowe server started task does not have UPDAT
```
RLIST FACILITY BPX.DAEMON AUTHUSER
```
- If you use CA Top Secret, complete the following steps:
- If you use Top Secret, complete the following steps:

1. Define the BPX Resource and access for <zowe_stc_user>.
```
Expand All @@ -228,7 +228,7 @@ If the user `ZWESVUSR` who runs the Zowe server started task does not have UPDAT
```
TSS WHOHAS IBMFAC(BPX.DAEMON)
```
- If you use CA ACF2, complete the following steps:
- If you use ACF2, complete the following steps:
1. Define the BPX Resource and access for <zowe_stc_user>.
```
SET RESOURCE(FAC)
Expand Down Expand Up @@ -360,15 +360,15 @@ If you have not run `ZWESECUR` and are configuring your z/OS environment manuall
SETROPTS REFRESH RACLIST(STARTED)
```

- If you use CA ACF2, issue the following commands:
- If you use ACF2, issue the following commands:

```
SET CONTROL(GSO)
INSERT STC.ZWESVSTC LOGONID(ZWESVUSR) GROUP(ZWEADMIN) STCID(ZWESVSTC)
F ACF2,REFRESH(STC)
```

- If you use CA Top Secret, issue the following commands:
- If you use Top Secret, issue the following commands:

```
TSS ADDTO(STC) PROCNAME(ZWESVSTC) ACID(ZWESVUSR)
Expand All @@ -392,15 +392,15 @@ If you have not run `ZWESECUR` and are configuring your z/OS environment manuall
SETROPTS REFRESH RACLIST(STARTED)
```

- If you use CA ACF2, issue the following commands:
- If you use ACF2, issue the following commands:

```
SET CONTROL(GSO)
INSERT STC.ZWESLSTC LOGONID(ZWESVUSR) GROUP(ZWEADMIN) STCID(ZWESLSTC)
F ACF2,REFRESH(STC)
```

- If you use CA Top Secret, issue the following commands:
- If you use Top Secret, issue the following commands:

```
TSS ADDTO(STC) PROCNAME(ZWESLSTC) ACID(ZWESVUSR)
Expand Down Expand Up @@ -454,7 +454,7 @@ To do this, issue the following commands that are also included in the `ZWESECUR
```
This shows the user IDs who have access to the `ZWES.IS` class, which should include Zowe's started task user ID with READ access.

- If you use CA ACF2, issue the following commands:
- If you use ACF2, issue the following commands:

```
SET RESOURCE(FAC)
Expand All @@ -466,7 +466,7 @@ To do this, issue the following commands that are also included in the `ZWESECUR
F ACF2,REBUILD(FAC)
```

- If you use CA Top Secret, issue the following commands, where `owner-acid` can be IZUSVR or a different ACID:
- If you use Top Secret, issue the following commands, where `owner-acid` can be IZUSVR or a different ACID:

```
TSS ADD(`owner-acid`) IBMFAC(ZWES.)
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/install-ha-sysplex.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ You can configure the Zowe high availability runtime by using JCL and shell scri
SETROPTS RACLIST(STARTED) REFRESH
```

- If you use CA ACF2, issue the following commands:
- If you use ACF2, issue the following commands:

```
SET CONTROL(GSO)
Expand All @@ -107,7 +107,7 @@ You can configure the Zowe high availability runtime by using JCL and shell scri
F ACF2,REFRESH(STC)
```

- If you use CA Top Secret, issue the following commands:
- If you use Top Secret, issue the following commands:

```
TSS ADD(STC) PROCNAME(&ZLNCHSTC.) ACID(&ZOWEUSER.)
Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/systemrequirements-zosmf-lite.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,11 +201,11 @@ Check out the video for a demo of the process:

The security job IZUNUSEC contains a minimal set of RACF® commands for creating security profiles for the z/OSMF nucleus. The profiles are used to protect the resources that are used by the z/OSMF server, and to grant users access to the z/OSMF core functions. IZUNUSEC is a simplified version of the sample job IZUSEC, which is intended for a more complete installation of z/OSMF.

**Note:** If your implementation uses an external security manager other than RACF (for example, CA Top Secret or CA ACF2), provide equivalent commands for your environment. For more information, see the following CA Technologies product documentation:
**Note:** If your implementation uses an external security manager other than RACF (for example, Top Secret or ACF2), provide equivalent commands for your environment. For more information, see the following product documentation:

- [Configure z/OS Management Facility for CA Top Secret](https://docops.ca.com/ca-top-secret-for-z-os/16-0/en/installing/configure-z-os-management-facility-for-ca-top-secret)
- [Configure z/OS Management Facility for Top Secret](https://docops.ca.com/ca-top-secret-for-z-os/16-0/en/installing/configure-z-os-management-facility-for-ca-top-secret)

- [Configure z/OS Management Facility for CA ACF2](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-acf2-for-z-os/16-0/installing/configure-z-os-management-facility-for-ca-acf2.html)
- [Configure z/OS Management Facility for ACF2](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-acf2-for-z-os/16-0/installing/configure-z-os-management-facility-for-ca-acf2.html)

#### Before you begin

Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/systemrequirements-zosmf.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ User IDs | User IDs require a TSO segment (access) and an OMVS segment. During

Point your browser at the nominated z/OSMF STANDALONE Server home page and you should see its Welcome Page where you can log in.

**Note:** If your implementation uses an external security manager other than RACF (for example, CA Top Secret for z/OS or CA ACF2 for z/OS), you provide equivalent commands for your environment. For more information, see the following product documentation:
**Note:** If your implementation uses an external security manager other than RACF (for example, Top Secret for z/OS or ACF2 for z/OS), you provide equivalent commands for your environment. For more information, see the following product documentation:

- [Configure z/OS Management Facility for CA Top Secret](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/security/ca-top-secret-for-z-os/16-0/installing/configure-z-os-management-facility-for-ca-top-secret.html)
- [Configure z/OS Management Facility for Top Secret](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/security/ca-top-secret-for-z-os/16-0/installing/configure-z-os-management-facility-for-ca-top-secret.html)

- [Configure z/OS Management Facility for CA ACF2](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-acf2-for-z-os/16-0/installing/configure-z-os-management-facility-for-ca-acf2.html)
- [Configure z/OS Management Facility for ACF2](https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-acf2-for-z-os/16-0/installing/configure-z-os-management-facility-for-ca-acf2.html)

## z/OSMF REST services for the Zowe CLI
The Zowe CLI uses z/OSMF Representational State Transfer (REST) APIs to work with system resources and extract system data. Ensure that the following REST services are configured and available.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The API Gateway provides the user ID and password in the Authorization header of

- [Outline for enabling PassTicket support](#outline-for-enabling-passticket-support)
- [Security configuration that allows the Zowe API Gateway to generate PassTickets for an API service](#security-configuration-that-allows-the-zowe-api-gateway-to-generate-passtickets-for-an-api-service)
- [CA ACF2](#ca-acf2)
- [CA Top Secret](#ca-top-secret)
- [ACF2](#acf2)
- [Top Secret](#top-secret)
- [RACF](#racf)
- [API services that support PassTickets](#api-services-that-support-passtickets)
- [API Services that register dynamically with API ML that provide authentication information](#api-services-that-register-dynamically-with-api-ml-that-provide-authentication-information)
Expand Down Expand Up @@ -48,7 +48,7 @@ Use the following variables to generate PassTickets for the API service to enabl

Replace the variables in the following examples with actual values.

### CA ACF2
### ACF2

Grant the Zowe started task user ID permission to generate PassTickets for users of that API service.
The following code is an example of security commands that need to be issued.
Expand All @@ -63,7 +63,7 @@ F ACF2,REBUILD(PTK),CLASS(P)
END
```

### CA Top Secret
### Top Secret

Grant the Zowe started task user ID permission to generate PassTickets for users of that API service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This method of basic routing is based on the service ID that identifies the serv

The URI identifies the resource, but does not identify the instance of the service as unique when multiple instances of the same service are provided. For example, when a service is running in high-availability (HA) mode.

Services of the same product that provide different resources, such as CA SYSVIEW on one system and CA SYSVIEW in a different sysplex, cannot have the same service ID (the same URI cannot have two different meanings).
Services of the same product that provide different resources, such as SYSVIEW on one system and SYSVIEW in a different sysplex, cannot have the same service ID (the same URI cannot have two different meanings).

In addition to the basic Zuul routing, the Zowe API Gateway supports versioning in which you can specify a major version. The Gateway routes a request only to an instance that provides the specified major version of the API.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ apiml.security.auth.provider: dummy

Authorization is a method used to determine access rights of an entity.

In the API ML, authorization is performed by the z/OS security manager ([CA ACF2](https://www.ca.com/us/products/ca-acf2.html), [IBM RACF](https://www.ibm.com/support/knowledgecenter/zosbasics/com.ibm.zos.zsecurity/zsecc_042.htm), [CA Top Secret](https://www.ca.com/us/products/ca-top-secret.html)). An authentication token is used as proof of valid authentication. The authorization checks, however, are always performed by the z/OS security manager.
In the API ML, authorization is performed by the z/OS security manager ([ACF2](https://www.ca.com/us/products/ca-acf2.html), [IBM RACF](https://www.ibm.com/support/knowledgecenter/zosbasics/com.ibm.zos.zsecurity/zsecc_042.htm), [Top Secret](https://www.ca.com/us/products/ca-top-secret.html)). An authentication token is used as proof of valid authentication. The authorization checks, however, are always performed by the z/OS security manager.

### JWT Token

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ The API Catalog is the catalog of published API services and their associated do

**Catalog Security**

Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, CA ACF2, or CA Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the z/OSMF API.
Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, ACF2, or Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the z/OSMF API.

#### Onboarding APIs
Essential to the API Mediation Layer ecosystem is the API services that expose their useful APIs. Use the following topics to discover more about adding new APIs to the API Mediation Layer and using the API Catalog:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The API Catalog is the catalog of published API services and their associated do

#### Catalog Security

Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, CA ACF2, or CA Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the zOSMF API.
Access to the API Catalog can be protected with an Enterprise z/OS Security Manager such as IBM RACF, ACF2, or Top Secret. Only users who provide proper mainframe credentials can access the Catalog. Client authentication is implemented through the zOSMF API.

## Onboarding APIs
The most important part of the ecosystem are the real API services that provide useful APIs. Use the following topics to understand what options you have for adding new APIs to the Mediation Layer:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To customize the `ZWEKRING` JCL, edit the JCL variables at the beginning of the

### `PRODUCT` variable

The `PRODUCT` variable specifies the z/OS security manager. The default value is `RACF`. Change the value to `ACF2` or `TSS` if you are using Access Control Facility CA-ACF2 or CA Top Secret for z/OS as your z/OS security manager.
The `PRODUCT` variable specifies the z/OS security manager. The default value is `RACF`. Change the value to `ACF2` or `TSS` if you are using ACF2 or Top Secret for z/OS as your z/OS security manager.

```
// SET PRODUCT=RACF * RACF, ACF2, or TSS
Expand Down
Loading