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

FIX - updated readme file to provide a functioning demo setup #3777

Merged
merged 1 commit into from
May 23, 2023

Conversation

Agnul97
Copy link
Contributor

@Agnul97 Agnul97 commented May 15, 2023

The docker-compose deployment file, in the absence of local docker images, tries to pull the consumers from the docker hub which are, for now, not present in the Kapua docker repo. This means that deploying Kapua following the "demo setup" section of the main project readme file is actually not possible.

In order to provide a functioning demo setup, I changed the instructions provided for that section, explaining that it is possible to exploit the hub in order to deploy tagged released versions but not for snapshot versions (for example, the actual development branch with the consumers), which require a local build.
Furthermore, I updated the building section of the documentation, because I found some improvements there. I attached this update in this PR because the "quick demo" section actually depends on that document.

@codecov
Copy link

codecov bot commented May 15, 2023

Codecov Report

Merging #3777 (dd8bc69) into develop (fd877d7) will increase coverage by 3.00%.
The diff coverage is 32.50%.

❗ Current head dd8bc69 differs from pull request most recent head f10519b. Consider uploading reports for the commit f10519b to get more accurate results

Impacted file tree graph

@@              Coverage Diff              @@
##             develop    #3777      +/-   ##
=============================================
+ Coverage      49.19%   52.19%   +3.00%     
  Complexity        26       26              
=============================================
  Files           1865     1866       +1     
  Lines          35275    35284       +9     
  Branches        2786     2782       -4     
=============================================
+ Hits           17352    18416    +1064     
+ Misses         17003    15895    -1108     
- Partials         920      973      +53     
Impacted Files Coverage Δ
...pse/kapua/job/engine/commons/logger/JobLogger.java 0.00% <0.00%> (ø)
...resources/v1/resources/UserCredentialFiltered.java 0.00% <0.00%> (ø)
...ice/endpoint/internal/EndpointInfoServiceImpl.java 82.25% <86.66%> (+1.96%) ⬆️

... and 137 files with indirect coverage changes

@Coduz Coduz added Bug This is a bug or an unexpected behaviour. Fix it! Documentation Doc... What?? Joke! We will write some! labels May 17, 2023
Copy link
Contributor

@Coduz Coduz left a comment

Choose a reason for hiding this comment

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

After further review also of the linked issue I think that this solution won't work.
Checking out release-1.7.x would have the same problem, since snapshot images are not hosted in Docker HUB.

The best solution would be to specify that only released version have Docker Images hosted in Docker HUB. For develop version we need to specify that the user needs to build the images locally if he wants to run a demo on develop. Otherwise it needs to checkout a tagged release.

@Agnul97 Agnul97 force-pushed the fix-updatedQuickStartGuide branch from 0f0e9f1 to 8d51e9d Compare May 22, 2023 09:38
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Agnul97 Agnul97 force-pushed the fix-updatedQuickStartGuide branch from 8d51e9d to 7ec91b6 Compare May 22, 2023 13:15
@Agnul97 Agnul97 force-pushed the fix-updatedQuickStartGuide branch from 7ec91b6 to f10519b Compare May 22, 2023 13:39
@Coduz Coduz merged commit 805094a into eclipse:develop May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug This is a bug or an unexpected behaviour. Fix it! Documentation Doc... What?? Joke! We will write some!
Projects
Development

Successfully merging this pull request may close these issues.

2 participants