CentOS/RHEL/Rocky

Complete the steps for your CentOS/RHEL/Rocky version.

Debian

Complete the steps for your Debian version.

Ubuntu

1. Verify that your operating system versionis supported.

2. Enable the Universe repository. Canonical publishes packages for itsguest environment to theUniverse repository.

   sudo apt-add-repository universe

3. Update package lists:

   sudo apt update

4. Install the guest environment packages:

   sudo apt install -y google-compute-engine google-osconfig-agent

5. Restart the instance.Then,inspect its console log to ensure the guestenvironment loads as it starts back up.

6. Connect to the instance using SSH to verify. For detailed instructions,seeconnect to the instance using SSH.

SLES

1. Verify that your operating system versionis supported.

2. Activate thePublic Cloud Module

   product=$(sudo SUSEConnect --list-extensions | grep -o "sle-module-public-cloud.*")[[ -n "$product" ]] && sudo SUSEConnect -p "$product"

3. Update package lists:

   sudo zypper refresh

4. Install the guest environment packages:

   sudo zypper install -y google-guest-{agent,configs,oslogin} \google-osconfig-agentsudo systemctl enable /usr/lib/systemd/system/google-*

5. Restart the instance.Then,inspect its console log to ensure the guestenvironment loads as it starts back up.

6. Connect to the instance using SSH to verify. For detailed instructions,seeconnect to the instance using SSH.

Windows

Before you begin, verify that your operating system versionis supported.

To install theWindows guest environment, run the following commands in an elevated PowerShell version 3.0 or higher prompt. TheInvoke-WebRequest command requires PowerShell version 3.0 or higher.

1. Download and installGooGet.

   [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12;Invoke-WebRequest https://github.com/google/googet/releases/download/v2.18.3/googet.exe -OutFile $env:temp\googet.exe;& "$env:temp\googet.exe" -root C:\ProgramData\GooGet -noconfirm install -sources `https://packages.cloud.google.com/yuck/repos/google-compute-engine-stable googet;Remove-Item "$env:temp\googet.exe"

   During installation,GooGet adds content to the system environment. After installation completes, launch a new PowerShell console. Alternatively, provide the full path to thegooget.exe file (C:\ProgramData\GooGet\googet.exe).

2. Open a new console and add thegoogle-compute-engine-stable repository.

   googet addrepo google-compute-engine-stable https://packages.cloud.google.com/yuck/repos/google-compute-engine-stable

3. Install the core Windows guest environment packages.

   googet -noconfirm install google-compute-engine-windows `google-compute-engine-sysprep google-compute-engine-metadata-scripts `google-compute-engine-vss google-osconfig-agent

4. Install the optional Windows guest environment package.

   googet -noconfirm install google-compute-engine-auto-updater

   Using thegooget command.

   To view available packages, run thegooget available command.

   To view installed packages, run thegooget installed command.

   To update to the latest package version, run thegooget update command.

   To view additional commands, rungooget help.

CentOS/RHEL/Rocky

Complete the steps for your CentOS/RHEL/Rocky version.

Debian

1. Verify that your operating system versionis supported

2. Create a new instance toserve as the rescue instance. Name this instancerescue.This rescue instance does not need to run the same Linux OS asthe problematic instance. This example uses Debian 9 on the rescue instance.

3. Stop the problematic instance and create a copy of its boot disk.

   1. Set a variable name for the problematic instance. This variablesimplifies referencing the instance in later steps.

      export PROB_INSTANCE_NAME=VM_NAME

      ReplaceVM_NAME with the name of the problematicinstance.

   2. Stop the problematic instance.

      gcloud compute instances stop "$PROB_INSTANCE_NAME"

   3. Get the name of the boot disk for the problem instance.

      export PROB_INSTANCE_DISK="$(gcloud compute instances describe \"$PROB_INSTANCE_NAME" --format='json' |  jq -r \'.disks[] | select(.boot == true) | .source')"

   4. Create a snapshot of the boot disk.

      export DISK_SNAPSHOT="${PROB_INSTANCE_NAME}-snapshot"gcloud compute disks snapshot "$PROB_INSTANCE_DISK" \   --snapshot-names "$DISK_SNAPSHOT"

   5. Create a new disk from the snapshot.

      export NEW_DISK="${PROB_INSTANCE_NAME}-new-disk"gcloud compute disks create "$NEW_DISK" \   --source-snapshot="$DISK_SNAPSHOT"

   6. Delete the snapshot:

      gcloud compute snapshots delete "$DISK_SNAPSHOT"

4. Attach the new disk to the rescue instance and mount the root volumefor the rescue instance.Since this procedure attaches only one additional disk, the deviceidentifier of the new disk is/dev/sdb. Debian uses thefirst volume on a disk as the root volume by default; therefore, the volumeidentifier should be/dev/sdb1. For custom configurations, uselsblk todetermine the volume identifier.

   gcloud compute instances attach-disk rescue --disk "$NEW_DISK"

5. Connect to the rescue instance using SSH.

   gcloud compute ssh rescue

6. Run the following steps on the rescue instance.

   1. Mount the root volume of the new disk.

      export NEW_DISK_MOUNT_POINT="/tmp/sdb-root-vol"DEV="/dev/sdb1"sudo mkdir "$NEW_DISK_MOUNT_POINT"sudo mount "$DEV" "$NEW_DISK_MOUNT_POINT"

   2. Create therc.local script.

      cat<<'EOF' >/tmp/rc.local#!/bin/bashecho "== Installing Google guest environment for Debian =="export DEBIAN_FRONTEND=noninteractivesleep 30 # Wait for network.echo "Determining Debian version..."eval $(grep VERSION_CODENAME /etc/os-release)if [[ -z $VERSION_CODENAME ]]; then echo "ERROR: Could not determine Debian version." exit 1fiecho "Adding GPG key for Google cloud repo."curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add -echo "Updating repo file..."tee "/etc/apt/sources.list.d/google-cloud.list"<< EOMdeb http://packages.cloud.google.com/apt google-compute-engine-${VERSION_CODENAME}-stable maindeb http://packages.cloud.google.com/apt google-cloud-packages-archive-keyring-${VERSION_CODENAME} mainEOMecho "Running apt update..."apt updateecho "Installing packages..."for pkg in google-cloud-packages-archive-keyring google-compute-engine; do echo "Running apt install ${pkg}..." apt install -y ${pkg} if [[ $? -ne 0 ]]; then    echo "ERROR: Failed to install ${pkg}." fidoneecho "Removing this rc.local script."rm /etc/rc.local# Move back any previous rc.local:if [[ -f "/etc/moved-rc.local" ]]; then echo "Restoring a previous rc.local script." mv "/etc/moved-rc.local" "/etc/rc.local"fiecho "Restarting the instance..."rebootEOF

   3. Back up the existingrc.local file, move the temporaryrc.localscript into place on the mounted disk, then set its permission to beexecutable on boot. The temporary scriptreplaces the original script when it finishes booting. To do this,run the following command:

      if [[ -f "$NEW_DISK_MOUNT_POINT/etc/rc.local" ]]; then   sudo mv "$NEW_DISK_MOUNT_POINT/etc/rc.local" \   "$NEW_DISK_MOUNT_POINT/etc/moved-rc.local"fisudo mv /tmp/rc.local "$NEW_DISK_MOUNT_POINT/etc/rc.local"sudo chmod 0755 "$NEW_DISK_MOUNT_POINT/etc/rc.local"sudo chown root:root "$NEW_DISK_MOUNT_POINT/etc/rc.local"

   4. Un-mount the root volume of the new disk.

      sudo umount "$NEW_DISK_MOUNT_POINT" && sudo rmdir "$NEW_DISK_MOUNT_POINT"

   5. Exit the SSH session to the rescue instance.

7. Detach the new disk from the rescue instance.

   gcloud compute instances detach-disk rescue --disk "$NEW_DISK"

8. Create a new instance toserve as the replacement. When you create the replacement instance,specify the new disk as the boot disk. You can create the replacementinstance using the Google Cloud console:

   1. In the Google Cloud console, go to theVM instances page.

      Go to VM instances

   2. Click the problematic instance, then clickCreate similar.

   3. Specify a name for the replacement instance. In theBoot disksection, clickChange, then clickExisting Disks. Selectthe new disk.

   4. ClickCreate. The replacement instance automaticallystarts after it is created.

   As the replacement instance boots up, the temporaryrc.local scriptruns and installs the guest environment.To watch the progress of this script, inspect the console logs for linesemitted by the temporaryrc.local script. To view logs, run thefollowing command:

   gcloud compute instances get-serial-port-outputREPLACEMENT_VM_NAME

   ReplaceREPLACEMENT_VM_NAME with the name you assigned thereplacement instance.

   The replacement instance automatically reboots whenthe temporaryrc.local script finishes. During the secondreboot, you caninspect the console log to makesure the guest environment loads.

9. Verify that you canconnect to the instance using SSH.

   After you verify that the replacement instance is functional, youcanstop ordelete the problematic instance.

Ubuntu

1. Verify that your operating system versionis supported

2. Create a new instance toserve as the rescue instance. Name this instancerescue.This rescue instance does not need to run the same Linux OS asthe problematic instance. This example uses Debian 9 on the rescue instance.

3. Stop the problematic instance and create a copy of its boot disk.

   1. Set a variable name for the problematic instance. This variable simplifiesreferencing the instance in later steps.

      export PROB_INSTANCE_NAME=VM_NAME

      ReplaceVM_NAME with the name of the problematicinstance.

   2. Stop the problematic instance.

      gcloud compute instances stop "$PROB_INSTANCE_NAME"

   3. Get the name of the boot disk for the problem instance.

      export PROB_INSTANCE_DISK="$(gcloud compute instances describe \"$PROB_INSTANCE_NAME" --format='json' |  jq -r \'.disks[] | select(.boot == true) | .source')"

   4. Create a snapshot of the boot disk.

      export DISK_SNAPSHOT="${PROB_INSTANCE_NAME}-snapshot"gcloud compute disks snapshot "$PROB_INSTANCE_DISK" \   --snapshot-names "$DISK_SNAPSHOT"

   5. Create a new disk from the snapshot.

      export NEW_DISK="${PROB_INSTANCE_NAME}-new-disk"gcloud compute disks create "$NEW_DISK" \   --source-snapshot="$DISK_SNAPSHOT"

   6. Delete the snapshot:

      gcloud compute snapshots delete "$DISK_SNAPSHOT"

4. Attach the new disk to the rescue instance and mount the root volumefor the rescue instance.Since this procedure attaches only one additional disk, the deviceidentifier of the new disk is/dev/sdb. Ubuntu labels its root volume1 by default; therefore, the volume identifier should be*/dev/sdb*. Forcustom configurations, uselsblk to determine the volume identifier.

   gcloud compute instances attach-disk rescue --disk "$NEW_DISK"

5. Connect to the rescue instance using SSH.

   gcloud compute ssh rescue

