mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-08-26 18:36:02 +00:00
alexjch
266 lines
8.1 KiB
Plaintext
266 lines
8.1 KiB
Plaintext
.. _gce:
|
|
|
|
|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)`).
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
Prerequisites
|
|
*************
|
|
|
|
* Set up a Google account and a GCP billing account.
|
|
|
|
* Generate and install a user SSH key in the Linux PCs that will connect to
|
|
the VMs in GCP.
|
|
|
|
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
|
|
:scale: 50 %
|
|
:alt: Sign in to Google services
|
|
|
|
Figure 1: Google sign in screen
|
|
|
|
#. Google Cloud Platform uses **Projects** to manage resources.
|
|
Select or create a new project for hosting the |CL| VM.
|
|
|
|
.. note::
|
|
|
|
Refer to the
|
|
`Quickstart Using a Linux VM <https://cloud.google.com/compute/docs/quickstart-linux>`_
|
|
guide to learn about the process of creating VM instances on GCP.
|
|
|
|
#. Navigate to the latest |CL|
|
|
`release folder <https://download.clearlinux.org/releases/current/clear/>`_
|
|
to view the currently released :abbr:`GCE (Google Compute Engine\*)`
|
|
image, and download the :file:`clear-<release number>-gce.tar.gz`
|
|
image archive.
|
|
|
|
You don't need to uncompress the image archive, the intact file will
|
|
be uploaded to the Google Cloud Storage later.
|
|
|
|
#. Create a *Storage Bucket* for hosting the |CL| image source archive
|
|
downloaded in the previous step:
|
|
|
|
* 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.
|
|
|
|
.. figure:: /_figures/gce/01-cloud-storage.png
|
|
:scale: 50 %
|
|
:alt: Browse Google Cloud Storage
|
|
|
|
Figure 2: Browse Google Cloud Storage
|
|
|
|
.. note::
|
|
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
|
|
:scale: 50 %
|
|
:alt: Cloud Storage Browser tool
|
|
|
|
Figure 3: Cloud Storage Browser tool
|
|
|
|
* Click the :guilabel:`CREATE BUCKET` button to enter the bucket creation tool.
|
|
The bucket name must be unique because buckets in the Cloud Storage share
|
|
a single global namespace.
|
|
|
|
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
|
|
:scale: 50 %
|
|
:alt: Set a unique bucket name
|
|
|
|
Figure 4: Set bucket name
|
|
|
|
#. Once the bucket is created, click the :guilabel:`Upload files` button
|
|
on the Bucket details page to upload the |CL| GCE image archive
|
|
to the named bucket:
|
|
|
|
.. 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
|
|
:scale: 50 %
|
|
:alt: Uploading the image source archive file
|
|
|
|
Figure 6: Uploading the image source archive file
|
|
|
|
.. figure:: /_figures/gce/11-bucket-uploaded.png
|
|
:scale: 50 %
|
|
:alt: Image archive imported complete
|
|
|
|
Figure 7: Importing complete
|
|
|
|
#. Browse the Compute Engine Image library page:
|
|
|
|
* 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.
|
|
|
|
.. 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:
|
|
|
|
.. figure:: /_figures/gce/20-image-library.png
|
|
:scale: 50 %
|
|
:alt: Create a Google Compute Engine image
|
|
|
|
Figure 9: Create image
|
|
|
|
#. In the VM image creation page, change the image source type to
|
|
*Cloud Storage file*.
|
|
|
|
#. Under :guilabel:`Source`, select :guilabel:`Browse`.
|
|
|
|
#. Locate the :file:`clear-<release number>-gce.tar.gz` file,
|
|
and click :guilabel:`Select`.
|
|
|
|
.. figure:: /_figures/gce/21-create-image.png
|
|
:scale: 50 %
|
|
:alt: Create the image using the imported image archive object
|
|
|
|
Figure 10: Create image using imported object
|
|
|
|
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
|
|
:scale: 50 %
|
|
:alt: Clear Linux Compute Engine image is created
|
|
|
|
Figure 11: Image is created
|
|
|
|
#. After the |CL| image is imported, you can launch a VM instance running
|
|
|CL|:
|
|
|
|
* 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.
|
|
|
|
.. figure:: /_figures/gce/30-vm-instances.png
|
|
:scale: 50 %
|
|
:alt: Go to VM instances catalog
|
|
|
|
Figure 12: VM instances catalog
|
|
|
|
#. If no VM instance was created in this project, you will be prompted to
|
|
create one.
|
|
|
|
#. Alternatively, click the :guilabel:`CREATE INSTANCE` button on the VM
|
|
instances page to create a VM instance.
|
|
|
|
.. 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
|
|
:scale: 50 %
|
|
:alt: List of VM instances
|
|
|
|
Figure 14: VM instances list
|
|
|
|
* Under :guilabel:`Region`, choose a region based on the
|
|
`Best practices for Compute Engine regions selection`_.
|
|
|
|
* Under :guilabel:`Boot disk`, click the :guilabel:`Change` button.
|
|
|
|
.. figure:: /_figures/gce/30-create-vm.png
|
|
:scale: 50 %
|
|
:alt: Use custom image while creating Clear Linux VM instance
|
|
|
|
Figure 15: Use custom image
|
|
|
|
* Select the :menuselection:`Custom images` tab for using Clear Linux OS GCE image.
|
|
|
|
.. figure:: /_figures/gce/31-select-boot-disk.png
|
|
:scale: 50 %
|
|
:alt: Select Clear Linux boot disk to create a VM instance
|
|
|
|
Figure 16: Select Clear Linux boot disk to create a VM instance
|
|
|
|
* Scroll down to the bottom of the VM instance creation page,
|
|
expand the :guilabel:`Management, security, disks, networking, sole tenancy`
|
|
group.
|
|
|
|
.. figure:: /_figures/gce/40-clear-vm-security.png
|
|
:scale: 50 %
|
|
:alt: Clear Linux requires setting up SSH keys
|
|
|
|
Figure 17: Set up SSH keys
|
|
|
|
.. note::
|
|
|CL| does not allow SSH login with a root account by default.
|
|
As a result, you must configure the VM instance with your
|
|
SSH public key, so that you are able to access it remotely.
|
|
|
|
Refer to :ref:`security` for more details.
|
|
|
|
* Click the :menuselection:`Security` tab, copy and paste your SSH public key:
|
|
|
|
.. figure:: /_figures/gce/40-ssh-key.png
|
|
:scale: 50 %
|
|
:alt: Set SSH key for remote login
|
|
|
|
Figure 18: Set SSH key for remote login
|
|
|
|
.. note::
|
|
|
|
The username is assigned from characters preceding ``@`` in the email
|
|
address, included in the SSH key.
|
|
|
|
* Click the :guilabel:`Create` button to create the |CL| VM.
|
|
|
|
#. The Clear Linux VM instance is created and assigned a public IP address:
|
|
|
|
.. figure:: /_figures/gce/41-vm-created.png
|
|
:scale: 50 %
|
|
:alt: Clear Linux VM instance is created and started
|
|
|
|
Figure 19: Clear Linux VM instance is created and started
|
|
|
|
#. 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
|
|
:scale: 50 %
|
|
:alt: SSH login to the Clear Linux VM
|
|
|
|
Figure 20: SSH login to Clear Linux VM
|
|
|
|
Related topics
|
|
**************
|
|
|
|
* :ref:`azure`
|
|
* :ref:`aws-web`
|
|
* :ref:`clr-digitalocean`
|
|
|
|
.. _Google Cloud Platform: https://cloud.google.com/
|
|
|
|
.. _Best practices for Compute Engine regions selection: https://cloud.google.com/solutions/best-practices-compute-engine-region-selection
|