docs: change recommendation for colima to vz #5948
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rpkoller
reviewed
Mar 8, 2024
There was a problem hiding this comment.
left a few comments. but one general thought. at the moment the order of available docker providers is not in a alphabetical order therefore me as a user would read some sort of ranking into. orbstack is the best and rancher desktop the "worst" ( i exaggerate ). and there are already four options. me as a user would be frozen uncertain which solution to pick. on option might be separate the commercial/paied solutions (orbstack and in part docker) from the open source ones (colima and rancher). those thoughts are definitely out of the scope of this issue but i just wanted to raise them. but i would definitely think it would be good to provide some more guidance or at least some sort of decision tree based help for someone uncertain.
| ``` | ||
| (On macOS versions before Ventura, omit the `--vm-type=qemu` flag as it doesn't work on older OS versions.) | ||
| (On macOS versions before Ventura, use `colima start --cpu 4 --memory 6 --disk 100 --mount-type=sshfs --dns=1.1.1.1` as the other options are not supported on older macOS versions.) | ||
|
|
||
| After the initial run above, you can use `colima start` or use `colima start -e` to edit the configuration file. Run `colima status` at any time to check Colima’s status. | ||
|
|
||
| When your computer restarts, you’ll need to `colima start` again. If you prefer to start Colima automatically on reboot, use `brew services start colima` in Colima version 0.6+ to configure auto-start. |
There was a problem hiding this comment.
i would leave out the detail about brew services start colima. that seems still broken and will be probably a potential source of support requests
| @@ -29,22 +29,22 @@ You’ll need a Docker provider on your system before you can [install DDEV](dde | |||
| 2. Install Colima with `brew install colima`. | |||
| 3. Start Colima with 4 CPUs, 6GB memory, 100GB storage, and Cloudflare DNS, adjusting as needed: | |||
There was a problem hiding this comment.
Suggested change
| 3. Start Colima with 4 CPUs, 6GB memory, 100GB storage, and Cloudflare DNS, adjusting as needed: | |
| 3. Start Colima, creating a 100GB VM with 4 CPUs, 6GB memory, and Cloudflare DNS. Adjust to your own needs: |
| ``` | ||
| (On macOS versions before Ventura, omit the `--vm-type=qemu` flag as it doesn't work on older OS versions.) | ||
| (On macOS versions before Ventura, use `colima start --cpu 4 --memory 6 --disk 100 --mount-type=sshfs --dns=1.1.1.1` as the other options are not supported on older macOS versions.) |
There was a problem hiding this comment.
Suggested change
| (On macOS versions before Ventura, use `colima start --cpu 4 --memory 6 --disk 100 --mount-type=sshfs --dns=1.1.1.1` as the other options are not supported on older macOS versions.) | |
| On versions before macOS Ventura, where Virtiofs was not available, use QEMU instead. | |
| ``` | |
| colima start --cpu 4 --memory 6 --disk 100 --vm-type=qemu --mount-type=sshfs --dns=1.1.1.1 | |
| ``` |
|
|
||
| After the initial run above, you can use `colima start` or use `colima start -e` to edit the configuration file. Run `colima status` at any time to check Colima’s status. | ||
|
|
||
| When your computer restarts, you’ll need to `colima start` again. If you prefer to start Colima automatically on reboot, use `brew services start colima` in Colima version 0.6+ to configure auto-start. | ||
|
|
||
| !!!tip "Colima disk allocation" | ||
| In Colima versions starting with 0.5.4 you can increase—but not decrease—the disk allocation by editing `~/.colima/default/colima.yaml` to change the `disk` setting to a higher value. For example, `disk: 200` will increase allocation to 200 gigabytes. Then `colima restart` will result in the new disk allocation. | ||
| In Colima you can increase—but not decrease—the disk allocation by editing `~/.colima/default/colima.yaml` to change the `disk` setting to a higher value. For example, `disk: 200` will increase allocation to 200 gigabytes. Then `colima restart` will create the new disk allocation. | ||
|
|
||
| !!!warning "Docker contexts let the Docker client point at the right Docker server" | ||
| Colima activates its own Docker context to prevent conflicts with Docker Desktop. If you run `docker context ls`, you’ll see a list of available contexts where the currently-active one is indicated with a `*`—which will be `colima` after you’ve started it. You can change to the default (Docker Desktop) with `docker context use default` or change back with `docker context use colima`. This means you can run Docker Desktop and Colima at the same time, but be mindful of which context you’re pointing at! | ||
|
|
||
| !!!warning "Colima can only work in your home directory unless you do further configuration" |
There was a problem hiding this comment.
Suggested change
| !!!warning "Colima can only work in your home directory unless you do further configuration" | |
| !!!warning "Without additional configuration, Colima can only provide Docker to DDEV projects located in your home directory" |
not the perfect headline yet. i just wanted to communicate the gist i try convey. but in the previous version it could be misread that colima only works in the homedirectory but technically they details the colima documentation is about deals with adding additional (writeable) mounts outside of the home directory which is the default
|
|
||
| !!!warning "Docker contexts let the Docker client point at the right Docker server" | ||
| Colima activates its own Docker context to prevent conflicts with Docker Desktop. If you run `docker context ls`, you’ll see a list of available contexts where the currently-active one is indicated with a `*`—which will be `colima` after you’ve started it. You can change to the default (Docker Desktop) with `docker context use default` or change back with `docker context use colima`. This means you can run Docker Desktop and Colima at the same time, but be mindful of which context you’re pointing at! | ||
|
|
||
| !!!warning "Colima can only work in your home directory unless you do further configuration" | ||
| By default, Colima only mounts your home directory, so it’s easiest to use it in a subdirectory there. See the `~/.colima/default/colima.yaml` for more information, or notes in [colima.yaml](https://github.com/abiosoft/colima/blob/fc948f8f055600986f87e29e3e632daf56ac8774/embedded/defaults/colima.yaml#L130-L143). | ||
| By default, Colima only mounts your home directory, so it’s easiest to use it in a subdirectory there. See the `~/.colima/default/colima.yaml` for more information, or notes in [colima.yaml](https://github.com/abiosoft/colima/blob/main/embedded/defaults/colima.yaml#L160-L173). |
There was a problem hiding this comment.
that implies "so it’s easiest to use it in a subdirectory" that colima is used in a subdirectory. but instead it is about where the ddev based projects are located.
rfay
force-pushed
the
20240308_colima_vz
branch
from
937880c
to
16382b9
Compare
rfay
force-pushed
the
20240308_colima_vz
branch
from
16382b9
to
53fce4b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Issue
How This PR Solves The Issue
Manual Testing Instructions
Run through the install. Have done it many times and currently using it.