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

refresh multi tenancy and OIDC doc #4024

Merged
merged 49 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from 45 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
2b756a5
refresh multi tenancy and OIDC doc
achmelo Nov 28, 2024
90de9de
OIDC auth sequence update
achmelo Nov 28, 2024
792ff26
address review comments
achmelo Nov 28, 2024
097e997
formatting refactor
janan07 Nov 28, 2024
8d687bb
Merge branch 'reboot/oidc-doc-update' of https://github.com/zowe/docs…
janan07 Nov 28, 2024
0effeb8
Merge branch 'docs-staging' into reboot/oidc-doc-update
janan07 Nov 28, 2024
549d772
code review
achmelo Nov 29, 2024
f6007ca
Merge remote-tracking branch 'origin/reboot/oidc-doc-update' into reb…
achmelo Nov 29, 2024
88ccb09
formatting
achmelo Nov 29, 2024
13c006d
use 1 schema with alternatives
achmelo Nov 29, 2024
a36dbb9
code review
achmelo Nov 29, 2024
d610c33
Replace removed calendar with current one
balhar-jakub Nov 29, 2024
1bafb52
Merge branch 'docs-staging' into reboot/oidc-doc-update
balhar-jakub Nov 29, 2024
168e258
Fix Further Links
balhar-jakub Nov 29, 2024
8b7f00a
Fix cipher related link
balhar-jakub Nov 29, 2024
6bcb96d
Merge remote-tracking branch 'origin/reboot/oidc-doc-update' into reb…
balhar-jakub Nov 29, 2024
9b4aa8b
Fix 2.16 and Move to new Office Hours
balhar-jakub Nov 29, 2024
eb84123
Remove nonexistent links
balhar-jakub Nov 29, 2024
e89ef6f
Fix last CICS link
balhar-jakub Nov 29, 2024
e8bdc98
update diagram, code review comments
achmelo Dec 2, 2024
35d1575
describe steps in the diagram
achmelo Dec 5, 2024
354922e
language / formatting refactor
janan07 Dec 5, 2024
4a95986
minor language refactoring
janan07 Dec 5, 2024
09353e1
registry desc
achmelo Dec 5, 2024
fda7fb6
escape HTML signs
achmelo Dec 5, 2024
390b37f
update diagram and steps description
achmelo Dec 5, 2024
b02b2c9
add missing sign
achmelo Dec 5, 2024
1818e6f
remove obsolete prereq
achmelo Dec 6, 2024
a2a0c0d
restructure config section
achmelo Dec 6, 2024
7dbf3b6
update oidc options
richard-salac Dec 6, 2024
ad5e374
Merge remote-tracking branch 'origin/reboot/oidc-doc-update' into reb…
richard-salac Dec 6, 2024
308b55a
clarify oidc resource server feature toggle docs
richard-salac Dec 6, 2024
367fd1c
update anchors
achmelo Dec 6, 2024
a18a905
Merge remote-tracking branch 'origin/reboot/oidc-doc-update' into reb…
achmelo Dec 6, 2024
44ce28e
minor fix
janan07 Dec 6, 2024
d127b1c
add collapsible sections
janan07 Dec 6, 2024
031c56b
fix punctuation
janan07 Dec 6, 2024
aa884a5
remove duplicate content
achmelo Dec 6, 2024
883c85a
fix content table
achmelo Dec 6, 2024
0778db7
Merge remote-tracking branch 'origin/reboot/oidc-doc-update' into reb…
achmelo Dec 6, 2024
1b81119
remove word
janan07 Dec 6, 2024
2258719
formatting refactor
janan07 Dec 6, 2024
9041ced
remove broken link
achmelo Dec 9, 2024
2710927
Merge remote-tracking branch 'origin/reboot/oidc-doc-update' into reb…
achmelo Dec 9, 2024
9f1fea2
improve format and add collapsible content
janan07 Dec 9, 2024
41972ef
fix TOC
janan07 Dec 9, 2024
df670b4
fix links
achmelo Dec 9, 2024
0993001
fix anchor links
janan07 Dec 9, 2024
fd059f3
fix anchor links
janan07 Dec 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 24 additions & 16 deletions docs/diagrams/apiml-oidc-auth-seq.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,40 @@
autonumber
actor User
actor "User Agent" as Agent
actor "Client App" as Client
actor OIDC as OIDC
actor "API ML GW" as GW

User -> Agent: Do stuff
Agent -> Client: Open Client App
Client -> OIDC: Initiate OIDC flow [client_id, client_secret]
loop [MFA]
Agent -> GW: /gateway/oauth2/authorization/<provider-id>
GW -> OIDC: Initiate OIDC flow [client_id, client_secret]
group MFA
OIDC -> Agent: Request user credentials
User <-> Agent: Provide credentials
Agent -> OIDC: Validate credentials
end
OIDC --> Client: Return Auth Code / JWTs[access,refresh,identity]
Client -> GW: Request resources [JWT AT]
group validate
GW -> GW: Validate AT
GW -> OIDC: Validate AT
end
alt Validation success
GW -> GW: Cache AT validity
OIDC --> GW: Return Auth Code / JWTs[access,refresh,identity]
GW -> Agent: Set-cookie access token
Agent -> GW: Request resources [access token]
GW -> GW: Validate access token
GW -> GW: Cache access token validity
group map user
GW -> SAF: Map distributed ID to mainframe ID
end
alt mapping success
GW -> GW: Create Zowe JWT
GW -> Service: call API service
Service --> GW: return Response
GW -> Service: Call API service with Zowe JWT
Service -> Service: Validate JWT
Service --> GW: Return Response
autonumber 14 1
else mapping failure

