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: indexing locally and running tests #41

Merged
merged 2 commits into from
Dec 30, 2024
Merged

Conversation

rabi-siddique
Copy link
Collaborator

The PR updates the README. Mainly the sections related to running the indexer locally and how tests work in this repo.

README.md Outdated
Comment on lines 140 to 143
docker logs <container_id>
```

Replace <container_id> with the actual ID of your Docker container involved in indexing.

Choose a reason for hiding this comment

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

Can we instead name the container which we are talking about? I think it is hardcoded explicitly in docker compose.

Choose a reason for hiding this comment

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

May be we can add the command here to get container Id from container name:

docker inspect --format="{{.Id}}" container_name

And I think container name is subquery-node in our case?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Let me verify locally and then update

Copy link
Collaborator Author

@rabi-siddique rabi-siddique Dec 24, 2024

Choose a reason for hiding this comment

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

We can mention the container name as you suggested:
image

It is agoric-subql-subquery-node-1. Still a little confused why it's prefixing it with the repo name

Comment on lines +114 to +119
1. Start up an A3P instance

```sh
docker run -p 26657:26657 -p 1317:1317 -p 9090:9090 ghcr.io/agoric/agoric-3-proposals:latest
```
```sh
docker run -p 26657:26657 -p 1317:1317 -p 9090:9090 ghcr.io/agoric/agoric-3-proposals:latest
```

Choose a reason for hiding this comment

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

Why this step?
I see we have a3p as a separate service in docker compose and yarn dev should also spawn it.

Screenshot 2024-12-24 at 7 15 35 PM

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This configuration is specifically for the ci profile within the a3p container. The reason for using the ci profile is because the URL http://host.docker.internal:26657 is not accessible in CI environments. Therefore, I included the a3p service in the Docker Compose file and assigned it a ci profile to ensure it only runs in CI. In the CI environment, we then use the address http://agd:26657.

Copy link
Member

Choose a reason for hiding this comment

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

I was wondering why ci was necessary. Your comment here is helpful. Please include it somewhere in the README or source code.

@rabi-siddique rabi-siddique force-pushed the rs-update-docs branch 3 times, most recently from e887e78 to 195a448 Compare December 26, 2024 05:20
- Check the logs of indexer for any errors or warnings that might indicate what is wrong. Use the command:

```sh
docker logs -f agoric-subql-subquery-node-1

Choose a reason for hiding this comment

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

Does this container name remain consistent on each compse up?

Choose a reason for hiding this comment

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

Was just curious about the repo name prefix and *-1 postfix

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, the name remains consistent. Same locally as well as CI.

@rabi-siddique rabi-siddique merged commit 1bcf6b8 into main Dec 30, 2024
3 checks passed
@rabi-siddique rabi-siddique deleted the rs-update-docs branch December 30, 2024 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants