Add Colima installation over Docker Desktop by michaelsaki · Pull Request #96 · cisagov/development-guide

michaelsaki · 2024-02-09T20:42:41Z

🗣 Description

This PR will remove the current Docker documentation from the mac-env-setup.md and replace it with steps to install and configure Colima.

💭 Motivation and context

Docker now requires certain users and businesses to purchase a license for use of Docker Desktop.

Colima is an open source software that is already used by developers in this organization and has a similar set of CLI commands as Docker.

This will satisfy issue #95.

✅ Pre-approval checklist

This PR has an informative and human-readable title.
Changes are limited to a single goal - eschew scope creep!
All relevant type-of-change labels have been added.
I have read the CONTRIBUTING document.
These code changes follow cisagov code standards.
All relevant repo and/or project documentation has been updated
to reflect the changes in this PR.
All new and existing tests pass.

dv4harr10 · 2024-02-14T14:34:15Z

Hi Michael, I noticed 2 small issues: 1) for dev_envs/mac-env-setup.md line 153 , requires a wording change from 'optionalcon figuration' to 'optional configuration'. 2) for two brew install commands I received the error: Permission denied @ apply2files-/usr/local/lib/docker/cli-plugins. (This occurred when running 'brew install docker-buildx' and 'brew install colima docker docker-compose').

michaelsaki · 2024-02-14T16:41:40Z

Hi Michael, I noticed 2 small issues: 1) for dev_envs/mac-env-setup.md line 153 , requires a wording change from 'optionalcon figuration' to 'optional configuration'. 2) for two brew install commands I received the error: Permission denied @ apply2files-/usr/local/lib/docker/cli-plugins. (This occurred when running 'brew install docker-buildx' and 'brew install colima docker docker-compose').

I think the second issue might be because you haven't removed previous docker configurations from your system.

dev_envs/mac-env-setup.md

dav3r

Not a full review, but a couple of items caught my eye.

dev_envs/mac-env-setup.md

jsf9k

One very minor thang.

dev_envs/mac-env-setup.md

dav3r

👍 👍

michaelsaki · 2024-02-28T17:23:27Z

Something I noticed when running Molecule was that I left out the steps for configuring the new Docker daemon managed by Colima. Not a huge change but still thought you all would want to take a look: b8034d4

dev_envs/mac-env-setup.md

dav3r

Thanks for adding this! 👍 👍

jsf9k

Approval intensifies!!!

michaelsaki · 2024-02-28T20:06:17Z

Approval intensifies!!!

Final boss approaches! @mcdonnnj

Since our suggested containerization tool is Colima it makes sense to update the development guide to reflect this and remove the Docker installation steps.

Co-authored-by: David Harris <123905168+dv4harr10@users.noreply.github.com>

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Adds documentation for linking Colima with the Docker daemon. This ensures Docker client tools communicate with Colima's managed Docker daemon, essential for Docker-based applications like Molecule without Docker Desktop. Includes the setup code snippet and its importance for better user understanding and usability in development workflows.

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Change the section heading from "Configure Colima's Docker daemon" to "Support applications that are unaware of Docker context" to make it more accurate and reflective of the content. Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

michaelsaki · 2024-05-01T14:19:08Z

@mcdonnnj Last call on the review for this. 🚂

mcdonnnj

Strong work 💪💪💪 I have some feedback for your consideration.

Note

I tested and verified the plugin interactions with the docker-compose and docker-buildx formulae. Immediately after installation I was able to run a docker <plugin> and get the help output while before installation Docker complained about an unknown command.

mcdonnnj · 2024-04-30T18:45:21Z

