Page MenuHomeSoftware Heritage

README: update loading instructions (now using celery task)
ClosedPublic

Authored by haltode on Mar 14 2019, 8:29 AM.

Details

Summary

Update outdated tar loading documentation (changed in 379a7a4b65f1).

Diff Detail

Repository
rDLDTAR Tarball Loader
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

haltode created this revision.Mar 14 2019, 8:29 AM
ardumont added inline comments.
README.md
41

That's no longer the right way to do it (while it technically still works ;)

That must go within the same configuration as the loader's configuration (under the celery key):

I'd rework the documentation's as:

## Configuration

This is the loader's (or task's) configuration file.
It holds information for the loader to work (including celery configuration).

This file is detected by the celery worker by checking the
SWH_CONFIG_FILENAME environment variable.

Here is a sample:

```YAML
working_dir: /home/storage/tmp/
storage:
  cls: remote
  args:
    url: http://localhost:5002/
celery:
task_modules:
    - swh.loader.tar.tasks
task_queues:
    - swh_loader_tar                          # <- deprecated queue name
    - swh.loader.tar.tasks.LoadTarRepository  # <- use this

Can you please adapt accordingly?

Note: the sentence phrasing is not that good, so feel free to improve ;)

Cheers,

ardumont requested changes to this revision.Mar 14 2019, 11:22 AM

Thanks for this!

That documents a deprecated behavior though, can you please readapt according to my remark?

This revision now requires changes to proceed.Mar 14 2019, 11:22 AM
haltode updated this revision to Diff 3924.Mar 14 2019, 3:00 PM

Rework outdated configuration file sample.

ardumont accepted this revision.Mar 14 2019, 3:17 PM

Thanks

This revision is now accepted and ready to land.Mar 14 2019, 3:17 PM
haltode updated this revision to Diff 3927.Mar 14 2019, 3:26 PM
haltode marked an inline comment as done.

Update commit message.

This revision was automatically updated to reflect the committed changes.