GW -> Service: call API service with access token
note left: Step 13 Create Zowe JWT was skipped
Service -> Service: Validate access token
Service --> GW: Return Response
end
GW --> Client: Response
Client --> Agent: Response
autonumber 17 1
GW --> Agent: Response


@enduml
250 changes: 158 additions & 92 deletions docs/extend/extend-apiml/api-mediation-oidc-authentication.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The following list shows the default ciphers. API ML services use the following
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384
```

Only IANA ciphers names are supported. For more information, see [Cipher Suites](https://wiki.mozilla.org/Security/Server_Side_TLS#Cipher_suites) or [List of Ciphers](https://testssl.net/openssl-iana.mapping.html).
Only IANA ciphers names are supported. For more information, see [Cipher Suites](https://wiki.mozilla.org/Security/Server_Side_TLS#Cipher_suites) or [List of Ciphers](https://testssl.sh/openssl-iana.mapping.html).

## JSON Web Token (JWT)

Expand Down
4 changes: 2 additions & 2 deletions docs/extend/zowe-conformance-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ As vendors, you are invited to submit conformance testing results for review and

To participate in the Zowe Conformance Program, follow the process on the [Zowe Conformance Program website](https://openmainframeproject.org/our-projects/zowe-conformance-program/). You can also find a list of products that have earned Zowe Conformant status.

To learn the criteria of achieving Zowe conformance for an offering, see [Zowe Conformance Criteria](https://github.com/openmainframeproject/foundation/tree/master/zowe_conformance).
To learn the criteria of achieving Zowe conformance for an offering, see [Zowe Conformance Criteria](https://github.com/openmainframeproject/foundation/blob/main/zowe_conformance/test_evaluation_guide_table.md).

## How to suggest updates to the Zowe conformance program

The Zowe conformance criteria is available as a table in [a Markdown file](https://github.com/openmainframeproject/foundation/blob/master/zowe_conformance/test_evaluation_guide_table.md) in the Open Mainframe Project's GitHub repo. If you find a mistake with the Zowe conformance documents, or you are a Zowe squad lead and want to make an amendment to the criteria, you can update that Markdown file. The same information is also held in another document [Zowe Conformance Test Evaluation Guide](https://github.com/openmainframeproject/foundation/blob/master/zowe_conformance/test_evaluation_guide.md) that has history going back to Zowe 2019 conformance and allows easy change history comparison.
The Zowe conformance criteria is available as a table in [a Markdown file](https://github.com/openmainframeproject/foundation/blob/master/zowe_conformance/test_evaluation_guide_table.md) in the Open Mainframe Project's GitHub repo. If you find a mistake with the Zowe conformance documents, or you are a Zowe squad lead and want to make an amendment to the criteria, you can update that Markdown file. The same information is also held in another document [Zowe Conformance Test Evaluation Guide](https://github.com/openmainframeproject/foundation/blob/main/zowe_conformance/test_evaluation_guide_table.md) that has history going back to Zowe 2019 conformance and allows easy change history comparison.

To submit a proposal to update the conformance criteria, fork the OMP's `foundation` repository at [https://github.com/openmainframeproject/foundation](https://github.com/openmainframeproject/foundation) and make a pull request. Flag the Pull Request to the attention of GitHub user ID `@mertic`, and also reach out to the Zowe onboarding squad in the [#zowe-onboarding](https://openmainframeproject.slack.com/archives/CC60ALD61) Slack channel. If you are not already signed up to Zowe Slack community, you can sign up at [https://slack.openmainframeproject.org](https://slack.openmainframeproject.org/) first.

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 @@ -140,7 +140,7 @@ The following definition of skill levels about Zowe assist you with gathering th

Join the #zowe-api Slack channel to ask questions about Zowe API ML, propose new ideas, and interact with the Zowe community.

- [**Zowe API ML squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
- [**Zowe API ML squad meetings**](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe API ML squad meetings to get involved.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-app-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ The following definition of skill levels about Zowe will help you gather most re

Join the Slack channel to ask questions, propose new ideas, and interact with the Zowe community. <!--which slack channel is appropriate?-->

- [**Zowe WebUI squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
- [**Zowe WebUI squad meetings**](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe WebUI squad meetings to get involved.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-client-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The following definition of skill levels about Zowe will help you gather most re

Join the #zowe-cli Slack channel to ask questions about Zowe CLI and Zowe SDKs, propose new ideas, and interact with the Zowe community.

- [**Zowe CLI squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
- [**Zowe CLI squad meetings**](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe CLI squad meetings to discuss Zowe SDKs issues and contibute to Zowe SDKs.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-zowe-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ To identify the resources most relevant for you, use the following definitions o

Join the `# zowe-explorer` Slack channel to ask questions, propose new ideas, and interact with the Zowe community.

* [**Zowe Explorer squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
* [**Zowe Explorer squad meetings**](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe Explorer squad meetings to get involved.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/zowe-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The [OMP Youtube channel](https://www.youtube.com/channel/UC-WTXQQtz2m5iTflJLK59

**Connect with the community through meetings**

- [Zowe meeting calendar](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
- [Zowe meeting calendar](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe meetings to get latest Zowe updates and get involved in different squads and initiatives.

Expand Down
Binary file modified docs/images/api-mediation/apiml-oidc-auth-seq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading