-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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(ansible): add readme with manual artifacts downloading explanation #3850
docs(ansible): add readme with manual artifacts downloading explanation #3850
Conversation
Signed-off-by: Alexey Panferov <lexavtanke@gmail.com>
Signed-off-by: Alexey Panferov <lexavtanke@gmail.com>
…ble-role' into add-readme-to-artifacts-ansible-role
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lexavtanke LGTM. What do you think of also providing a SHA256SUMS
file so that the downloaded files can be tested against their checksums?
@esteve Yes, make sense. I will switch it to draft for now and update. |
Signed-off-by: Alexey Panferov <lexavtanke@gmail.com>
@lexavtanke sorry I wasn't more specific. I meant adding a checksum file like this: https://help.ubuntu.com/community/HowToSHA256SUM so that users can check the files easily by running |
@esteve before I had started I also had this Idea because I wasn't sure. But I come to a conclusion that it will work for the first time and if user will update models manually one by one and will keep engines in the folders and run chechsum it can be confusing. After initial run of autoware user will have some additional files like trt engines. Do you think it will be better to push user to update all artifacts simultaneously? If so we will need to add a new playbook to ansible and modify setup-dev-env.sh or provide separate script for updating. |
@lexavtanke I think it's fine if the models change because the user modifies them, but the first time they are downloaded it'd be useful for the user if they can verify the files easily (with
I'm going to use it to update the ansible scripts so that all the files have a SHA256 sum (right now, some still a have an MD5 one) |
Signed-off-by: Alexey Panferov <lexavtanke@gmail.com>
Signed-off-by: Alexey Panferov <lexavtanke@gmail.com>
…ble-role' into add-readme-to-artifacts-ansible-role
@esteve I've added SHA256SUM to README. |
@lexavtanke I see, I meant a separate file, so that users can run |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The SHA256SUMS
file can live in the same folder as the README
, users can either download it so that it's in ~/autoware_data/SHA256SUMS
or we can tell them to issue the following command:
$ cd ~/autoware_data/
$ wget -q -O - https://raw.githubusercontent.com/autowarefoundation/autoware/main/ansible/roles/artifacts/SHA256SUMS | sha256sum -c
Signed-off-by: Alexey Panferov <lexavtanke@gmail.com>
…ble-role' into add-readme-to-artifacts-ansible-role
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lexavtanke thank you so much for addressing my feedback 🙂
Description
add README to ansible role artifacts. It provide instruction how to download package artifacts manually. Also link to this README will be used in documentation on pages:
See autowarefoundation/autoware.universe#3137
Tests performed
Not applicable.
Effects on system behavior
Not applicable.
Pre-review checklist for the PR author
The PR author must check the checkboxes below when creating the PR.
In-review checklist for the PR reviewers
The PR reviewers must check the checkboxes below before approval.
Post-review checklist for the PR author
The PR author must check the checkboxes below before merging.
After all checkboxes are checked, anyone who has write access can merge the PR.