dev_envs/mac-env-setup.md

 packages. We recommend installing all the packages specified in the
 [CISA `laptop` script repository](https://github.com/cisagov/laptop/blob/master/Brewfile).

+### Colima: A Docker alternative ###


I would like this whole section to be a sub-section for Docker (above). It still relies on Docker under the hood (by default) and simply provides an alternative for Docker Desktop.

@mcdonnnj see here 8ce2503

dev_envs/mac-env-setup.md

mcdonnnj · 2024-05-01T20:20:36Z

dev_envs/mac-env-setup.md

+
+Enhance your Colima setup with the following optional configurations:
+
+#### Docker Compose as a Docker plugin ####


So the docker-compose formula is the Compose plugin. You can see in the formula's code that it's pulling down the latest version. It just creates a docker-compose binary that is symlinked into the plugins directory.

Good catch! Verified it on my end. Everything looks good without the config stuff.

See here: 8ce2503

dev_envs/mac-env-setup.md

mcdonnnj · 2024-05-01T20:33:07Z

dev_envs/mac-env-setup.md

+
+    Ensure the `docker compose` usage menu is displayed.
+
+#### Installing Buildx ####


This is also already installed as a Docker plugin by the formula per the formula's code.

See here: 8ce2503

dev_envs/mac-env-setup.md

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

It was discovered that the docker-compose formula is the Compose plugin. It creates a docker-compose binary that is symlinked into the plugins directory. This is also the case for the docker-buildx plugin. Since this is the case it makes sense to remove the instructions for configuring the plugins. The Colima instructions were also moved to be a sub section under the Docker section since Colima relies on Docker under the hood and is simply an alternative to Docker.

michaelsaki requested review from dav3r, felddy, jasonodoom, jsf9k and mcdonnnj as code owners February 9, 2024 20:42

michaelsaki linked an issue Feb 9, 2024 that may be closed by this pull request

Add steps for using an alternative to Docker #95

Open

1 task

michaelsaki requested a review from dv4harr10 February 9, 2024 20:43

michaelsaki self-assigned this Feb 13, 2024

michaelsaki added the documentation This issue or pull request improves or adds to documentation label Feb 13, 2024

dv4harr10 approved these changes Feb 14, 2024

View reviewed changes

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

jsf9k requested changes Feb 14, 2024

View reviewed changes

dav3r reviewed Feb 15, 2024

View reviewed changes

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

dav3r reviewed Feb 16, 2024

View reviewed changes

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

jsf9k requested changes Feb 20, 2024

View reviewed changes

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

jsf9k requested changes Feb 21, 2024

View reviewed changes

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

michaelsaki added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Feb 21, 2024

jsf9k approved these changes Feb 21, 2024

View reviewed changes

dav3r approved these changes Feb 27, 2024

View reviewed changes

michaelsaki force-pushed the documentation/add-docker-alternative branch from faeed39 to b8034d4 Compare February 28, 2024 17:20

michaelsaki requested review from dav3r, dv4harr10 and jsf9k February 28, 2024 17:21

jsf9k requested changes Feb 28, 2024

View reviewed changes

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

jsf9k approved these changes Feb 28, 2024

View reviewed changes

dav3r requested changes Feb 28, 2024

View reviewed changes

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

dev_envs/mac-env-setup.md Outdated Show resolved Hide resolved

dav3r approved these changes Feb 28, 2024

View reviewed changes

jsf9k approved these changes Feb 28, 2024

View reviewed changes

Michael Saki and others added 14 commits March 7, 2024 16:26

Add Colima installation over Docker Desktop

475d5d2

Since our suggested containerization tool is Colima it makes sense to update the development guide to reflect this and remove the Docker installation steps.

Fix grammar and add backticks to inline code

52d7fc7

Make the instructions more clear and concise

354c576

Fix spelling error

62d848f

Co-authored-by: David Harris <123905168+dv4harr10@users.noreply.github.com>

Remove capitalizations for second level headings

c451be2

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Remove unnecessary capitalizations and newline

222fd03

Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

Remove hyphen for docker compose

6601df8

Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

Add Desktop to Docker Desktop

1de77f6

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Revert Docker instructions and add note for Colima

c7f1637

Improve format and update link for Colima in markdown

60c4fac

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Change syntax for Note in MD

d6e7a19

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Update heading for Docker context support

b13cc30

Change the section heading from "Configure Colima's Docker daemon" to "Support applications that are unaware of Docker context" to make it more accurate and reflective of the content. Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

Add link to Colima FAQ for more info on Docker daemon

66de2ef

Co-authored-by: dav3r <david.redmin@gwe.cisa.dhs.gov>

jsf9k force-pushed the documentation/add-docker-alternative branch from 5a4f322 to 66de2ef Compare March 7, 2024 21:26

mcdonnnj requested changes May 1, 2024

View reviewed changes

michaelsaki and others added 3 commits May 2, 2024 12:02

Reword some of the documentation for clarity

d82d867

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Change "docker-compose" to "docker compose" in documentation

ad5f2f0

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>


		Enhance your Colima setup with the following optional configurations:

		#### Docker Compose as a Docker plugin ####


		Ensure the `docker compose` usage menu is displayed.

		#### Installing Buildx ####

Conversation

michaelsaki commented Feb 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🗣 Description

💭 Motivation and context

✅ Pre-approval checklist

Uh oh!

dv4harr10 commented Feb 14, 2024

Uh oh!

michaelsaki commented Feb 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dav3r left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jsf9k left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dav3r left a comment

Choose a reason for hiding this comment

Uh oh!

michaelsaki commented Feb 28, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dav3r left a comment

Choose a reason for hiding this comment

Uh oh!

jsf9k left a comment

Choose a reason for hiding this comment

Uh oh!

michaelsaki commented Feb 28, 2024

Uh oh!

michaelsaki commented May 1, 2024

Uh oh!

mcdonnnj left a comment

Choose a reason for hiding this comment

Uh oh!

mcdonnnj Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michaelsaki May 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mcdonnnj May 1, 2024

Choose a reason for hiding this comment

Uh oh!

michaelsaki May 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mcdonnnj May 1, 2024

Choose a reason for hiding this comment

Uh oh!

michaelsaki May 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

michaelsaki commented Feb 9, 2024 •

edited

Loading

michaelsaki commented Feb 14, 2024 •

edited

Loading

mcdonnnj Apr 30, 2024 •

edited

Loading