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: add quick guide to the charts' README #520

Conversation

paullatzelsperger
Copy link
Contributor

@paullatzelsperger paullatzelsperger commented Jun 22, 2023

WHAT

Improves the README.md files (or rather: the *.gotmpl) of our helm charts explaining some details about SSI.

WHY

better documentation

FURTHER NOTES

  • removed the controlplane.ssi.endpoint.audience setting, as this always defaults to the callback URL

Closes # <-- insert Issue number if one exists

@paullatzelsperger
Copy link
Contributor Author

\cc @jimmarino

@paullatzelsperger paullatzelsperger force-pushed the docs/improve_gotmpl_of_helm_charts branch 2 times, most recently from fa7c4cc to 8b4f9f2 Compare June 22, 2023 07:54
@paullatzelsperger paullatzelsperger force-pushed the docs/improve_gotmpl_of_helm_charts branch 6 times, most recently from 271eea5 to 9500009 Compare June 22, 2023 08:11
@paullatzelsperger paullatzelsperger force-pushed the docs/improve_gotmpl_of_helm_charts branch from 9500009 to ec1073c Compare June 22, 2023 08:12
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@paullatzelsperger paullatzelsperger merged commit e3ef31c into eclipse-tractusx:main Jun 22, 2023
Copy link
Contributor

@jimmarino jimmarino left a comment

Choose a reason for hiding this comment

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

LGTM, just a few minor comments


These must be obtained from a DAPS instance, the process of which is out of the scope of this document. Alternatively,
self-signed certificates can be used for testing:
- the Managed Identity Walled (MIW) must be running and reachable via network
Copy link
Contributor

Choose a reason for hiding this comment

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

channeling my inner Grammarly: "via the network"

Portal during participant onboarding
- KeyCloak must be running and reachable via network
- an account with KeyCloak must be created for this BPN and the connector must be able to obtain access tokens
- the client ID and client secret corresponding to that account must be known
Copy link
Contributor

Choose a reason for hiding this comment

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

Keycloak account

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

3 participants