diff options
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 101 |
1 files changed, 68 insertions, 33 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index d6271bec96..a8b48bdf03 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
| @@ -542,21 +542,26 @@ | |||
| 542 | machine as your Yocto Project build host: | 542 | machine as your Yocto Project build host: |
| 543 | <orderedlist> | 543 | <orderedlist> |
| 544 | <listitem><para> | 544 | <listitem><para> |
| 545 | <emphasis>Go to the Docker Installation Site:</emphasis> | 545 | <emphasis>Determine What Your Build Host Needs:</emphasis> |
| 546 | <ulink url='https://www.docker.com/what-docker'>Docker</ulink> | 546 | <ulink url='https://www.docker.com/what-docker'>Docker</ulink> |
| 547 | is a software container platform that you need to install | 547 | is a software container platform that you need to install |
| 548 | on the host development machine. | 548 | on the build host. |
| 549 | To start the installation process, see the | 549 | Depending on your build host, you might have to install |
| 550 | <ulink url='https://docs.docker.com/engine/installation/'>Docker Installation</ulink> | 550 | different software to support Docker containers. |
| 551 | site. | 551 | Go to the Docker installation page and read about the |
| 552 | platform requirements in | ||
| 553 | "<ulink url='https://docs.docker.com/install/#supported-platforms'>Supported Platforms</ulink>" | ||
| 554 | your build host needs to run containers. | ||
| 552 | </para></listitem> | 555 | </para></listitem> |
| 553 | <listitem><para> | 556 | <listitem><para> |
| 554 | <emphasis>Choose Your Docker Edition:</emphasis> | 557 | <emphasis>Choose What To Install:</emphasis> |
| 555 | Docker comes in several editions. | 558 | Depending on whether or not your build host meets system |
| 556 | For the Yocto Project, the stable community edition | 559 | requirements, you need to install "Docker CE Stable" or |
| 557 | (i.e. "Docker CE Stable") is adequate. | 560 | the "Docker Toolbox". |
| 558 | You can learn more about the Docker editions from the | 561 | Most situations call for Docker CE. |
| 559 | site. | 562 | However, if you have a build host that does not meet |
| 563 | requirements (e.g. Pre-Windows 10 or Windows 10 "Home" | ||
| 564 | version), you must install Docker Toolbox instead. | ||
| 560 | </para></listitem> | 565 | </para></listitem> |
| 561 | <listitem><para> | 566 | <listitem><para> |
| 562 | <emphasis>Go to the Install Site for Your Platform:</emphasis> | 567 | <emphasis>Go to the Install Site for Your Platform:</emphasis> |
| @@ -567,38 +572,68 @@ | |||
| 567 | edition, click that link under "Supported Platforms". | 572 | edition, click that link under "Supported Platforms". |
| 568 | </para></listitem> | 573 | </para></listitem> |
| 569 | <listitem><para> | 574 | <listitem><para> |
| 570 | <emphasis>Understand What You Need:</emphasis> | ||
| 571 | The install page has pre-requisites your build host must | ||
| 572 | meet. | ||
| 573 | Be sure you read through this page and make sure your | ||
| 574 | machine meets the requirements to run Docker. | ||
| 575 | If your machine does not meet the requirements, the page | ||
| 576 | has instructions to handle exceptions. | ||
| 577 | For example, to run Docker on Windows 10, you must have | ||
| 578 | the pro version of the operating system. | ||
| 579 | If you have the home version, you need to install the | ||
| 580 | <ulink url='https://docs.docker.com/toolbox/overview/#ready-to-get-started'>Docker Toolbox</ulink>. | ||
| 581 | </para> | ||
| 582 | |||
| 583 | <para>Another example is that a Windows machine needs to | ||
| 584 | have Microsoft Hyper-V. | ||
| 585 | If you have a legacy version of the the Microsoft | ||
| 586 | operating system or for any other reason you do not have | ||
| 587 | Microsoft Hyper-V, you would have to enter the BIOS and | ||
| 588 | enable virtualization. | ||
| 589 | </para></listitem> | ||
| 590 | <listitem><para> | ||
| 591 | <emphasis>Install the Software:</emphasis> | 575 | <emphasis>Install the Software:</emphasis> |
| 592 | Once you have understood all the pre-requisites, you can | 576 | Once you have understood all the pre-requisites, you can |
| 593 | download and install the appropriate software. | 577 | download and install the appropriate software. |
| 594 | Follow the instructions for your specific machine and | 578 | Follow the instructions for your specific machine and |
| 595 | the type of the software you need to install. | 579 | the type of the software you need to install: |
| 580 | <itemizedlist> | ||
| 581 | <listitem><para> | ||
| 582 | Install | ||
| 583 | <ulink url='https://docs.docker.com/docker-for-windows/install/#install-docker-for-windows-desktop-app'>Docker CE for Windows</ulink> | ||
| 584 | for Windows build hosts that meet requirements. | ||
| 585 | </para></listitem> | ||
| 586 | <listitem><para> | ||
| 587 | Install | ||
| 588 | <ulink url='https://docs.docker.com/docker-for-mac/install/#install-and-run-docker-for-mac'>Docker CE for Macs</ulink> | ||
| 589 | for Mac build hosts that meet requirements. | ||
| 590 | </para></listitem> | ||
| 591 | <listitem><para> | ||
| 592 | Install | ||
| 593 | <ulink url='https://docs.docker.com/toolbox/toolbox_install_windows/'>Docker Toolbox for Windows</ulink> | ||
| 594 | for Windows build hosts that do not meet Docker | ||
| 595 | requirements. | ||
| 596 | </para></listitem> | ||
| 597 | <listitem><para> | ||
| 598 | Install | ||
| 599 | <ulink url='https://docs.docker.com/toolbox/toolbox_install_mac/'>Docker Toolbox for MacOS</ulink> | ||
| 600 | for Mac build hosts that do not meet Docker | ||
| 601 | requirements. | ||
| 602 | </para></listitem> | ||
| 603 | <listitem><para> | ||
| 604 | Install | ||
| 605 | <ulink url='https://docs.docker.com/install/linux/docker-ce/centos/'>Docker CE for CentOS</ulink> | ||
| 606 | for Linux build hosts running the CentOS | ||
| 607 | distribution. | ||
| 608 | </para></listitem> | ||
| 609 | <listitem><para> | ||
| 610 | Install | ||
| 611 | <ulink url='https://docs.docker.com/install/linux/docker-ce/debian/'>Docker CE for Debian</ulink> | ||
| 612 | for Linux build hosts running the Debian | ||
| 613 | distribution. | ||
| 614 | </para></listitem> | ||
| 615 | <listitem><para> | ||
| 616 | Install | ||
| 617 | <ulink url='https://docs.docker.com/install/linux/docker-ce/fedora/'>Docker CE for Fedora</ulink> | ||
| 618 | for Linux build hosts running the Fedora | ||
| 619 | distribution. | ||
| 620 | </para></listitem> | ||
| 621 | <listitem><para> | ||
| 622 | Install | ||
| 623 | <ulink url='https://docs.docker.com/install/linux/docker-ce/ubuntu/'>Docker CE for Ubuntu</ulink> | ||
| 624 | for Linux build hosts running the Ubuntu | ||
| 625 | distribution. | ||
| 626 | </para></listitem> | ||
| 627 | </itemizedlist> | ||
| 596 | </para></listitem> | 628 | </para></listitem> |
| 597 | <listitem><para> | 629 | <listitem><para> |
| 598 | <emphasis>Optionally Orient Yourself With Docker:</emphasis> | 630 | <emphasis>Optionally Orient Yourself With Docker:</emphasis> |
| 599 | If you are unfamiliar with Docker and the container | 631 | If you are unfamiliar with Docker and the container |
| 600 | concept, you can learn more here - | 632 | concept, you can learn more here - |
| 601 | <ulink url='https://docs.docker.com/get-started/'></ulink>. | 633 | <ulink url='https://docs.docker.com/get-started/'></ulink>. |
| 634 | </para></listitem> | ||
| 635 | <listitem><para> | ||
| 636 | <emphasis>Launch Docker or Docker Toolbox:</emphasis> | ||
| 602 | You should be able to launch Docker or the Docker Toolbox | 637 | You should be able to launch Docker or the Docker Toolbox |
| 603 | and have a terminal shell on your development host. | 638 | and have a terminal shell on your development host. |
| 604 | </para></listitem> | 639 | </para></listitem> |
