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

update documentation for arm images builder #8462

Merged
merged 3 commits into from
Dec 12, 2019

Conversation

mkaczanowski
Copy link
Contributor

This is a proposal to replace the solo-io repo with a plugin that I wrote recently.

Why not contributing to solo-io plugin?

A few reasons:

  • there is a lot of copy pastes in the repo with the intent of re-usability (ex. ISO module for handling base image). This creates some level of confusion and combined with another portion of copy-pastes over the codebase makes the code to be harder to understand than it really is.
  • functionality limitations - it seems the plugin was written to support the model where a base image (".iso") exists and it's being reused. Also there are assumptions made to how the partition layout looks like (this varies a lot across boards etc)
  • it seems the only system supported is ~ubuntu/debian for raspberry pi
  • the documentation is there but it's unclear in some places (like how flasher is supposed to work etc)
  • the code doesn't build with trunk (behind packer v4 iirc)

How is the mkaczanowski/packer-builder-arm better?

At first it tackles mentioned above issues. It's pretty extendable and works for variety of ARM boards with different OS'es etc.

So far I tested it with:

  • raspberry pi
  • parallella board
  • odroid xu4 + odroid u3
  • wandboard quad
  • beaglebone black
  • nvidia jetson

with ubuntu, rasbpian and archlinux. Each board has a bit different settings, like start sector or flashing process, so as you can see the flexibility is the key.

Request for doc update

Just to be clear, I think the solo-io plugins is pretty good, however I think because of the limitations and issues I mentioned above, it's reasonable to update documentation and let people know there is something imho better.

@mkaczanowski mkaczanowski requested a review from a team as a code owner December 7, 2019 10:07
@hashicorp-cla
Copy link

hashicorp-cla commented Dec 7, 2019

CLA assistant check
All committers have signed the CLA.

@azr
Copy link
Contributor

azr commented Dec 9, 2019

Hello @mkaczanowski and thanks for opening !

Would it be a good idea to leave the two on the page but sort of give a short description of their perks ? So that the user can pick the one that is the best for their use case ?

@mkaczanowski
Copy link
Contributor Author

@azr sounds good to me. Let me update the commit

@mkaczanowski
Copy link
Contributor Author

@azr updated commit with short description. Please let me know if you feel that is sufficient

Copy link
Contributor

@azr azr left a comment

Choose a reason for hiding this comment

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

Hey @mkaczanowski, great ! I think we could update the first link so that there's not an empty link. other than that LGTM !

Copy link
Contributor

@azr azr left a comment

Choose a reason for hiding this comment

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

LGTM, if @SwampDragons agrees I think we can merge this one 👍🙂. Thanks @mkaczanowski.

@SwampDragons
Copy link
Contributor

Looks great to me. Thanks for adding your work to our documentation!

@SwampDragons SwampDragons merged commit fbd1958 into hashicorp:master Dec 12, 2019
@SwampDragons SwampDragons added this to the 1.5.0 milestone Dec 18, 2019
@ghost
Copy link

ghost commented Jan 23, 2020

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@ghost ghost locked and limited conversation to collaborators Jan 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants