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 for Deploying on OpenShift using Docker build strategy #45918

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

Conversation

sheilamjones
Copy link
Contributor

@sheilamjones sheilamjones commented Jan 28, 2025

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

  • Build and deploy Quarkus applications on OpenShift using the docker build strategy.

Reference: Based on the Red Hat build of Quarkus guide Deploying on OpenShift Container Platform

Copy link

quarkus-bot bot commented Jan 28, 2025

Thanks for your pull request!

Your pull request does not follow our editorial rules. Could you have a look?

  • title should preferably start with an uppercase character (if it makes sense!)

This message is automatically generated by a bot.

@sheilamjones sheilamjones marked this pull request as draft January 28, 2025 11:46
@sheilamjones sheilamjones marked this pull request as ready for review February 5, 2025 10:21
@sheilamjones sheilamjones requested a review from iocanel February 5, 2025 10:21
@sheilamjones sheilamjones changed the title [DOCS]: Create procedure for Deploying on OpenShift using Docker build strategy Docs: Create procedure for Deploying on OpenShift using Docker build strategy Feb 5, 2025

This comment has been minimized.

Copy link

github-actions bot commented Feb 5, 2025

🎊 PR Preview 7ff0fcf has been successfully built and deployed to https://quarkus-pr-main-45918-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
Copy link
Contributor Author

Hi @iocanel,
Can I please get your review of this procedure. Again, this content is based on the existing downstream Deploying on Openshift guide.
Many thanks,
Sheila

@sheilamjones sheilamjones requested a review from rolfedh February 6, 2025 12:10
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 changed some items to bullet points to better reflect that they are a collection of independent options rather than a sequence of steps. Additionally, to make it clearer that these options are optional, I replaced the imperative verb form with the infinitive "To ..." form. Feel free to apply this approach to any other PRs that include similar lists of optional steps.

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.

Hi Sheila,

Great work! With your agreement, I’ve taken the opportunity to provide a more thorough review. I hope you find it helpful. Feel free to apply or disregard any suggestions as you see fit.
Thanks!

Comment on lines 93 to 94
. To retrieve the log output for your application's pod, use the `oc logs -f` command with the `<pod_name>` value of the pod you are interested in.
In this example, we use the `openshift-helloworld-1-gzzrx` pod name that corresponds with the latest pod prefixed with the name of your application:
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
. To retrieve the log output for your application's pod, use the `oc logs -f` command with the `<pod_name>` value of the pod you are interested in.
In this example, we use the `openshift-helloworld-1-gzzrx` pod name that corresponds with the latest pod prefixed with the name of your application:
. To get the log output for your application's pod, use the `oc logs -f` command with its name. For example:

oc logs -f _openshift-helloworld-1-gzzrx_
----
+
[source,shell,subs=attributes+]
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
[source,shell,subs=attributes+]
.Example output
[source,shell,subs=attributes+]

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm unsure whether we want to label outputs, but if we do, we should aim to apply it consistently across all upstream-downstream documentation. Something to think about for the future.

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 point and +1. I think it looks better to have the label, but for consistency reasons, I might leave this as it is for now and look to deciding whether or not to apply it in the future across the other guides.

+
[NOTE]
====
Be aware that the route is now listening on port 80 and no longer at port 8080.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd double-check with the SME correctness of the current statement. Is the route is listening on port 80 in addition to port 8080? If so, maybe:

Suggested change
Be aware that the route is now listening on port 80 and no longer at port 8080.
Be aware that the route is now listening on port 80.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@iocanel, perhaps you could advise here?

This comment has been minimized.

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

As an application developer, you can deploy your applications to {openshift} by using the Docker build strategy as a deployment option.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add a quick explanation on what the docker build strategy is.

I think that we need to let them know that its actually a docker build taking place inside openshift using the artifact that was build locally. In other words a more customizable version of the binary build that is the default option.

Copy link

quarkus-bot bot commented Feb 11, 2025

Status for workflow Quarkus Documentation CI

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

✅ 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