Startup scripts for automation in GCP - Mini Project: Build & Apply

Startup scripts for automation

📖 Scenario: You are setting up a Google Cloud virtual machine (VM) that needs to automatically install and start a web server when it boots up. This automation saves time and ensures the server is ready without manual setup.

🎯 Goal: Create a startup script that installs the Apache web server and starts it automatically on a Google Cloud VM instance.

📋 What You'll Learn

Create a startup script variable with the exact shell commands to install Apache

Add a configuration variable to specify the Apache service name

Write the core logic to include the startup script in the VM instance metadata

Complete the VM instance creation with the startup script attached

💡 Why This Matters

🌍 Real World

Automating VM setup with startup scripts is common in cloud environments to save time and reduce manual errors when deploying servers.

💼 Career

Cloud engineers and DevOps professionals use startup scripts to automate instance configuration and ensure consistent environments.

1

Create the startup script variable

Create a variable called startup_script that contains the exact shell commands to update package lists, install Apache2, and start the Apache2 service using systemctl. Use the following commands exactly: sudo apt-get update -y, sudo apt-get install apache2 -y, and sudo systemctl start apache2 separated by semicolons.

GCP

# Create the startup_script variable with the exact commands
# Your code here

Hint

Use a single string with commands separated by semicolons.

2

Add the Apache service name configuration

Create a variable called apache_service and set it to the string "apache2" to specify the Apache service name.

GCP

startup_script = "sudo apt-get update -y; sudo apt-get install apache2 -y; sudo systemctl start apache2"
apache_service = ""  # Set the Apache service name here
# Your code here

Hint

Set the variable exactly as shown.

3

Add the startup script to VM instance metadata

Create a dictionary called instance_metadata with a key "startup-script" and set its value to the startup_script variable.

GCP

startup_script = "sudo apt-get update -y; sudo apt-get install apache2 -y; sudo systemctl start apache2"
apache_service = "apache2"
instance_metadata = {}  # Add startup-script key with startup_script value
# Your code here

Hint

Use a dictionary with the key exactly as "startup-script".

4

Complete VM instance creation with startup script

Create a dictionary called vm_instance with keys "name" set to "web-server", "machine_type" set to "n1-standard-1", and "metadata" set to the instance_metadata variable.

GCP

startup_script = "sudo apt-get update -y; sudo apt-get install apache2 -y; sudo systemctl start apache2"
apache_service = "apache2"
instance_metadata = {"startup-script": startup_script}
vm_instance = {}  # Define VM instance dictionary with name, machine_type, and metadata
# Your code here

Hint

Include all keys exactly as specified.

Practice

1. What is the main purpose of a startup script in a Google Cloud VM instance?

easy

A. To automate tasks when the VM boots

B. To manually start the VM

C. To create a new VM instance

D. To delete files from the VM

Solution

1. Step 1: Understand startup script role

   Startup scripts run automatically when a VM starts to perform tasks without manual intervention.

2. Step 2: Identify correct purpose

   Among the options, only automating tasks at boot matches the startup script function.

3. Final Answer:

   To automate tasks when the VM boots -> Option A

4. Quick Check:

   Startup script = automate tasks at boot [OK]

Hint: Startup scripts run automatically at VM boot time [OK]

Common Mistakes:

• Confusing startup scripts with manual commands
• Thinking startup scripts create or delete VMs
• Assuming startup scripts run after user login

2. Which command correctly adds a startup script to a new VM instance using gcloud CLI?

easy

A. gcloud compute instances create my-vm --metadata startup='echo Hello'

B. gcloud compute instances create my-vm --script-startup='echo Hello'

C. gcloud compute instances create my-vm --startup='echo Hello'

D. gcloud compute instances create my-vm --metadata startup-script='echo Hello'

Solution

1. Step 1: Recall correct flag for startup script

   The correct metadata key to add a startup script is 'startup-script'.

2. Step 2: Match command syntax

   gcloud compute instances create my-vm --metadata startup-script='echo Hello' uses '--metadata startup-script' correctly; others use invalid flags.

3. Final Answer:

   gcloud compute instances create my-vm --metadata startup-script='echo Hello' -> Option D

4. Quick Check:

   Use --metadata startup-script to add scripts [OK]

Hint: Use --metadata startup-script flag with gcloud create [OK]

Common Mistakes:

• Using incorrect flag names like --script-startup
• Confusing metadata keys with other flags
• Missing quotes around the script content

3. Given this startup script added to a VM:

#!/bin/bash
echo "Hello World" > /var/log/startup.log

What will happen when the VM boots?

medium

A. The VM will fail to boot due to script error

B. The file /var/log/startup.log will contain 'Hello World'

C. Nothing happens because echo is not allowed

D. The file /var/log/startup.log will be deleted

Solution

1. Step 1: Analyze the script commands

   The script writes the text 'Hello World' into the file /var/log/startup.log using echo and redirection.

2. Step 2: Understand script effect on boot

   Since startup scripts run as root, the file will be created or overwritten with the text.

3. Final Answer:

   The file /var/log/startup.log will contain 'Hello World' -> Option B

4. Quick Check:

   Startup script writes text to log file [OK]

Hint: Startup scripts run as root and can write files [OK]

Common Mistakes:

• Assuming echo command is blocked
• Thinking the file will be deleted instead of created
• Believing the VM will fail due to simple echo

4. You wrote this startup script:

#!/bin/bash
apt-get update
apt-get install nginx -y

But nginx is not installed after VM boots. What is the likely problem?

medium

A. The script lacks 'sudo' before commands

B. The script is missing the shebang line

C. The script runs before network is ready

D. The script should use 'yum' instead of 'apt-get'

Solution

1. Step 1: Check script commands and environment

   The script uses apt-get which requires network access to update and install packages.

2. Step 2: Identify timing issue

   Startup scripts may run before network is fully ready, causing apt-get to fail silently.

3. Final Answer:

   The script runs before network is ready -> Option C

4. Quick Check:

   Network must be ready before package install [OK]

Hint: Ensure network is ready before package installs in startup scripts [OK]

Common Mistakes:

• Adding sudo unnecessarily (scripts run as root)
• Ignoring network readiness in startup timing
• Using wrong package manager for Debian-based VM

5. You want to automate VM setup to install Apache, create a website folder, and start the service on boot. Which startup script snippet correctly achieves this?

hard

A. #!/bin/bash
apt-get update
apt-get install apache2 -y
mkdir /var/www/html
systemctl enable apache2
systemctl start apache2

B. #!/bin/bash
apt-get install apache2
mkdir /var/www/html
service apache2 stop

C. #!/bin/bash
apt-get update
apt-get install apache2 -y
mkdir -p /var/www/html
systemctl start apache2

D. #!/bin/bash
yum update -y
yum install apache2 -y
mkdir /var/www
systemctl restart apache2

Solution

1. Step 1: Verify package manager and commands

   For Debian-based VMs, apt-get is correct. Apache package is apache2. Creating /var/www/html is needed.

2. Step 2: Check service management commands

   #!/bin/bash apt-get update apt-get install apache2 -y mkdir /var/www/html systemctl enable apache2 systemctl start apache2 uses 'systemctl enable' to start Apache on boot and 'systemctl start' to start immediately, which is best practice.

3. Step 3: Compare other options

   #!/bin/bash apt-get update apt-get install apache2 -y mkdir -p /var/www/html systemctl start apache2 misses enabling service on boot. #!/bin/bash apt-get install apache2 mkdir /var/www/html service apache2 stop stops service instead of starting. #!/bin/bash yum update -y yum install apache2 -y mkdir /var/www systemctl restart apache2 uses yum (wrong for Debian).

4. Final Answer:

   #!/bin/bash apt-get update apt-get install apache2 -y mkdir /var/www/html systemctl enable apache2 systemctl start apache2 -> Option A

5. Quick Check:

   Enable and start service for automation [OK]

Hint: Enable and start services to run on boot in startup scripts [OK]

Common Mistakes:

• Forgetting to enable service to start on boot
• Using wrong package manager for the OS
• Stopping service instead of starting it