Refactor getting started guide to use the sample spring-petclinic #1085

pmacik · 2021-12-22T13:48:55Z

Motivation

Current quick start uses only REST API server part of the Spring Petclinic as an application and Crunchy Postgresql Operator backed DB. It has couple of UX issues.

The current application:

does not have UI so user must use kubectl port-forward and curl command to send requests to the application's API server and analyze responses for accessing and verifying that the application works as expected
user has to manually run a script to initialize database with application schema and data (as one of the quickstart's steps)

The current database:

requires installation of Crunchy Postgresql Operator (via OLM) that wouldn't be possible for user with kubernetes cluster without OLM
uses an operator that is not available on other then x86_64 architectures, which excludes all users on alternative architectures

Changes

This PR:

Changes the quickstart's database to be a Deployment of multi-arch postgres image
Changes the quickstart's application to be a Deployment of multi-arch image of Spring Petclinic including UI
Introduces the operator-backed database scenario as an alternative scenario for users with OLM
Extract pieces of the quickstart as re-usable parts and reuses them in both scenarios
Includes content of various source files directly in the docs to keep the docs in sync

Testing

Docs

Run make site to generate a preview and open out/site/userguide/getting-started/quick-start.html

Scenarios

Run included acceptance tests (tagged @getting-started).

openshift-ci · 2021-12-22T13:50:32Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

codecov · 2021-12-22T13:53:24Z

Codecov Report

Merging #1085 (82bdc83) into master (a796243) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1085   +/-   ##
=======================================
  Coverage   58.92%   58.92%           
=======================================
  Files          30       30           
  Lines        1670     1670           
=======================================
  Hits          984      984           
  Misses        560      560           
  Partials      126      126

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a796243...82bdc83. Read the comment docs.

pmacik · 2022-01-12T16:43:24Z

Rebased for fixed 4.10 acceptance tests (#1090)

docs/userguide/antora.yml

docs/userguide/modules/exposing-binding-data/pages/supported-operators.adoc

docs/userguide/modules/getting-started/pages/petclinic-pgcluster.adoc

docs/userguide/modules/getting-started/partials/connect-petclinic-postgresql.adoc

docs/userguide/modules/getting-started/partials/deploy-db-pgcluster.adoc

samples/apps/spring-petclinic/Dockerfile.app

samples/apps/spring-petclinic/db.annotations

samples/apps/spring-petclinic/patch/pom.xml.patch

pedjak · 2022-01-13T10:37:51Z

@Srivaralakshmi can you take a look as well?

pedjak · 2022-01-13T10:39:18Z

Also, please update the PR description and update Motivation part (current contains the placeholder text)

docs/userguide/modules/getting-started/pages/quick-start.adoc

docs/userguide/modules/getting-started/pages/petclinic-pgcluster.adoc

docs/userguide/modules/getting-started/partials/connect-petclinic-pgcluster.adoc

Srivaralakshmi · 2022-01-13T11:34:19Z

Hi, @pmacik: I have only reviewed 50% of the content. I am stopping now, as there are multiple files with the same content (for pgcluster and PostgreSQL). It is becoming very confusing for me to review as there is no preview. So stopping for now. Hope we can meet sometime today and discuss.

pmacik · 2022-01-27T05:23:56Z

Rebased on latest master

pmacik · 2022-01-27T05:43:01Z

/retest

pmacik · 2022-01-27T07:18:59Z

/retest

Srivaralakshmi

Hi, @pmacik: Nice work. Thanks for incorporating the comments. I have left some minor suggestions. Otherwise, LGTM. Thanks!

docs/userguide/modules/getting-started/pages/petclinic-pgcluster.adoc

docs/userguide/modules/getting-started/partials/common-prerequisities.adoc

docs/userguide/modules/getting-started/partials/connecting-petclinic-db.adoc

docs/userguide/modules/getting-started/partials/petclinic-db.adoc

docs/userguide/modules/getting-started/partials/creating-db-pgcluster.adoc

docs/userguide/modules/getting-started/partials/creating-db-postgresql.adoc

docs/userguide/modules/getting-started/partials/deploying-application.adoc

docs/userguide/modules/getting-started/partials/intro.adoc

pmacik · 2022-01-27T09:53:39Z

/retest

pmacik · 2022-01-27T14:37:37Z

@Srivaralakshmi I've addressed all the review comments. Thank you for all your feedback!

Srivaralakshmi

Thanks, @pmacik for your patience and time, LGTM :)

Srivaralakshmi · 2022-01-31T07:30:58Z

/lgtm

openshift-ci · 2022-01-31T07:31:05Z

@Srivaralakshmi: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

pedjak · 2022-01-31T09:32:04Z

@pmacik IMHO this PR should contain also an acceptance tests verifying that documented quick start scenario works. This would enable catching regressions and mismatch between the doc and the user experience.

pmacik · 2022-02-01T06:37:11Z

That's the plan, I wanted to finalize the quickstart before the acceptance testing - working on it.

pmacik · 2022-02-01T18:13:08Z

Included acceptance tests to verify the quickstart scenarios

pmacik · 2022-02-01T18:26:06Z

/retest

application. Signed-off-by: Pavel Macík <[email protected]>

pmacik · 2022-02-01T20:50:57Z

/retest

baijum · 2022-02-03T05:09:38Z

docs/userguide/modules/getting-started/partials/creating-db-postgresql.adoc

+
+[IMPORTANT]
+====
+The `Deployment` resource of the database has a couple of annotations set in the `.metadata.annotations` section:


Suggested change

The `Deployment` resource of the database has a couple of annotations set in the `.metadata.annotations` section:

The `Deployment` resource of the database has few annotations set in the `.metadata.annotations` section:

It is actually: The Deployment resource of the database has a few annotations set in the .metadata.annotations section:

It is a minor comment. Considering that this is the only comment that is pending and I am also working on a PR for the upstream content, if it helps, I can make this change along with my work. But this will take some time as I am working on the QSG content for OCP docs. I hope that is ok. @pmacik I may need your help if I run into errors during acceptance tests.

baijum

/lgtm

baijum · 2022-02-04T13:03:51Z

/approve

openshift-ci · 2022-02-04T13:04:19Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: baijum

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [baijum]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci bot added the do-not-merge/work-in-progress label Dec 22, 2021

openshift-ci bot requested review from baijum and isutton December 22, 2021 13:52

pmacik mentioned this pull request Jan 10, 2022

Introduce sample application (spring-petclinic + postgresql) to be used in quickstart #1080

Merged

pmacik force-pushed the refactor-quickstart branch 7 times, most recently from f13fca7 to 664da34 Compare January 11, 2022 14:10

pmacik marked this pull request as ready for review January 11, 2022 14:10

pmacik changed the title ~~WIP: Refactor getting started guide to use the sample spring-petclinic~~ Refactor getting started guide to use the sample spring-petclinic Jan 11, 2022

openshift-ci bot removed the do-not-merge/work-in-progress label Jan 11, 2022

pmacik force-pushed the refactor-quickstart branch from 664da34 to b7e26c7 Compare January 12, 2022 16:42

pmacik force-pushed the refactor-quickstart branch 3 times, most recently from f27bcbe to 80f0520 Compare January 12, 2022 17:02

pedjak suggested changes Jan 13, 2022

View reviewed changes

pedjak removed the request for review from isutton January 13, 2022 10:37

pedjak requested a review from sadlerap January 13, 2022 10:38

Srivaralakshmi suggested changes Jan 13, 2022

View reviewed changes

pmacik force-pushed the refactor-quickstart branch 2 times, most recently from 0388d46 to d56e8b2 Compare January 13, 2022 13:44

Srivaralakshmi suggested changes Jan 27, 2022

View reviewed changes

pmacik force-pushed the refactor-quickstart branch from 0efff16 to 777add4 Compare January 27, 2022 14:36

Srivaralakshmi approved these changes Jan 31, 2022

View reviewed changes

pmacik force-pushed the refactor-quickstart branch 2 times, most recently from 4ca581b to 73e3aac Compare February 1, 2022 18:12

Refactor getting started guide to use the sample spring-petclinic

82bdc83

application. Signed-off-by: Pavel Macík <[email protected]>

pmacik force-pushed the refactor-quickstart branch from 73e3aac to 82bdc83 Compare February 1, 2022 18:49

baijum reviewed Feb 3, 2022

View reviewed changes

baijum approved these changes Feb 3, 2022

View reviewed changes

openshift-ci bot assigned baijum Feb 3, 2022

openshift-ci bot added the lgtm label Feb 3, 2022

openshift-ci bot added the approved label Feb 4, 2022

openshift-merge-robot merged commit e0859ea into redhat-developer:master Feb 4, 2022

pmacik linked an issue Feb 11, 2022 that may be closed by this pull request

Run Spring PetClinic Sample Application #805

Closed

pmacik mentioned this pull request Feb 11, 2022

Run Spring PetClinic Sample Application #805

Closed

pmacik deleted the refactor-quickstart branch May 11, 2022 10:58

	The `Deployment` resource of the database has a couple of annotations set in the `.metadata.annotations` section:
	The `Deployment` resource of the database has few annotations set in the `.metadata.annotations` section:

Refactor getting started guide to use the sample spring-petclinic #1085

Refactor getting started guide to use the sample spring-petclinic #1085

Uh oh!

Conversation

pmacik commented Dec 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes

Testing

Docs

Scenarios

Uh oh!

openshift-ci bot commented Dec 22, 2021

Uh oh!

codecov bot commented Dec 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pmacik commented Jan 12, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pedjak commented Jan 13, 2022

Uh oh!

pedjak commented Jan 13, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Srivaralakshmi commented Jan 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pmacik commented Jan 27, 2022

Uh oh!

pmacik commented Jan 27, 2022

Uh oh!

pmacik commented Jan 27, 2022

Uh oh!

Srivaralakshmi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmacik commented Jan 27, 2022

Uh oh!

pmacik commented Jan 27, 2022

Uh oh!

Srivaralakshmi left a comment

Choose a reason for hiding this comment

Uh oh!

Srivaralakshmi commented Jan 31, 2022

Uh oh!

openshift-ci bot commented Jan 31, 2022

Uh oh!

pedjak commented Jan 31, 2022

Uh oh!

pmacik commented Feb 1, 2022

pmacik commented Dec 22, 2021 •

edited

Loading

codecov bot commented Dec 22, 2021 •

edited

Loading

Srivaralakshmi commented Jan 13, 2022 •

edited

Loading

Srivaralakshmi Feb 3, 2022 •

edited

Loading