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

docs: additional details around bootc images, install #195

Merged
merged 2 commits into from
Nov 10, 2023

Conversation

miabbott
Copy link
Contributor

I tried to add some clarifying details/context around the how to build "bootc compatible" images and how they are installed.

Generally spruced up the Markdown syntax and cleaned up some spelling/grammar nits.

This replaces #189

Copy link

openshift-ci bot commented Nov 10, 2023

Hi @miabbott. Thanks for your PR.

I'm waiting for a containers member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

This adds more verbose details about composing base images and makes
some Markdown syntax improvements.

Signed-off-by: Micah Abbott <miabbott@redhat.com>
Copy link
Collaborator

@cgwalters cgwalters left a comment

Choose a reason for hiding this comment

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

Overall looks sane after conflicts are fixed

docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
@miabbott miabbott force-pushed the newbie2_eb branch 2 times, most recently from 54afd13 to 30c18cf Compare November 10, 2023 21:01
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated
<image> \
bootc install-to-filesystem --replace=alongside /target
```bash
$ podman run --privileged -v /:/target \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Lost --rm in merge resolution

@miabbott
Copy link
Contributor Author

While the patient is open, what do you think of reflowing these lines of text to not be separated by new lines? The side effect being that changes to content should be easier to visualize rather than the multiple changed lines?

@cgwalters
Copy link
Collaborator

While the patient is open, what do you think of reflowing these lines of text to not be separated by new lines?

No strong opinion honestly

@cgwalters
Copy link
Collaborator

/ok-to-test

I added some additional details around the install process and did
Markdown cleanups, spelling corrections, grammar fixes, etc.

Signed-off-by: Micah Abbott <miabbott@redhat.com>
@cgwalters cgwalters merged commit 04d0d7e into containers:main Nov 10, 2023
9 checks passed
@miabbott miabbott deleted the newbie2_eb branch November 11, 2023 14:19

Here's an example:
Here's an example of using `bootc install` (root/elevated permission required):
Copy link
Member

@vrothberg vrothberg Nov 13, 2023

Choose a reason for hiding this comment

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

It would be great to have copy-paste examples in the docs. I have encountered a number of issues trying to bootc-install in a pet VM.
"Boot this image, then do ..., then do a podman-run ...bootc install ...".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants