Clean up get-started section (#714)
* Clean up get-started section Renames titles of get-started documents to be concise and consistent. Moves GCE from VM to cloud. * Replaces include with ref to download-verify-decompress. - Resolves duplication of Figure 1. - Declutters guide. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Revises header for brevity. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Adds missing URL to correspond to in-text reference to image repo. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 137 KiB After Width: | Height: | Size: 137 KiB |
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 137 KiB After Width: | Height: | Size: 137 KiB |
|
Before Width: | Height: | Size: 103 KiB After Width: | Height: | Size: 103 KiB |
|
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 69 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 138 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
@@ -1,7 +1,7 @@
|
||||
.. _bare-metal-install-server:
|
||||
|
||||
Install |CL-ATTR| on bare metal with live server
|
||||
################################################
|
||||
Install |CL-ATTR| from the live server
|
||||
######################################
|
||||
|
||||
This page explains how to install |CL-ATTR| on bare metal from a bootable USB
|
||||
drive using a live server image.
|
||||
@@ -586,7 +586,8 @@ Add New User
|
||||
|
||||
.. note:
|
||||
|
||||
The User Name must be alphanumeric and can include spaces, commas, or hyphens. Maximum length is 64 characters.
|
||||
The User Name must be alphanumeric and can include spaces, commas, or
|
||||
hyphens. Maximum length is 64 characters.
|
||||
|
||||
.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-23.png
|
||||
:scale: 100%
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _aws-web:
|
||||
|
||||
Create and launch |CL-ATTR| from Amazon Web Services\*
|
||||
######################################################
|
||||
|CL-ATTR| on Amazon Web Services\*
|
||||
##################################
|
||||
|
||||
This tutorial explains how to create and launch a |CL|
|
||||
:abbr:`AMI (Amazon Machine Image)` instance from the
|
||||
@@ -38,8 +38,8 @@ This tutorial assumes the following statements are true:
|
||||
Locate, select, and launch the |CL| Basic AMI
|
||||
*********************************************
|
||||
|
||||
#. Start from your main AWS services console menu in your browser and select the
|
||||
:guilabel:`EC2` text as shown in Figure 1:
|
||||
#. Start from your main AWS services console menu in your browser and select
|
||||
the :guilabel:`EC2` text as shown in Figure 1:
|
||||
|
||||
.. figure:: /_figures/aws/aws-web-1.png
|
||||
:scale: 50 %
|
||||
@@ -69,8 +69,8 @@ Locate, select, and launch the |CL| Basic AMI
|
||||
:guilabel:`AWS Marketplace` menu item to bring up the search bar to
|
||||
:guilabel:`Search AWS Marketplace Products`.
|
||||
|
||||
#. In the search bar, type "clear linux os" and press the :kbd:`Enter` key to
|
||||
search for and locate the :guilabel:`Clear Linux OS Basic` AMI.
|
||||
#. In the search bar, type "clear linux os" and press the :kbd:`Enter` key
|
||||
to search for and locate the :guilabel:`Clear Linux OS Basic` AMI.
|
||||
|
||||
#. Select the :guilabel:`Clear Linux OS Basic` AMI by clicking the
|
||||
:guilabel:`Select` button as shown in Figure 3:
|
||||
@@ -212,8 +212,8 @@ other instances available, they are also listed but not selected.
|
||||
|
||||
ssh -i "AWSClearTestKey.pem" clear@ec2-34-209-39-184.us-west-2.compute.amazonaws.com
|
||||
|
||||
#. A message appears on the terminal stating the authenticity of the host can't
|
||||
be established and prompts you with the message:
|
||||
#. A message appears on the terminal stating the authenticity of the host
|
||||
can't be established and prompts you with the message:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@@ -221,8 +221,9 @@ other instances available, they are also listed but not selected.
|
||||
ECDSA key fingerprint is SHA256:LrziT5Ar66iBTfia8qmiIsrfBUm/UGam76U8bDR6yJc.
|
||||
Are you sure you want to continue connecting (yes/no)?
|
||||
|
||||
#. Type `yes` and press the :kbd:`Enter` key. Another warning is printed to the
|
||||
terminal and you are now at the command prompt of your new |CL| instance.
|
||||
#. Type `yes` and press the :kbd:`Enter` key. Another warning is printed to
|
||||
the terminal and you are now at the command prompt of your new |CL|
|
||||
instance.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _azure:
|
||||
|
||||
Run |CL-ATTR| using Microsoft Azure CLI 2.0
|
||||
###########################################
|
||||
|CL-ATTR| on Microsoft Azure
|
||||
############################
|
||||
|
||||
|CL-ATTR| is available for you to use in the Microsoft* Azure* marketplace and
|
||||
is offered with three different images, also known as a
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _gce:
|
||||
|
||||
Launch |CL-ATTR| Compute Engine on Google Cloud Platform\*
|
||||
##########################################################
|
||||
|CL-ATTR| on Google Cloud Platform\*
|
||||
####################################
|
||||
|
||||
This page explains the steps to create a virtual machine instance of
|
||||
|CL-ATTR| on `Google Cloud Platform`_ (:abbr:`GCP (Google Cloud Platform)`).
|
||||
@@ -24,7 +24,7 @@ Setup |CL| VM on GCP
|
||||
#. Sign in to your Google\* account on the
|
||||
`Google Cloud Console <https://console.cloud.google.com/>`_:
|
||||
|
||||
.. figure:: figures/gce/00-sign-in.png
|
||||
.. figure:: /_figures/gce/00-sign-in.png
|
||||
:scale: 50 %
|
||||
:alt: Sign in to Google services
|
||||
|
||||
@@ -53,10 +53,11 @@ Setup |CL| VM on GCP
|
||||
|
||||
* Click the :guilabel:`Navigation menu` icon on the upper left screen menu.
|
||||
|
||||
* Select the :menuselection:`Storage` item from the sidebar on the left. You
|
||||
will be sent to the Storage Browser tool or the Cloud Storage overview page.
|
||||
* Select the :menuselection:`Storage` item from the sidebar on the left.
|
||||
You will be sent to the Storage Browser tool or the Cloud Storage
|
||||
overview page.
|
||||
|
||||
.. figure:: figures/gce/01-cloud-storage.png
|
||||
.. figure:: /_figures/gce/01-cloud-storage.png
|
||||
:scale: 50 %
|
||||
:alt: Browse Google Cloud Storage
|
||||
|
||||
@@ -66,7 +67,7 @@ Setup |CL| VM on GCP
|
||||
You may need to create a billing account and link to this project
|
||||
before you create a bucket.
|
||||
|
||||
.. figure:: figures/gce/02-storage-browser.png
|
||||
.. figure:: /_figures/gce/02-storage-browser.png
|
||||
:scale: 50 %
|
||||
:alt: Cloud Storage Browser tool
|
||||
|
||||
@@ -79,7 +80,7 @@ Setup |CL| VM on GCP
|
||||
Leave the remaining options set to the defaults, and click the
|
||||
:guilabel:`Create` button at the bottom to create a *Bucket*.
|
||||
|
||||
.. figure:: figures/gce/03-create-bucket.png
|
||||
.. figure:: /_figures/gce/03-create-bucket.png
|
||||
:scale: 50 %
|
||||
:alt: Set a unique bucket name
|
||||
|
||||
@@ -89,19 +90,19 @@ Setup |CL| VM on GCP
|
||||
on the Bucket details page to upload the |CL| GCE image archive
|
||||
to the named bucket:
|
||||
|
||||
.. figure:: figures/gce/04-bucket-created.png
|
||||
.. figure:: /_figures/gce/04-bucket-created.png
|
||||
:scale: 50 %
|
||||
:alt: Cloud Storage bucket is available for storing objects
|
||||
|
||||
Figure 5: Cloud Storage bucket
|
||||
|
||||
.. figure:: figures/gce/10-image-upload.png
|
||||
.. figure:: /_figures/gce/10-image-upload.png
|
||||
:scale: 50 %
|
||||
:alt: Uploading the image source archive file
|
||||
|
||||
Figure 6: Uploading the image source archive file
|
||||
|
||||
.. figure:: figures/gce/11-bucket-uploaded.png
|
||||
.. figure:: /_figures/gce/11-bucket-uploaded.png
|
||||
:scale: 50 %
|
||||
:alt: Image archive imported complete
|
||||
|
||||
@@ -111,19 +112,19 @@ Setup |CL| VM on GCP
|
||||
|
||||
* Click the :guilabel:`Navigation menu` icon on the upper left screen menu.
|
||||
|
||||
* Select the :menuselection:`Compute Engine --> Images` from the side bar on
|
||||
the left.
|
||||
* Select the :menuselection:`Compute Engine --> Images` from the side bar
|
||||
on the left.
|
||||
|
||||
.. figure:: figures/gce/20-gce-image.png
|
||||
.. figure:: /_figures/gce/20-gce-image.png
|
||||
:scale: 50 %
|
||||
:alt: Go to Google Compute Engine Image library
|
||||
|
||||
Figure 8: Image library
|
||||
|
||||
#. On the Compute Engine Image library page, click the :guilabel:`[+] CREATE IMAGE`
|
||||
menu item to create a custom image:
|
||||
#. On the Compute Engine Image library page, click the
|
||||
:guilabel:`[+] CREATE IMAGE` menu item to create a custom image:
|
||||
|
||||
.. figure:: figures/gce/20-image-library.png
|
||||
.. figure:: /_figures/gce/20-image-library.png
|
||||
:scale: 50 %
|
||||
:alt: Create a Google Compute Engine image
|
||||
|
||||
@@ -137,7 +138,7 @@ Setup |CL| VM on GCP
|
||||
#. Locate the :file:`clear-<release number>-gce.tar.gz` file,
|
||||
and click :guilabel:`Select`.
|
||||
|
||||
.. figure:: figures/gce/21-create-image.png
|
||||
.. figure:: /_figures/gce/21-create-image.png
|
||||
:scale: 50 %
|
||||
:alt: Create the image using the imported image archive object
|
||||
|
||||
@@ -146,7 +147,7 @@ Setup |CL| VM on GCP
|
||||
Accept all default options, and click the :guilabel:`Create` button
|
||||
at the bottom to import the Clear Linux GCE image to the image library.
|
||||
|
||||
.. figure:: figures/gce/22-image-list.png
|
||||
.. figure:: /_figures/gce/22-image-list.png
|
||||
:scale: 50 %
|
||||
:alt: Clear Linux Compute Engine image is created
|
||||
|
||||
@@ -157,10 +158,10 @@ Setup |CL| VM on GCP
|
||||
|
||||
* Click the :guilabel:`Navigation menu` icon on the upper left screen menu.
|
||||
|
||||
* Select :menuselection:`Compute Engine --> VM Instances` from the side bar on
|
||||
the left.
|
||||
* Select :menuselection:`Compute Engine --> VM Instances` from the side bar
|
||||
on the left.
|
||||
|
||||
.. figure:: figures/gce/30-vm-instances.png
|
||||
.. figure:: /_figures/gce/30-vm-instances.png
|
||||
:scale: 50 %
|
||||
:alt: Go to VM instances catalog
|
||||
|
||||
@@ -172,13 +173,13 @@ Setup |CL| VM on GCP
|
||||
#. Alternatively, click the :guilabel:`CREATE INSTANCE` button on the VM
|
||||
instances page to create a VM instance.
|
||||
|
||||
.. figure:: figures/gce/30-vm-none.png
|
||||
.. figure:: /_figures/gce/30-vm-none.png
|
||||
:scale: 50 %
|
||||
:alt: Prompt for VM creation
|
||||
|
||||
Figure 13: VM creation
|
||||
|
||||
.. figure:: figures/gce/30-vm-catalog.png
|
||||
.. figure:: /_figures/gce/30-vm-catalog.png
|
||||
:scale: 50 %
|
||||
:alt: List of VM instances
|
||||
|
||||
@@ -189,7 +190,7 @@ Setup |CL| VM on GCP
|
||||
|
||||
* Under :guilabel:`Boot disk`, click the :guilabel:`Change` button.
|
||||
|
||||
.. figure:: figures/gce/30-create-vm.png
|
||||
.. figure:: /_figures/gce/30-create-vm.png
|
||||
:scale: 50 %
|
||||
:alt: Use custom image while creating Clear Linux VM instance
|
||||
|
||||
@@ -197,7 +198,7 @@ Setup |CL| VM on GCP
|
||||
|
||||
* Select the :menuselection:`Custom images` tab for using Clear Linux OS GCE image.
|
||||
|
||||
.. figure:: figures/gce/31-select-boot-disk.png
|
||||
.. figure:: /_figures/gce/31-select-boot-disk.png
|
||||
:scale: 50 %
|
||||
:alt: Select Clear Linux boot disk to create a VM instance
|
||||
|
||||
@@ -207,7 +208,7 @@ Setup |CL| VM on GCP
|
||||
expand the :guilabel:`Management, security, disks, networking, sole tenancy`
|
||||
group.
|
||||
|
||||
.. figure:: figures/gce/40-clear-vm-security.png
|
||||
.. figure:: /_figures/gce/40-clear-vm-security.png
|
||||
:scale: 50 %
|
||||
:alt: Clear Linux requires setting up SSH keys
|
||||
|
||||
@@ -222,7 +223,7 @@ Setup |CL| VM on GCP
|
||||
|
||||
* Click the :menuselection:`Security` tab, copy and paste your SSH public key:
|
||||
|
||||
.. figure:: figures/gce/40-ssh-key.png
|
||||
.. figure:: /_figures/gce/40-ssh-key.png
|
||||
:scale: 50 %
|
||||
:alt: Set SSH key for remote login
|
||||
|
||||
@@ -239,7 +240,7 @@ Setup |CL| VM on GCP
|
||||
|
||||
#. The Clear Linux VM instance is created and assigned a public IP address:
|
||||
|
||||
.. figure:: figures/gce/41-vm-created.png
|
||||
.. figure:: /_figures/gce/41-vm-created.png
|
||||
:scale: 50 %
|
||||
:alt: Clear Linux VM instance is created and started
|
||||
|
||||
@@ -248,7 +249,7 @@ Setup |CL| VM on GCP
|
||||
#. You can now SSH login to the VM using the IP address obtained in the
|
||||
previous step, and the username associated with the SSH public key:
|
||||
|
||||
.. figure:: figures/gce/42-ssh-vm.png
|
||||
.. figure:: /_figures/gce/42-ssh-vm.png
|
||||
:scale: 50 %
|
||||
:alt: SSH login to the Clear Linux VM
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _hyper-v:
|
||||
|
||||
Use Hyper-V\*
|
||||
#############
|
||||
|CL-ATTR| on Microsoft Hyper-V\*
|
||||
################################
|
||||
|
||||
This page explains how to run |CL-ATTR| inside a
|
||||
`Windows Server Virtualization`_\* or **Hyper-V** environment.
|
||||
@@ -64,5 +64,5 @@ Your virtual machine running |CL| is ready!
|
||||
.. _Install Hyper-V on Windows 10: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v
|
||||
.. _Create a virtual network: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network
|
||||
.. _Downloads: https://cdn.download.clearlinux.org/image/
|
||||
.. _Intel® Virtualization Technology: http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
|
||||
.. _Intel® Virtualization Technology for Directed I/O: https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices
|
||||
.. _`Intel® Virtualization Technology`: http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
|
||||
.. _`Intel® Virtualization Technology for Directed I/O`: https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _kvm:
|
||||
|
||||
Run |CL-ATTR| as a KVM guest OS
|
||||
###############################
|
||||
|CL-ATTR| on KVM
|
||||
################
|
||||
|
||||
This page explains how to run |CL-ATTR| in a virtualized environment using
|
||||
:abbr:`KVM (Kernel-based Virtual Machine)`.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _virtualbox-cl-installer:
|
||||
|
||||
Install a |CL-ATTR| VM in VirtualBox\*
|
||||
######################################
|
||||
|CL-ATTR| on VirtualBox\*
|
||||
#########################
|
||||
|
||||
This page explains how to create a virtual machine on the `VirtualBox`_
|
||||
hypervisor with |CL-ATTR| as the guest operating system. These instructions
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _vmw-player-preconf:
|
||||
|
||||
Run pre-configured |CL-ATTR| image as a VMware\* Workstation Player guest OS
|
||||
############################################################################
|
||||
|CL-ATTR| on VMware\* Workstation Player (pre-configured image)
|
||||
###############################################################
|
||||
|
||||
This page explains how to deploy a pre-configured |CL| VMware image on
|
||||
`VMware Workstation 14 Player`_.
|
||||
@@ -13,15 +13,16 @@ This page explains how to deploy a pre-configured |CL| VMware image on
|
||||
Overview
|
||||
********
|
||||
|
||||
VMware Workstation 14 Player is a type 2 hypervisor. It runs on top of
|
||||
another operating system such as Windows\* or Linux\*. With VMware ESXi, you
|
||||
can create, configure, manage, and run |CL-ATTR| :abbr:`VMs (Virtual Machines)`
|
||||
on your local system.
|
||||
VMware Workstation 14 Player is a type 2 hypervisor. For example, it runs on
|
||||
top of Windows\* or Linux\* operating system. With VMware ESXi, you
|
||||
can create, configure, manage, and run |CL-ATTR|
|
||||
:abbr:`VMs (Virtual Machines)` on your local system.
|
||||
|
||||
.. note::
|
||||
|
||||
Screenshots in this document show VMware Workstation 14 Player for Windows.
|
||||
Menus and prompts in the Linux version have minor wording differences.
|
||||
Screenshots in this document show VMware Workstation 14 Player for
|
||||
Windows. Menus and prompts in the Linux version have minor wording
|
||||
differences.
|
||||
|
||||
Install the VMware Workstation Player hypervisor
|
||||
************************************************
|
||||
@@ -59,22 +60,20 @@ For additional help, see the `VMware Workstation Player Documentation`_.
|
||||
Download the latest |CL| VMware image
|
||||
*************************************
|
||||
|
||||
Get the latest |CL| VMware image from the `image`_ repository.
|
||||
Get the latest |CL| VMware image from the `image repository`_.
|
||||
Look for :file:`clear-[version number]-vmware.vmdk.xz`. You can also use
|
||||
this command:
|
||||
this command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep vmware)
|
||||
|
||||
Visit :ref:`image-types` for additional information about all available |CL| images.
|
||||
Decompress and verify the image
|
||||
*******************************
|
||||
|
||||
.. include:: ../../guides/maintenance/download-verify-decompress.rst
|
||||
:Start-after: verify-windows:
|
||||
|
||||
We also provide instructions for other operating systems:
|
||||
|
||||
* :ref:`download-verify-decompress-linux`
|
||||
Visit :ref:`download-verify-decompress` and follow the instructions for your
|
||||
Windows\* or Linux\* environment. Visit :ref:`image-types` for additional
|
||||
information about all available |CL| images.
|
||||
|
||||
Create and configure a new VM
|
||||
*****************************
|
||||
@@ -303,6 +302,7 @@ For other guides on using the VMWare Player and ESXi, see:
|
||||
* :ref:`vmware-esxi-install-cl`
|
||||
* :ref:`vmware-esxi-preconfigured-cl-image`
|
||||
|
||||
.. _image repository: https://cdn.download.clearlinux.org/image/
|
||||
.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html
|
||||
.. _VMware Workstation 14 Player: https://www.vmware.com/products/workstation-player.html
|
||||
.. _VMware Workstation Player Documentation: https://docs.vmware.com/en/VMware-Workstation-Player/index.html
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _vmw-player:
|
||||
|
||||
Install |CL-ATTR| as a VMware\* Workstation Player guest OS
|
||||
###########################################################
|
||||
|CL-ATTR| on VMware\* Workstation Player
|
||||
########################################
|
||||
|
||||
This page explains how to create a new VM and install |CL| on it with the
|
||||
VMware Workstation Player hypervisor.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _vmware-esxi-install-cl:
|
||||
|
||||
Install |CL-ATTR| as a VMware\* ESXi guest OS
|
||||
#############################################
|
||||
|CL-ATTR| on VMware\* ESXi
|
||||
##########################
|
||||
|
||||
This page explains how to create a new :abbr:`VM (Virtual Machine)` and
|
||||
manually install |CL-ATTR| on the new VM with VMware ESXi 6.5.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _vmware-esxi-preconfigured-cl-image:
|
||||
|
||||
Run pre-configured |CL-ATTR| image as a VMware\* ESXi guest OS
|
||||
##############################################################
|
||||
|CL-ATTR| on VMware\* ESXi (pre-configured image)
|
||||
#################################################
|
||||
|
||||
This page explains how to deploy a pre-configured |CL| VMware
|
||||
:abbr:`VM (Virtual Machine)` image on a VMware ESXi 6.5 host.
|
||||
|
||||