Skip to content

Commit

Permalink
Update branding for macOS
Browse files Browse the repository at this point in the history
Apple has changed their branding guidelines from 'OS X' to 'macOS'
so we should update ours to be within trademark / branding
guidelines. See http://www.apple.com/macos/sierra/

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
  • Loading branch information
Misty Stanley-Jones committed Oct 18, 2016
1 parent 803f94f commit 01910ab
Show file tree
Hide file tree
Showing 49 changed files with 137 additions and 134 deletions.
4 changes: 2 additions & 2 deletions compose/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ title: Install Compose

# Install Docker Compose

You can run Compose on OS X, Windows and 64-bit Linux. To install it, you'll need to install Docker first.
You can run Compose on macOS, Windows and 64-bit Linux. To install it, you'll need to install Docker first.

To install Compose, do the following:

1. Install Docker Engine:

* <a href="/engine/installation/mac/" target="_blank">Mac OS X installation</a>
* <a href="/engine/installation/mac/" target="_blank">macOS installation</a>

* <a href="/engine/installation/windows/" target="_blank">Windows installation</a>

Expand Down
2 changes: 1 addition & 1 deletion compose/reference/envvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Specify the path to a Compose file. If not provided, Compose looks for a file na
succession until a file by that name is found.

This variable supports multiple compose files separate by a path separator (on
Linux and OSX the path separator is `:`, on Windows it is `;`). For example:
Linux and macOS the path separator is `:`, on Windows it is `;`). For example:
`COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`

See also the `-f` [command-line option](overview.md).
Expand Down
2 changes: 1 addition & 1 deletion docker-cloud/getting-started/deploy-app/1_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This tutorial assumes that you have:

- a free <a href="https://hub.docker.com/" target="_blank">Docker ID account</a>.
- at least one node running. If you don't have any nodes set up in Docker Cloud yet, [start here](../../getting-started/your_first_node.md) to set these up.
- (optional) Docker Engine installed - see the installation guides for <a href="https://docs.docker.com/installation/#installation" target="_blank">OS X, Windows and Linux</a>.
- (optional) Docker Engine installed - see the installation guides for <a href="https://docs.docker.com/installation/#installation" target="_blank">macOS, Windows and Linux</a>.

Let's get started!

Expand Down
4 changes: 2 additions & 2 deletions docker-cloud/getting-started/deploy-app/2_set_up.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ Open your shell or terminal application and execute the following command:
$ pip install docker-cloud
```

#### Install on Mac OS X
#### Install on macOS

We recommend installing Docker CLI for OS X using Homebrew. If you don't have `brew` installed, follow the instructions here: <a href="http://brew.sh" target="_blank">http://brew.sh</a>
We recommend installing Docker CLI for macOS using Homebrew. If you don't have `brew` installed, follow the instructions here: <a href="http://brew.sh" target="_blank">http://brew.sh</a>

Once Homebrew is installed, open Terminal and run the following command:

Expand Down
10 changes: 5 additions & 5 deletions docker-cloud/installing-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ aliases:
- /docker-cloud/getting-started/intermediate/installing-cli/
- /docker-cloud/getting-started/installing-cli/
- /docker-cloud/tutorials/installing-cli/
description: Using the Docker Cloud CLI on Linux, Windows, and Mac OS X, installing,
description: Using the Docker Cloud CLI on Linux, Windows, and macOS, installing,
updating, uninstall
keywords:
- cloud, command-line, CLI
Expand Down Expand Up @@ -43,9 +43,9 @@ Open your terminal or command shell and execute the following command:
$ pip install docker-cloud
```

#### Install on Mac OS X
#### Install on macOS

We recommend installing Docker CLI for OS X using Homebrew. If you don't have `brew` installed, follow the instructions here: <a href="http://brew.sh" target="_blank">http://brew.sh</a>
We recommend installing Docker CLI for macOS using Homebrew. If you don't have `brew` installed, follow the instructions here: <a href="http://brew.sh" target="_blank">http://brew.sh</a>

Once Homebrew is installed, open Terminal and run the following command:

Expand Down Expand Up @@ -90,7 +90,7 @@ Periodically, Docker will add new features and fix bugs in the existing CLI. To
$ pip install -U docker-cloud
```

#### Upgrade the docker-cloud CLI on Mac OS X
#### Upgrade the docker-cloud CLI on macOS

```
$ brew update && brew upgrade docker-cloud
Expand All @@ -109,7 +109,7 @@ Open your terminal or command shell and execute the following command:
$ pip uninstall docker-cloud
```

#### Uninstall on Mac OS X
#### Uninstall on macOS

Open your Terminal application and execute the following command:

Expand Down
2 changes: 1 addition & 1 deletion docker-for-mac/docker-toolbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Docker for Mac is a Mac native application, that you install in `/Applications`.

Here are some key points to know about Docker for Mac before you get started:

* Docker for Mac does not use VirtualBox, but rather <a href="https://github.com/docker/HyperKit/" target="_blank">HyperKit</a>, a lightweight OS X virtualization solution built on top of Hypervisor.framework in OS X 10.10 Yosemite and higher.
* Docker for Mac does not use VirtualBox, but rather <a href="https://github.com/docker/HyperKit/" target="_blank">HyperKit</a>, a lightweight macOS virtualization solution built on top of Hypervisor.framework in macOS 10.10 Yosemite and higher.

* Installing Docker for Mac does not affect machines you created with Docker Machine. The install offers to copy containers and images from your local `default` machine (if one exists) to the new Docker for Mac HyperKit VM. If chosen, content from `default` is copied to the new Docker for Mac HyperKit VM, and your original `default` machine is kept as is.

Expand Down
8 changes: 4 additions & 4 deletions docker-for-mac/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Do the following each time:
### What is Docker.app?

`Docker.app` is Docker for Mac, a bundle of Docker client, and Docker
Engine. `Docker.app` uses the OS X
Hypervisor.framework (part of MacOS X 10.10 Yosemite and higher)
Engine. `Docker.app` uses the macOS
Hypervisor.framework (part of macOS 10.10 Yosemite and higher)
to run containers, meaning that _**no separate VirtualBox is required**_.

### What kind of feedback are we looking for?
Expand Down Expand Up @@ -122,7 +122,7 @@ Docker for Mac creates a certificate bundle of all user-trusted CAs based on the

### What are system requirements for Docker for Mac?

Note that you need a Mac that supports hardware virtualization, which is most non ancient ones; i.e., use OS X `10.10.3+` or `10.11` (OS X Yosemite or OS X El Capitan). See also "What to know before you install" in [Getting Started](index.md).
Note that you need a Mac that supports hardware virtualization, which is most non ancient ones; i.e., use macOS `10.10.3+` or `10.11` (macOS Yosemite or macOS El Capitan). See also "What to know before you install" in [Getting Started](index.md).

### Do I need to uninstall Docker Toolbox to use Docker for Mac?

Expand All @@ -140,7 +140,7 @@ Toolbox Mac topics.

### What is HyperKit?

HyperKit is a hypervisor built on top of the Hypervisor.framework in OS X 10.10 Yosemite and higher. It runs entirely in userspace and has no other dependencies.
HyperKit is a hypervisor built on top of the Hypervisor.framework in macOS 10.10 Yosemite and higher. It runs entirely in userspace and has no other dependencies.

We use HyperKit to eliminate the need for other VM products, such as Oracle Virtualbox or VMWare Fusion.

Expand Down
4 changes: 2 additions & 2 deletions docker-for-mac/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For more about stable and beta channels, see the [FAQs](faqs.md#stable-and-beta-

>**Important Notes**:
>
>* Docker for Mac requires OS X 10.10.3 Yosemite or newer running on a 2010 or newer Mac, with Intel's hardware support for MMU virtualization. Please see [What to know before you install](index.md#what-to-know-before-you-install) for a full list of prerequisites.
>* Docker for Mac requires macOS 10.10.3 Yosemite or newer running on a 2010 or newer Mac, with Intel's hardware support for MMU virtualization. Please see [What to know before you install](index.md#what-to-know-before-you-install) for a full list of prerequisites.
>
>* <font color="#CC3366">You can switch between beta and stable versions, but _you must have only one app installed at a time_.</font> Also, you will need to save images and export containers you want to keep before uninstalling the current version before installing another. For more about this, see the [FAQs about beta and stable channels](faqs.md#stable-and-beta-channels).
Expand All @@ -70,7 +70,7 @@ For more about stable and beta channels, see the [FAQs](faqs.md#stable-and-beta-

- Mac must be a 2010 or newer model, with Intel's hardware support for memory management unit (MMU) virtualization; i.e., Extended Page Tables (EPT)

- OS X 10.10.3 Yosemite or newer
- macOS 10.10.3 Yosemite or newer

- At least 4GB of RAM

Expand Down
18 changes: 9 additions & 9 deletions docker-for-mac/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Docker for Mac provides several networking features to make it easier to use.
### VPN Passthrough

Docker for Mac's networking can work when attached to a VPN.
To do this, Docker for Mac intercepts traffic from the `HyperKit` and injects it into OSX as if it originated from the Docker application.
To do this, Docker for Mac intercepts traffic from the `HyperKit` and injects it into macOS as if it originated from the Docker application.

### Port Mapping

Expand All @@ -33,10 +33,10 @@ Docker for Mac will make the container port available at `localhost`.

### HTTP/HTTPS Proxy Support

Docker for Mac will detect HTTP/HTTPS Proxy Settings from OSX and automatically propagate these to Docker and to your containers.
For example, if you set your proxy settings to `http://proxy.example.com` in OSX, Docker will use this proxy when pulling containers.
Docker for Mac will detect HTTP/HTTPS Proxy Settings from macOS and automatically propagate these to Docker and to your containers.
For example, if you set your proxy settings to `http://proxy.example.com` in macOS, Docker will use this proxy when pulling containers.

