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.

Sign up for GitHub

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(usage): add an example on how to retrieve container images #141

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(usage): add an example on how to retrieve container images #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AUTHORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ The list of contributors in alphabetical order:

- [Adam Novorolnik](https://github.com/ANovorolnik)
- [Alex Mieth](https://github.com/AlexMieth)
- [Dana Alsharif](https://github.com/danaalsharif)
- [Daniel Prelipcean](https://orcid.org/0000-0002-4855-194X)
- [Jan Okraska](https://orcid.org/0000-0002-1416-3244)
- [Jiri Kuncar](https://github.com/jirikuncar)
- [Joud Masoud](https://github.com/joudmas)
- [Mohammad Doleh](https://github.com/d0leh)
Copy link
Member

Choose a reason for hiding this comment

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

I have added Dana and you to the AUTHORS file.

- [Parth Shandilya](https://github.com/ParthS007)
- [Tibor Simko](https://orcid.org/0000-0001-7202-5803)
12 changes: 12 additions & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,18 @@ $ cernopendata-client get-metadata --recid 329 --output-value authors.name --fil
Rousseau, David
```

Another example of using \--filter would be retrieving the container image
Copy link
Member

Choose a reason for hiding this comment

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

Thanks, ported to Markdown that we switched to in the meantime.

Copy link
Member

Choose a reason for hiding this comment

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

FWIW the CI tests are not passing due to a known issue that is being addressed in #147.

details. For instance, to get the container images registered in Docker Hub
repository for a specific open data record, you can use:

``` console
$ cernopendata-client get-metadata --recid 22234 --output-value system_details.container_images.name
docker.io/cmsopendata/cmssw_7_6_7-slc6_amd64_gcc493:latest
gitlab-registry.cern.ch/cms-cloud/cmssw-docker-opendata/cmssw_7_6_7-slc6_amd64_gcc493:latest
$ cernopendata-client get-metadata --recid 22234 --output-value system_details.container_images.name --filter registry=dockerhub
docker.io/cmsopendata/cmssw_7_6_7-slc6_amd64_gcc493:latest
```

## Listing available data files

In order to get a list of data files belonging to a record, please use
Expand Down
Loading