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: Create procedure doc for use case "Deploy to Openshift in a single step" #45643

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

Conversation

sheilamjones
Copy link
Contributor

@sheilamjones sheilamjones commented Jan 16, 2025

This PR aims to draft a procedure for the following use case

  • Deploying Quarkus applications to OpenShift using a single command.

Reference: Deploying on OpenShift

@sheilamjones sheilamjones marked this pull request as draft January 16, 2025 11:46
@sheilamjones sheilamjones self-assigned this Jan 16, 2025
@sheilamjones sheilamjones force-pushed the QDOCS-1059-userstory1 branch 2 times, most recently from ef47119 to 15a6320 Compare January 24, 2025 14:34
@sheilamjones sheilamjones force-pushed the QDOCS-1059-userstory1 branch 2 times, most recently from 7484692 to 99e9386 Compare January 27, 2025 23:25
Copy link
Contributor

@rolfedh rolfedh left a comment

Choose a reason for hiding this comment

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

I recommend enclosing the admonitions in ==== blocks, although I wouldn’t expect that to directly cause the error you’re encountering. If that doesn’t resolve the issue, I’d suggest commenting out the include I mentioned earlier to see if it has any impact.

This is outside my area of expertise, but I also wonder if your local system might no longer meet the minimum requirements for the new Quarkus version. It’s possible that more recent versions of dependencies are now required.

Perhaps @MichalMaler and @jmartisk have some insights?

Comment on lines 48 to 50
[TIP]
If you want to test your application immediately, set the `quarkus.openshift.route.expose` config property to `true` to expose the service automatically.
For example, add `-Dquarkus.openshift.route.expose=true` to the command above.
For more information, see xref:deploying-to-openshift.adoc#exposing_routes[Exposing routes].
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[TIP]
If you want to test your application immediately, set the `quarkus.openshift.route.expose` config property to `true` to expose the service automatically.
For example, add `-Dquarkus.openshift.route.expose=true` to the command above.
For more information, see xref:deploying-to-openshift.adoc#exposing_routes[Exposing routes].
[TIP]
====
If you want to test your application immediately, set the `quarkus.openshift.route.expose` config property to `true` to expose the service automatically.
For example, add `-Dquarkus.openshift.route.expose=true` to the command above.
For more information, see xref:deploying-to-openshift.adoc#exposing_routes[Exposing routes].
====

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, thank you.

docs/src/main/asciidoc/deploying-to-openshift-howto.adoc Outdated Show resolved Hide resolved
Comment on lines 60 to 62
[IMPORTANT]
As of OpenShift 4.14, the `DeploymentConfig` object is deprecated.
For more information, see https://access.redhat.com/articles/7041372.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[IMPORTANT]
As of OpenShift 4.14, the `DeploymentConfig` object is deprecated.
For more information, see https://access.redhat.com/articles/7041372.
[IMPORTANT]
====
As of OpenShift 4.14, the `DeploymentConfig` object is deprecated.
For more information, see https://access.redhat.com/articles/7041372.
====

@sheilamjones sheilamjones force-pushed the QDOCS-1059-userstory1 branch from 99e9386 to b3bee1e Compare January 31, 2025 22:01
@sheilamjones sheilamjones marked this pull request as ready for review January 31, 2025 22:25
Copy link

github-actions bot commented Jan 31, 2025

🎊 PR Preview 2952e62 has been successfully built and deployed to https://quarkus-pr-main-45643-preview.surge.sh/version/main/guides/

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

@sheilamjones sheilamjones changed the title DRAFT DOCS: Create deploy to openshift procedure based on downstream guide Docs: Create procedure doc for use case "Deploy to Openshift in a single step" Jan 31, 2025
@sheilamjones sheilamjones requested a review from iocanel January 31, 2025 22:27
@sheilamjones
Copy link
Contributor Author

Hi @iocanel,
I would appreciate your review of this PR, which is based on the "Deploying to OpenShift using a single command" user story in the existing upstream guide. I plan to cross-link this and the other user story procedures (to follow) from one concept/overview doc to single source downstream.
Kind regards,
Sheila

This comment has been minimized.

Copy link
Contributor

@iocanel iocanel left a comment

Choose a reason for hiding this comment

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

Summary:

  • I don't see a reason for refering to Service Binding here.
  • Move notes about DeploymentConfig -> Deployment down (or remove completely).
  • Show the command earlier on thee doc.
  • Provide alternatives for maven / gradle when the CLI is not available

docs/src/main/asciidoc/deploying-to-openshift-howto.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/deploying-to-openshift-howto.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/deploying-to-openshift-howto.adoc Outdated Show resolved Hide resolved
For more information, see xref:deploying-to-openshift.adoc#exposing_routes[Exposing routes].
====

[[re-deploy-with-service-binding]]
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think that we should have any reference to service binding in the deploy in a single step doc.

Copy link
Contributor Author

@sheilamjones sheilamjones Feb 11, 2025

Choose a reason for hiding this comment

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

Removed paragraph. Note, this service binding reference was in the existing upstream guide. Should it be added elsewhere in one of the other procedures/guides?

:topics: devops,kubernetes,openshift,cloud,deployment
:extensions: io.quarkus:quarkus-openshift

As an application developer, you build and deploy your {project-name} applications to {openshift} by using a single command.
Copy link
Contributor

Choose a reason for hiding this comment

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

what command?

Copy link

quarkus-bot bot commented Feb 12, 2025

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit cc0a2c7.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

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

Successfully merging this pull request may close these issues.

3 participants