![OSX Proxy Settings](images/proxy-settings.png)
![macOS Proxy Settings](images/proxy-settings.png)

When you start a container, you will see that your proxy settings propagate into the containers. For example:

Expand All @@ -59,18 +59,18 @@ If you have containers that you wish to keep running across restarts, you should

Following is a summary of current limitations on the Docker for Mac networking stack, along with some ideas for workarounds.

### There is no docker0 bridge on OSX
### There is no docker0 bridge on macOS

Because of the way networking is implemented in Docker for Mac, you cannot see a `docker0` interface in OSX.
Because of the way networking is implemented in Docker for Mac, you cannot see a `docker0` interface in macOS.
This interface is actually within `HyperKit`.

### I cannot ping my containers

Unfortunately, due to limitations in OSX, we're unable to route traffic to containers, and from containers back to the host.
Unfortunately, due to limitations in macOS, we're unable to route traffic to containers, and from containers back to the host.

### Per-container IP addressing is not possible

The docker (Linux) bridge network is not reachable from the OSX host.
The docker (Linux) bridge network is not reachable from the macOS host.

### Use cases and workarounds

Expand Down Expand Up @@ -105,6 +105,6 @@ See the [run commmand](/engine/reference/commandline/run.md) for more details on

#### A view into implementation

We understand that these workarounds are not ideal, but there are several problems. In particular, there is a bug in OSX that is only fixed in 10.12 and is not being backported as far as we can tell, which means that we could not support this in all supported OSX versions. In addition, this network setup would require root access which we are trying to avoid entirely in Docker for Mac (we currently have a very small root helper that we are trying to remove).
We understand that these workarounds are not ideal, but there are several problems. In particular, there is a bug in macOS that is only fixed in 10.12 and is not being backported as far as we can tell, which means that we could not support this in all supported macOS versions. In addition, this network setup would require root access which we are trying to avoid entirely in Docker for Mac (we currently have a very small root helper that we are trying to remove).


Loading

0 comments on commit 01910ab

Please sign in to comment.