Skip to content

Commit

Permalink
Merge pull request #3461 from zowe/anax-v3-synchingwmaster-v3changes-…
Browse files Browse the repository at this point in the history
…docs

Anax v3 synchingwmaster v3changes docs
  • Loading branch information
anaxceron authored Feb 23, 2024
2 parents b41e074 + a3ae830 commit fba1bf1
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 89 deletions.
14 changes: 8 additions & 6 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ jobs:
cancel-in-progress: true

steps:
- name: Set Swap Space
uses: pierotofy/set-swap-space@master
with:
swap-size-gb: 6
# - name: Set Swap Space
# uses: pierotofy/set-swap-space@master
# with:
# swap-size-gb: 6

- name: Checkout
uses: actions/checkout@v3
Expand All @@ -32,12 +32,14 @@ jobs:

- name: Cache Webpack Build
uses: actions/cache@v3
env:
TAR_OPTIONS: "--remove-files"
with:
path: node_modules/.cache/webpack
key: cache-webpack-${{ github.base_ref || github.ref_name }}

- name: Install Dependencies
run: npm ci
run: npm ci --omit=dev

- name: Build with Docusaurus
run: npm run build
Expand All @@ -62,7 +64,7 @@ jobs:
if: ${{ steps.deploy.conclusion == 'skipped' }}
run: |
echo "PR_NUMBER=${{ github.event.pull_request.number }}" > build/.env
tar --zstd -cf build.tar.zst build
tar --remove-files --zstd -cf build.tar.zst build
- name: Upload Build Artifact
if: ${{ steps.deploy.conclusion == 'skipped' }}
Expand Down
30 changes: 6 additions & 24 deletions docs/appendix/zowe-yaml-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,33 +64,15 @@ The YAML configuration file has few high-level sections:

### Extract sharable configuration out of zowe.yaml

The Zowe YAML configuration file supports a special `@include` annotation that can be used in any level of the configuration. This enables you to organize your YAML configuration files and extract sharable configurations to a separate YAML file.
The Zowe YAML configuration file supports splitting into several files or PARMLIB members when "zowe.useConfigmgr" is set to true. This can help simplify grouping configuration changes by type or owner.
More details can be found [in the configmgr documentation.](../user-guide/configmgr-using.md#splitting-configuration-into-multiple-storage-types)

For example, you can define a sharable certificate configuration file `<keystore-dir>/zowe-certificates.yaml` like this:

```yaml
keystore:
type: PKCS12
file: /global/zowe/keystore/localhost/localhost.keystore.p12
password: password
alias: localhost
truststore:
type: PKCS12
file: /global/zowe/keystore/localhost/localhost.truststore.p12
password: password
pem:
key: /global/zowe/keystore/localhost/localhost.key
certificate: /global/zowe/keystore/localhost/localhost.cer
certificateAuthorities: /global/zowe/keystore/local_ca/local_ca.cer
```
### Creating portable references

Then in your `zowe.yaml`, you can import this certification file like this:

```yaml
zowe:
certificate:
@include: "<keystore-dir>/zowe-certificates.yaml"
```
The Zowe YAML configuration file has template logic for relating one value to another, a system environment variable or symbol, or even to add conditional behavior.
This feature is available when "zowe.useConfigmgr" is set to true, and it can help to make your configuration portable between systems that need slightly different behavior while retaining the same configuration file.
More details can be found [in the configmgr documentation.](../user-guide/configmgr-using.md#configuration-templates)

### Configuration override

Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/api-mediation-sso.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Zowe API Mediation Layer Single-Sign-On Overview
# Zowe API Mediation Layer Single Sign On Overview

You can extend Zowe and utilize Zowe Single-Sign-On (SSO) provided by Zowe API Mediation Layer (API ML) to enhance system security and improve the user experience.
You can extend Zowe and utilize Zowe Single Sign On (SSO) provided by Zowe API Mediation Layer (API ML) to enhance system security and improve the user experience.

:::info Required roles: system administrator, security administrator
:::

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. Zowe Single-Sign-On is based on single-user authentication which produces an access token that represents the user in communication with z/OS services accessible through the API Mediation Layer. The access token is issued by the Zowe Authentication and Authorization Service (ZAAS), which is part of API ML. ZAAS issues an access token based on valid z/OS credentials. This token can be validated by any component participating in 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. Zowe Single Sign On is based on single-user authentication which produces an access token that represents the user in communication with z/OS services accessible through the API Mediation Layer. The access token is issued by the Zowe Authentication and Authorization Service (ZAAS), which is part of API ML. ZAAS issues an access token based on valid z/OS credentials. This token can be validated by any component participating in SSO.

:::note
Currently, API ML can provide SSO only in a single security domain.
Expand Down Expand Up @@ -59,7 +59,7 @@ The REST API of ZAAS can easily be called from a Java application using the [ZAA
If you have a service that cannot be changed to adopt the Zowe authentication token, the service can utilize Zowe SSO if the API service is able to handle PassTickets.

:::note
For more information, see [Enabling single sign on for extending services via PassTicket configuration](./api-mediation/configuration-extender-passtickets).
For more information, see [Enabling single sign on for extending services via PassTicket configuration](../user-guide/api-mediation/configuration-extender-passtickets).
:::

## Further resources
Expand Down
6 changes: 0 additions & 6 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,6 @@ module.exports = {
}),
},
themeConfig: {
announcementBar: {
id: 'announcementBar-1', // increment on change
content:
'📌 <b>Support for Zowe Version 1 ends on Sept. 30, 2024</b>. Follow <a href="https://docs.zowe.org/stable/extend/migrate-extensions/" target="_blank">this guide</a> to migrate to Zowe Version 2.',
textColor: '#000',
},
docs: {
sidebar: {
hideable: true
Expand Down
52 changes: 9 additions & 43 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit fba1bf1

Please sign in to comment.