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

Final edits and Vale fixes in OIDC authorization code flow mechanism for protecting web applications guide for 3.2 #37024

Merged
merged 1 commit into from
Nov 15, 2023

Conversation

sheilamjones
Copy link
Contributor

This PR addresses final edits, fixes Vale errors and warnings, and pre-QE checks in the OIDC authorization code flow mechanism for protecting web applications guide for 3.2

@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Nov 11, 2023
@sheilamjones sheilamjones marked this pull request as draft November 11, 2023 08:37
Copy link

github-actions bot commented Nov 11, 2023

🙈 The PR is closed and the preview is expired.


But if you already have all the required `quarkus-oidc` properties configured then you only need to associate `quarkus.oidc.auth-server-url` with the `prod` profile for `Dev Services for Keycloak`to start a container, for example:
However, if you already have all the required `quarkus-oidc` properties configured, then you only need to associate `quarkus.oidc.auth-server-url` with the `prod` profile for `Dev Services for Keycloak`to start a container, for example:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
However, if you already have all the required `quarkus-oidc` properties configured, then you only need to associate `quarkus.oidc.auth-server-url` with the `prod` profile for `Dev Services for Keycloak`to start a container, for example:
However, if you already have all the required `quarkus-oidc` properties configured, then you only need to associate `quarkus.oidc.auth-server-url` with the `prod` profile for `Dev Services for Keycloak` to start a container, for example:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, thank you.

@@ -1466,19 +1485,20 @@ Additionally, `OidcWiremockTestResource` set token issuer and audience to `https
[[integration-testing-keycloak-devservices]]
=== Dev services for Keycloak

Using xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] is recommended for the integration testing against Keycloak.
`Dev Services for Keycloak` will launch and initialize a test container: it will create a `quarkus` realm, a `quarkus-app` client (`secret` secret) and add `alice` (`admin` and `user` roles) and `bob` (`user` role) users, where all of these properties can be customized.
Use xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] for integration testing against Keycloak.
Copy link
Member

Choose a reason for hiding this comment

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

It appears to me that this sentence does not have a message that this is a recommended way of testing. propose to revert

@@ -1466,19 +1485,20 @@ Additionally, `OidcWiremockTestResource` set token issuer and audience to `https
[[integration-testing-keycloak-devservices]]
=== Dev services for Keycloak

Using xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] is recommended for the integration testing against Keycloak.
`Dev Services for Keycloak` will launch and initialize a test container: it will create a `quarkus` realm, a `quarkus-app` client (`secret` secret) and add `alice` (`admin` and `user` roles) and `bob` (`user` role) users, where all of these properties can be customized.
Use xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] for integration testing against Keycloak.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Use xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] for integration testing against Keycloak.
Using xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] is recommended for integration testing against Keycloak.

@sheilamjones sheilamjones marked this pull request as ready for review November 14, 2023 19:50
@sberyozkin sberyozkin self-requested a review November 15, 2023 11:07
Copy link
Member

@sberyozkin sberyozkin left a comment

Choose a reason for hiding this comment

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

Thanks @sheilamjones

@sberyozkin sberyozkin merged commit 90f0bb3 into quarkusio:main Nov 15, 2023
5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.7 - main milestone Nov 15, 2023
@sheilamjones
Copy link
Contributor Author

Thank you @sberyozkin.
@aloubyansky/@gsmet/@maxandersen - This PR is ready for backport to 3.2.
Many thanks,
Sheila

@sheilamjones
Copy link
Contributor Author

Following revised planning for 3.2.8 (and agreed with QE), this guide will not be published in Red Hat build of Quarkus for 3.2.8. Therefore, a backport to 3.2 is not needed and I removed the backport triage labels . The fixes applied in this PR will be fixed and published in Main only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docstyle issues related for manual docstyle review area/documentation
Projects
Development

Successfully merging this pull request may close these issues.

3 participants