6. Run the following steps on the rescue instance.

   1. Mount the root volume of the new disk.

      export NEW_DISK_MOUNT_POINT="/tmp/sdb-root-vol"DEV="/dev/sdb1"sudo mkdir "$NEW_DISK_MOUNT_POINT"sudo mount "$DEV" "$NEW_DISK_MOUNT_POINT"

   2. Create therc.local script.

      cat<<'EOF' >/tmp/rc.local#!/bin/bashecho "== Installing a Linux guest environment for Ubuntu =="sleep 30 # Wait for network.echo "Running apt update..."apt updateecho "Installing packages..."echo "Running apt install google-compute-engine..."apt install -y google-compute-engineif [[ $? -ne 0 ]]; then echo "ERROR: Failed to install ${pkg}."fiecho "Removing this rc.local script."rm /etc/rc.local# Move back any previous rc.local:if [[ -f "/etc/moved-rc.local" ]]; then echo "Restoring a previous rc.local script." mv "/etc/moved-rc.local" "/etc/rc.local"fiecho "Restarting the instance..."rebootEOF

   3. Back up the existingrc.local file, move the temporaryrc.localscript into place on the mounted disk, then set its permission to beexecutable on boot. The temporaryscript replaces the original script when it finishes booting. Todo this, run the following command:

      if [[ -f "$NEW_DISK_MOUNT_POINT/etc/rc.local" ]]; then   sudo mv "$NEW_DISK_MOUNT_POINT/etc/rc.local" \   "$NEW_DISK_MOUNT_POINT/etc/moved-rc.local"fisudo mv /tmp/rc.local "$NEW_DISK_MOUNT_POINT/etc/rc.local"sudo chmod 0755 "$NEW_DISK_MOUNT_POINT/etc/rc.local"sudo chown root:root "$NEW_DISK_MOUNT_POINT/etc/rc.local"

   4. Un-mount the root volume of the new disk.

      sudo umount "$NEW_DISK_MOUNT_POINT" && sudo rmdir "$NEW_DISK_MOUNT_POINT"

   5. Exit the SSH session to the rescue instance.

7. Detach the new disk from the rescue instance.

   gcloud compute instances detach-disk rescue --disk "$NEW_DISK"

8. Create a new instance toserve as the replacement. When you create the replacement instance,specify the new disk as the boot disk. You can create the replacementinstance using the Google Cloud console:

   1. In the Google Cloud console, go to theVM instances page.

      Go to VM instances

   2. Click the problematic instance, then clickCreate similar.

   3. Specify a name for the replacement instance. In theBoot disksection, clickChange, then clickExisting Disks. Selectthe new disk.

   4. ClickCreate. The replacement instance automaticallystarts after it is created.

   As the replacement instance boots up, the temporaryrc.local scriptruns and installs the guest environment.To watch the progress of this script, inspect the console logs for linesemitted by the temporaryrc.local script. To view logs, run thefollowing command:

   gcloud compute instances get-serial-port-outputREPLACEMENT_VM_NAME

   ReplaceREPLACEMENT_VM_NAME with the name you assignedthe replacement instance.

   The replacement instance automatically reboots whenthe temporaryrc.local script finishes. During the secondreboot, you caninspect the console log to makesure the guest environment loads.

9. Verify that you canconnect to the instance using SSH.

   After you verify that the replacement instance is functional, youcanstop ordeletethe problematic instance.

CentOS/RHEL/Rocky

To update CentOS, RHEL and Rocky Linux operating systems, run the followingcommands:

sudo yum makecachesudo yum install google-compute-engine google-compute-engine-oslogin \google-guest-agent google-osconfig-agent

Debian

To update Debian operating systems, run the following commands:

sudo apt updatesudo apt install google-compute-engine google-compute-engine-oslogin \google-guest-agent google-osconfig-agent

Ubuntu

To update Ubuntu operating systems, run the following commands:

sudo apt updatesudo apt install google-compute-engine google-compute-engine-oslogin \google-guest-agent google-osconfig-agent

SLES

To update SLES operating systems, run the following commands:

sudo zypper refreshsudo zypper install google-guest-{agent,configs,oslogin} \google-osconfig-agent

Windows

To update Windows operating systems, run the following command:

googet update

Console

1. In the Google Cloud console, go to theVM instances page.

   Go to VM instances

   1. Select the instance you need to examine.
   2. Restartorreset the instance.
   3. UnderLogs, clickSerial port 1 (console).
   4. Search for the expected output in the table that precedes thesesteps.

gcloud

1. Restartorreset the instance.

2. Use thegcloud compute instances get-serial-port-output sub-command toconnect using the Google Cloud CLI. For example:

   gcloud compute instances get-serial-port-outputVM_NAME

   ReplaceVM_NAME with the name of the instance you needto examine.

3. Search for the expected output in the table that precedes thesesteps.