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

docs: updated faq due to keycloak process change #180

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

MaximilianHauer
Copy link
Contributor

Description

Due to keycloak upgrade processes needed an adjustment.

Issue

not needed

Checklist

Please delete options that are not relevant.

  • I have followed the contributing guidelines
  • I have added copyright and license headers, footers (for .md files) or files (for images)
  • I have performed a self-review of my changes
  • I have successfully tested my changes
  • I have added comments in the default values.yaml file with helm-docs syntax ('# -- ') if relevant for installation
  • I have commented my changes, particularly in hard-to-understand areas

- adjusted process for the user creation (technical/business) due to changes in keycloak prozess
- adjusted/refurbished several descriptions.
- adjusted structure
- adjusted markdown
- adjusted structure
- adjusted markdown
@MaximilianHauer
Copy link
Contributor Author

@evegufy i noticed with @Phil91 that the way how the user creation works in keycloak changed. therefor we adjuted the documentation and refurbished it overall a bit.

Copy link
Member

@Phil91 Phil91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one minor adjustment needed.

docs/technical documentation/11. FAQ.md Outdated Show resolved Hide resolved
Phil91
Phil91 previously approved these changes Sep 2, 2024
Copy link
Contributor

@evegufy evegufy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great that you looked into updating those FAQs, I just noticed that they are really outdated

  • I think the company role question should be moved to the portal documentation as it doesn't have any connection to iam
  • the portal role question should maybe be rewritten to be applicable to every shared service not just portal and the portal seeding/db updates should be moved into the portal docs
  • for What is the difference between roles & permission: there should maybe be mentioned that the Keycloak terminology for what we call here roles is composite roles and the Keycloak terminology for what we call often permissions or details roles is just roles...
  • I don't think this match between uuid in Keycloak and in portal is needed (at least not anymore): 1st to get the role id move into your browser open the user role configuration and copy the second UUID from the url. For adding the role into the portal seeding data some autogenerated uuid can be used

![ClientRoles](/docs/static/client-roles.png)

2. Create the same role inside the portal db (either via a delta migration job) or via sql.
#### 2. Create the business role inside the portal db (either via a delta migration job) or via sql
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be better to remove the way via sql entirely as that makes it seem as we somehow suggest that but from a good practice point of view, we should only propagate the way via updating the portal seeding data, which here is called delta migration job as that the only sustainable way, via sql might be useful for a short test but nothing else

docs/technical documentation/11. FAQ.md Outdated Show resolved Hide resolved

![ClientRoles](/docs/static/client-roles.png)
#### 2. Create the technical role inside the portal db (either via a delta migration job) or via sql
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be better to remove the way via sql entirely as that makes it seem as we somehow suggest that but from a good practice point of view, we should only propagate the way via updating the portal seeding data, which here is called delta migration job as that the only sustainable way, via sql might be useful for a short test but nothing else

removed spelling errors

Co-authored-by: Evelyn Gurschler <[email protected]>
Copy link

sonarcloud bot commented Sep 13, 2024

@MaximilianHauer MaximilianHauer added this to the Release 24.12 milestone Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: IN PROGRESS
Development

Successfully merging this pull request may close these issues.

3 participants