docs: add rosetta documentation information #8789
Conversation
cdrage
requested review from
shipsing,
slemeur,
benoitf and
a team
as code owners
cdrage
requested review from
dgolovin,
axel7083 and
SoniaSandler
and removed request for
a team
### What does this PR do? * Adds information regarding how rosetta is used for creating machines on macOS * Also adds a minor title change to WSL doc that is only Windows relevant. ### Screenshot / video of UI <!-- If this PR is changing UI, please include screenshots or screencasts showing the difference --> N/A ### What issues does this PR fix or reference? <!-- Include any related issues from Podman Desktop repository (or from another issue tracker). --> Closes containers#7777 ### How to test this PR? <!-- Please explain steps to verify the functionality, do not forget to provide unit/component tests --> - [X] Tests are covering the bug fix or the new feature Signed-off-by: Charlie Drage <[email protected]>
website/docs/podman/rosetta.md
Outdated
|
|
||
| # Native Apple Rosetta translation layer | ||
|
|
||
| Virtual machine's created by Podman Machine use the native Apple hypervisor `applehv` with Rosetta enabled by default. This increases the speed of any `x86_64` builds or containers to near-native levels by using a translation layer. |
There was a problem hiding this comment.
| Virtual machine's created by Podman Machine use the native Apple hypervisor `applehv` with Rosetta enabled by default. This increases the speed of any `x86_64` builds or containers to near-native levels by using a translation layer. | |
| On macOS, Podman machine creates a virtual machine that uses the native `applehv` Apple hypervisor with Rosetta enabled by default. This increases the speed of any `x86_64` builds or containers to near-native levels by using a translation layer. |
website/docs/podman/rosetta.md
Outdated
|
|
||
| For more information, refer to the [official Apple documentation](https://developer.apple.com/documentation/virtualization/running_intel_binaries_in_linux_vms_with_rosetta) regarding the Rosetta technology. | ||
|
|
||
| Rosetta support is **enabled by default** on all new Podman Machine installations. If you disable Rosetta, [qemu](https://www.qemu.org/) will instead be used. |
There was a problem hiding this comment.
| Rosetta support is **enabled by default** on all new Podman Machine installations. If you disable Rosetta, [qemu](https://www.qemu.org/) will instead be used. | |
| Rosetta support is enabled by default on all new Podman machine installations. If you disable Rosetta, [qemu](https://www.qemu.org/) will instead be used. |
We should reserve the bold formatting only for actual clickable items in the UI. Otherwise, this formatting might confuse readers.
If we want to highlight this piece of information, we can put it in a note.
website/docs/podman/rosetta.md
Outdated
|
|
||
| #### Procedure | ||
|
|
||
| To enable Rosetta support, your Podman Machine instance must be re-created. |
There was a problem hiding this comment.
| To enable Rosetta support, your Podman Machine instance must be re-created. | |
| To enable Rosetta support, re-create your Podman machine instance: |
website/docs/podman/rosetta.md
Outdated
|
|
||
| To enable Rosetta support, your Podman Machine instance must be re-created. | ||
|
|
||
| 1. Delete your Podman Machine. |
There was a problem hiding this comment.
| 1. Delete your Podman Machine. | |
| 1. Delete your Podman machine. |
website/docs/podman/rosetta.md
Outdated
|
|
||
|  | ||
|
|
||
| 3. Re-create your Podman Machine. |
There was a problem hiding this comment.
| 3. Re-create your Podman Machine. | |
| 3. Re-create your Podman machine. |
Can we link to this content: https://66db43672b43eb7a8e0846fb--podman-desktop-pr.netlify.app/docs/podman/creating-a-podman-machine for a user's reference?
website/docs/podman/rosetta.md
Outdated
|
|
||
| If `rosetta = false` does _not_ exist, or is missing, Rosetta is already enabled by default. | ||
|
|
||
| You can also benchmark |
There was a problem hiding this comment.
You can also benchmark is this piece really relevant? If yes, can we add some more context? What do we mean by benchmark in this case??
website/docs/podman/rosetta.md
Outdated
|
|
||
| To verify that Rosetta has been enabled, check your `~/.config/containers/containers.conf` configuration. | ||
|
|
||
| If `rosetta = false` does _not_ exist, or is missing, Rosetta is already enabled by default. |
There was a problem hiding this comment.
does not exist or is missing sounds the same thing. What does it actually depict?
In the procedure part above, we asked users to enable the Rosetta support and here, we are saying Rosetta is already enabled by default. --- contradictory statements.
Should we simply say:
Open your containers.conf file
Check that the value of the rosetta parameter is set to true.
There was a problem hiding this comment.
rosetta parameter is true by default, but does not show in containers.conf.
The doc is more intended for users who haven't upgraded past 5.0.0 yet, or with to disable / enable rosetta support.
Signed-off-by: Charlie Drage <[email protected]>
|
@shipsing updated! thanks for the review :) |
|
LGTM, @cdrage Both the references point to the same page. |
Signed-off-by: Charlie Drage <[email protected]>
cdrage
force-pushed
the
docs-rosetta
branch
from
a74214a
to
33011b8
Compare
Done! THank you :) |
docs: add rosetta documentation information
What does this PR do?
on macOS
relevant.
Screenshot / video of UI
N/A
What issues does this PR fix or reference?
Closes #7777
How to test this PR?
Signed-off-by: Charlie Drage [email protected]