Skip to content

Commit 8ce2503

Browse files
author
Michael Saki
committed
Remove plugin configs and move instructions
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.
1 parent ad5f2f0 commit 8ce2503

File tree

1 file changed

+60
-100
lines changed

1 file changed

+60
-100
lines changed

dev_envs/mac-env-setup.md

Lines changed: 60 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -52,64 +52,7 @@ Download the latest stable [Docker Desktop on Mac](https://www.docker.com/produc
5252
Install it by double-clicking the downloaded `dmg` file and dragging the
5353
Docker application file to the `Applications` folder.
5454

55-
### iTerm2 (recommended) ###
56-
57-
To set up iTerm2 - a macOS terminal replacement with some nifty features -
58-
visit the [iTerm2 download page](https://www.iterm2.com/downloads.html) to
59-
get the latest stable release. Install it by double-clicking the downloaded
60-
`zip` file and dragging the extracted `iTerm` application file to the
61-
`Applications` folder.
62-
63-
Once installed, run the app and select the menu option
64-
`iTerm2 > Make iTerm2 Default Term`.
65-
66-
> **Note**
67-
> You may also `Make iTerm2 Default Term` on your standard user account.
68-
69-
### VPN configuration ###
70-
71-
Once you're set up with the lab (CAL) VPN connection, we recommend you set up
72-
split-tunneling. Instructions and a generator script are located in the
73-
[vpn-config-gen repository](https://github.com/cisagov/vpn-config-gen).
74-
75-
## User environment setup ##
76-
77-
For this section and following sections, log back in as your standard user.
78-
79-
> **Note**
80-
> If you installed iTerm2 above, run the iTerm2 app and select the menu option
81-
> `iTerm2 > Make iTerm2 Default Term` to make it your default too.
82-
83-
### Automatic package installation (recommended) ###
84-
85-
NOTE (DEC 2022): The [CISA `laptop` script] is out of date but still
86-
functional.
87-
88-
To set up a dev environment via the [CISA `laptop` script], execute
89-
the following in your terminal:
90-
91-
```bash
92-
bash <(curl --silent https://raw.githubusercontent.com/cisagov/laptop/master/laptop)
93-
```
94-
95-
This will `curl` the current install files and script. You can specify
96-
additional packages to install by creating a `Brewfile.local`, as described in
97-
the Readme for the `laptop` repo where an example is provided.
98-
99-
### Manual package installation (alternative) ###
100-
101-
Open Terminal and install `brew` per the instructions from
102-
[Homebrew](https://brew.sh). You will probably have to do this with `sudo`.
103-
104-
```console
105-
/bin/bash -c "$(curl --fail --silent --show-error --location https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
106-
```
107-
108-
After installing Brew, you'll want to install other useful
109-
packages. We recommend installing all the packages specified in the
110-
[CISA `laptop` script repository](https://github.com/cisagov/laptop/blob/master/Brewfile).
111-
112-
### Colima: A Docker alternative ###
55+
#### Colima: A Docker alternative ####
11356

11457
For individuals or businesses seeking a container solution without
11558
the licensing conditions associated with [Docker Desktop](https://www.docker.com/pricing/faq/)
@@ -156,50 +99,10 @@ uninstall it before proceeding.
15699

157100
The Docker Compose usage menu should appear.
158101

159-
### Optional configurations ###
102+
#### Optional configurations ####
160103

161104
Enhance your Colima setup with the following optional configurations:
162105

163-
#### Docker Compose as a Docker plugin ####
164-
165-
Convert `docker-compose` to a Docker plugin for streamlined commands:
166-
167-
1. Create a directory for Docker CLI plugins:
168-
169-
```console
170-
mkdir -p ~/.docker/cli-plugins
171-
```
172-
173-
1. Symlink the `docker-compose` command:
174-
175-
```console
176-
ln -sfn $(brew --prefix)/opt/docker-compose/bin/docker-compose ~/.docker/cli-plugins/docker-compose
177-
```
178-
179-
1. Verify by running:
180-
181-
```console
182-
docker compose
183-
```
184-
185-
Ensure the `docker compose` usage menu is displayed.
186-
187-
#### Installing Buildx ####
188-
189-
Buildx is necessary for building some Docker containers:
190-
191-
1. Install Buildx with Homebrew:
192-
193-
```console
194-
brew install docker-buildx
195-
```
196-
197-
1. Symlink Buildx to the CLI plugins directory:
198-
199-
```console
200-
ln -sfn $(brew --prefix)/opt/docker-buildx/bin/docker-buildx ~/.docker/cli-plugins/docker-buildx
201-
```
202-
203106
#### Customizing VM resources ####
204107

205108
To customize the VM's resources, such as CPUs, memory, and disk space:
@@ -216,7 +119,7 @@ To customize the VM's resources, such as CPUs, memory, and disk space:
216119
colima start --cpu 4 --memory 4 --disk 100
217120
```
218121

219-
### Support applications that are unaware of Docker context ###
122+
#### Support applications that are unaware of Docker context ####
220123

221124
In your shell profile (`.bashrc`, `.zshrc`, etc.) add the following configuration.
222125

@@ -231,6 +134,63 @@ export DOCKER_HOST=unix://$HOME/.colima/default/docker.sock
231134
> applications (e.g. Molecule) function as expected without Docker Desktop.
232135
> For more information, see [here](https://github.com/abiosoft/colima/blob/main/docs/FAQ.md#cannot-connect-to-the-docker-daemon-at-unixvarrundockersock-is-the-docker-daemon-running).
233136
137+
### iTerm2 (recommended) ###
138+
139+
To set up iTerm2 - a macOS terminal replacement with some nifty features -
140+
visit the [iTerm2 download page](https://www.iterm2.com/downloads.html) to
141+
get the latest stable release. Install it by double-clicking the downloaded
142+
`zip` file and dragging the extracted `iTerm` application file to the
143+
`Applications` folder.
144+
145+
Once installed, run the app and select the menu option
146+
`iTerm2 > Make iTerm2 Default Term`.
147+
148+
> **Note**
149+
> You may also `Make iTerm2 Default Term` on your standard user account.
150+
151+
### VPN configuration ###
152+
153+
Once you're set up with the lab (CAL) VPN connection, we recommend you set up
154+
split-tunneling. Instructions and a generator script are located in the
155+
[vpn-config-gen repository](https://github.com/cisagov/vpn-config-gen).
156+
157+
## User environment setup ##
158+
159+
For this section and following sections, log back in as your standard user.
160+
161+
> **Note**
162+
> If you installed iTerm2 above, run the iTerm2 app and select the menu option
163+
> `iTerm2 > Make iTerm2 Default Term` to make it your default too.
164+
165+
### Automatic package installation (recommended) ###
166+
167+
NOTE (DEC 2022): The [CISA `laptop` script] is out of date but still
168+
functional.
169+
170+
To set up a dev environment via the [CISA `laptop` script], execute
171+
the following in your terminal:
172+
173+
```bash
174+
bash <(curl --silent https://raw.githubusercontent.com/cisagov/laptop/master/laptop)
175+
```
176+
177+
This will `curl` the current install files and script. You can specify
178+
additional packages to install by creating a `Brewfile.local`, as described in
179+
the Readme for the `laptop` repo where an example is provided.
180+
181+
### Manual package installation (alternative) ###
182+
183+
Open Terminal and install `brew` per the instructions from
184+
[Homebrew](https://brew.sh). You will probably have to do this with `sudo`.
185+
186+
```console
187+
/bin/bash -c "$(curl --fail --silent --show-error --location https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
188+
```
189+
190+
After installing Brew, you'll want to install other useful
191+
packages. We recommend installing all the packages specified in the
192+
[CISA `laptop` script repository](https://github.com/cisagov/laptop/blob/master/Brewfile).
193+
234194
### Environment configuration ###
235195

236196
For portability between computers and environments, you may want to switch

0 commit comments

Comments
 (0)