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

[Doc][Module Name] Install via Docker Compose #8258

Open
155martinmoreno opened this issue Jan 8, 2025 · 9 comments
Open

[Doc][Module Name] Install via Docker Compose #8258

155martinmoreno opened this issue Jan 8, 2025 · 9 comments
Labels
component/docs This issue or PR relates to a document type/docs This issue is to add or improve documentation

Comments

@155martinmoreno
Copy link

Documentation Scope

Install via Docker Compose

Describe the Change

You should add the location of the dockerfile and env files mentioned in the doc
(In this case devops/releases/lake-v0.21.0/)

Additional context

It isn't easy to find otherwise

@155martinmoreno 155martinmoreno added the type/docs This issue is to add or improve documentation label Jan 8, 2025
@dosubot dosubot bot added the component/docs This issue or PR relates to a document label Jan 8, 2025
@klesh
Copy link
Contributor

klesh commented Jan 14, 2025

Can you elaborate? Which document and section are you referring to?

@155martinmoreno
Copy link
Author

Sorry, I meant the docs found here

@klesh
Copy link
Contributor

klesh commented Jan 26, 2025

I see.
The doc you were referring to has a link to the releases page which provides files mentioned :

Image

Image

@155martinmoreno
Copy link
Author

155martinmoreno commented Jan 30, 2025

Well, I've followed the Getting Started process again to double-check.

The Docker compose on the Release is different from the one in the devops/releases/lake-v0.21.0/ folder (seems to be the latest, but I'm probably wrong)

  • docker-compose.yml (release) points to Grafana devlake.docker.scarf.sh/apache/devlake-dashboard:1.0.1 and yelds manifest unknown error.
  • docker-compose.yml (in folder) points to Grafana devlake.docker.scarf.sh/apache/devlake-dashboard:v0.21.0 and works

Either the docker-compose is wrong or the doc is missing some step about signing in to a registry.

A related issue points to using latest for all images on the docker-compose, and although it works, I'm not sure it's the right call in this context

@klesh
Copy link
Contributor

klesh commented Feb 6, 2025

@155martinmoreno I see. Please use the one from the release page as shown in the screenshot I posted.
The latest release should be v1.0.2-beta5

@155martinmoreno
Copy link
Author

Thanks for the answer, but I think I'm not being clear.

If I use the one pointed out in the screenshot, it fails with a manifest unknown error (see my previous answer).

I can fix it by changing it to latest, but you should mention this in the docs for other newcomers.

@klesh
Copy link
Contributor

klesh commented Feb 7, 2025

@155martinmoreno I just double checked the one from my screenshot, it is pointing to v1.0.2-beta5.

Image

So, I don't understand why you were seeing 1.0.1

@155martinmoreno
Copy link
Author

Ah, I see now.

The reason is that I'm pulling the Latest release, instead of Beta5

Image

Do you think it's ok for Latest (1.0.1) to give manifest error? should we always point to the latest beta? does this deserve a comment in the Getting Started doc?

If not, I'll go ahead and close this thread.

Thanks for the follow-up!

@klesh
Copy link
Contributor

klesh commented Feb 12, 2025

I see... Thanks for the explanation.
I just updated the docker-compose.yml for the release 1.0.1, it should be working now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/docs This issue or PR relates to a document type/docs This issue is to add or improve documentation
Projects
None yet
Development

No branches or pull requests

2 participants