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

[Feature Request]: Add support for running DSAdmin with Docker setup #20304

Open
AFZL210 opened this issue May 13, 2024 · 2 comments · May be fixed by #20368
Open

[Feature Request]: Add support for running DSAdmin with Docker setup #20304

AFZL210 opened this issue May 13, 2024 · 2 comments · May be fixed by #20368
Assignees
Labels
docker Label to indicate an discussion is docker related. enhancement Label to indicate an issue is a feature/improvement Work: Medium The means to find the solution is clear, but it isn't at good-first-issue level yet.

Comments

@AFZL210
Copy link
Member

AFZL210 commented May 13, 2024

Is your feature request related to a problem? Please describe.

DSAdmin provides a UI for viewing Google Cloud Datastore Emulator data when running the dev server. This is really useful, as we can quickly check whether data is updated or not. Currently, we can use DSAdmin with python setup easily, but with Docker we don't have a command that sets up all the necessary things for us.

Describe the solution (or solutions) you'd like

Add support for running DSAdmin with a Docker setup, just like we have other easy to use commands for running tests, viewing logs etc.

Describe alternatives you've considered and rejected

N/A

Additional context

Learn more about DSAdmin: https://github.com/oppia/oppia/wiki/Debugging-datastore-locally

@AFZL210 AFZL210 added triage needed enhancement Label to indicate an issue is a feature/improvement Work: Medium The means to find the solution is clear, but it isn't at good-first-issue level yet. docker Label to indicate an discussion is docker related. and removed triage needed labels May 13, 2024
@gp201 gp201 self-assigned this May 28, 2024
@gp201 gp201 linked a pull request May 28, 2024 that will close this issue
7 tasks
@gp201
Copy link
Member

gp201 commented May 28, 2024

Follow the steps below to run DSadmin

  1. Delete the existing oppia-cloud-datastore container.
  2. add
ports:
      - "8080:8080"

below the line

oppia/docker-compose.yml

Lines 84 to 88 in 6345bf8

datastore:
build:
context: .
dockerfile: ./docker/Dockerfile.backend
container_name: oppia-cloud-datastore

3. Run make run-devserver
5. Run make shell.oppia-cloud-datastore, a terminal session within the docker container (oppia-cloud-datastore) should spawn.
6. Run cd ..
7. Download an archive for linux-amd64 from the DSAdmin releases GitHub page using wget. example (wget https://github.com/remko/dsadmin/releases/download/v0.20.0/dsadmin-v0.20.0-linux-amd64.tar.gz)
8. unzip the file using tar -xvf <tar_file>
9. Run ../dsadmin --project=dev-project-id --datastore-emulator-host=localhost:8089
10. open http://localhost:8080/ in a browser.

@gp201
Copy link
Member

gp201 commented May 28, 2024

@AFZL210, can you confirm whether this fixes your issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker Label to indicate an discussion is docker related. enhancement Label to indicate an issue is a feature/improvement Work: Medium The means to find the solution is clear, but it isn't at good-first-issue level yet.
Projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

2 participants