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

feat(source-installation): recommend installation via Ansible over manual installation #369

Merged

Conversation

yukkysaito
Copy link
Contributor

@yukkysaito yukkysaito commented May 13, 2023

Description

I see many people on social media doing manual installations instead of automated environment setups using Ansible.

Manual installation is difficult and many people fail.
Therefore, I have changed to recommend automatic environment setup using Ansible.

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 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.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

Signed-off-by: Yukihito Saito <yukky.saito@gmail.com>
@yukkysaito yukkysaito added type:documentation Creating or refining documentation. tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) labels May 13, 2023
yukkysaito and others added 3 commits May 13, 2023 11:31
Signed-off-by: Yukihito Saito <yukky.saito@gmail.com>
Signed-off-by: Yukihito Saito <yukky.saito@gmail.com>
Copy link
Contributor

@kenji-miyake kenji-miyake left a comment

Choose a reason for hiding this comment

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

I think it's okay, but since the current recommendation of manual installation was strongly pushed by @xmfcx and @esteve, I cannot judge it. I'll leave it to them.

docs/installation/autoware/source-installation.md Outdated Show resolved Hide resolved
Signed-off-by: Yukihito Saito <yukky.saito@gmail.com>
@yukkysaito yukkysaito changed the title docs: update source installation feat(source-installation): recommend installation via Ansible over manual installation May 13, 2023
Copy link
Member

@mitsudome-r mitsudome-r left a comment

Choose a reason for hiding this comment

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

If not using ansible is causing installation issue, then I don't mind making them a default installation step.
However, I believe one of the issue with ansible was that it might corrupt the users environment if they already have NVIDIA related libraries. I made some suggestions to make it obvious that users with NVIDIA libraries installed should be careful using the ansible script.

docs/installation/autoware/source-installation.md Outdated Show resolved Hide resolved
docs/installation/autoware/source-installation.md Outdated Show resolved Hide resolved
yukkysaito and others added 2 commits May 15, 2023 11:29
Co-authored-by: Ryohsuke Mitsudome <43976834+mitsudome-r@users.noreply.github.com>
Co-authored-by: Ryohsuke Mitsudome <43976834+mitsudome-r@users.noreply.github.com>
@yukkysaito
Copy link
Contributor Author

@xmfcx @esteve Any opinions would be appreciated. 🙏

Signed-off-by: Yukihito Saito <yukky.saito@gmail.com>
Copy link
Contributor

@xmfcx xmfcx left a comment

Choose a reason for hiding this comment

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

I'd still prefer to keep manual installation steps under a separate heading instead of a Note section.

But I leave the decision to you @yukkysaito . But I am sure some people will complain that Ansible method has made unwanted changes on their system, time will tell.

I've made some rephrasing of some sentences along the way. After you review them, I think we can merge this.

docs/installation/autoware/source-installation.md Outdated Show resolved Hide resolved
docs/installation/autoware/source-installation.md Outdated Show resolved Hide resolved
docs/installation/autoware/source-installation.md Outdated Show resolved Hide resolved
docs/installation/autoware/source-installation.md Outdated Show resolved Hide resolved
yukkysaito and others added 4 commits May 15, 2023 23:07
Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>
Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>
Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>
Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>
@yukkysaito
Copy link
Contributor Author

yukkysaito commented May 15, 2023

@xmfcx
Thank you for your advice. 👍

I'd still prefer to keep manual installation steps under a separate heading instead of a Note section.

Do you mean to create a manual installation page in troubleshooting or somewhere else?
If you give us more details, I may be able to do ti.

But I leave the decision to you @yukkysaito . But I am sure some people will complain that Ansible method has made unwanted changes on their system, time will tell.

In japan, many people say installing Autoware is too difficult. also, installing Autoware is called "Autoware challenge".
I am afraid that if this situation continues, the number of people who use Autoware will decrease.
Therefore, I wanted to recommend ansible to simplify the procedure.
However, you are right that it may cause more trouble by using ansible.
Regarding that, I would like to improve troubleshooting, etc. in the future.

I've made some rephrasing of some sentences along the way. After you review them, I think we can merge this.

Thank you very much. I committed the fix.

@xmfcx xmfcx merged commit b771f87 into autowarefoundation:main May 15, 2023
@esteve
Copy link
Contributor

esteve commented May 18, 2023

@kenji-miyake @xmfcx @yukkysaito Sorry, didn't see this before. I still prefer the manual installation and I think it's not good for users to have their environment changed via a script without their control (see for example installing rocker via sudo pip vs sudo apt-get).

However the work done in autowarefoundation/autoware#3222 should largely make some of the Ansible steps obsolete, since users will be able to install Autoware directly from Debian packages (see https://github.com/esteve/autoware_packages/tree/jammy-humble for an APT repository that users can already use to install Autoware).

In any case, as long as the manual instructions are kept and that the Ansible scripts do not modify a user's environment without their consent, I'm fine.

alanmengg pushed a commit to alanmengg/autoware-documentation that referenced this pull request Aug 2, 2023
…nual installation (autowarefoundation#369)

Signed-off-by: Yukihito Saito <yukky.saito@gmail.com>
Co-authored-by: Ryohsuke Mitsudome <43976834+mitsudome-r@users.noreply.github.com>
Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>
Signed-off-by: guiping meng <alan.meng@autocore.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) type:documentation Creating or refining documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants