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

Move IAM federation doc to an ADR #74

Open
garloff opened this issue Sep 20, 2023 · 1 comment
Open

Move IAM federation doc to an ADR #74

garloff opened this issue Sep 20, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation housekeeping Internal housekeeping IAM Issues or pull requests relevant for SIG IAM

Comments

@garloff
Copy link
Contributor

garloff commented Sep 20, 2023

In PR #72, we merged docs on how federation is designed to be supported in SCS.
Reading through the texts, the impression came up that these are decision type documents that are Architecture Decision Records in the standards repository. So let's understand the intended nature of the document better (end user reference documentation vs ADR vs How-To) and then determine the final target destination.

@garloff garloff added documentation Improvements or additions to documentation IAM Issues or pull requests relevant for SIG IAM labels Sep 20, 2023
master-caster pushed a commit that referenced this issue Sep 28, 2023
Signed-off-by: Ralf Heiringhoff <ralf.heiringhoff@plusserver.com>
Co-authored-by: Max Wolfs <mail@maxwolfs.com>
@reqa
Copy link
Contributor

reqa commented Nov 8, 2023

Currently in https://github.com/SovereignCloudStack/docs/blob/main/dev-docs/operations/iam/openstack-federation-via-oidc.md , which to me looks like oriented towards SCS-developers. My intention with this was to explain to "technical SCS operators" (my wording) how things are intended to work in SCS, so they can e.g. adjust Keycloak config and Keycloak to Keystone mapping as needed. I'm also fine to move it into the "standards" section if the target audience matches. We can also document federation to SCS devs, but my intention was to provide a starting point for operators.

OTOH we have https://github.com/SovereignCloudStack/docs/blob/main/docs/05-iam/intra-SCS-federation-setup-description-for-osism-doc-operations.md , which is even more technical and will stay on that technical level for the foreseeable future. I guess moving that one into a "standard"/ADR would make more sense.

In a quick chat @fkr suggested to split it into two parts:

  • technical "how are things done" points should go into an ADR
  • operational "what do I need to do to achieve XYZ" should go into the operation docs

@maxwolfs maxwolfs added the housekeeping Internal housekeeping label Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation housekeeping Internal housekeeping IAM Issues or pull requests relevant for SIG IAM
Projects
Status: Backlog
Development

No branches or pull requests

3 participants