Skip to content

Latest commit

 

History

History

image

README.md

Instructions

This directory contains scripts for building a Google Cloud image for Knfsd.

We start with the base Google Cloud Ubuntu 22.04 image, and use the scripts in this directory to build the Knfsd Image.

For details of the modifications that are made to the base image, see resources/scripts/1_build_image.sh.

Customizing the image

If you need to customize the image (e.g. installing custom metric agents such as Metricbeat), then you can add any custom steps to the resources/scripts/8_custom.sh file.

Alternatively, if your build procedure is more complex, you can replace the customization step with your own process.

Ports

General

  • 80 - HTTP (knfsd-agent)

NFS v3

  • 111 - RPC portmapper
  • 2049 - NFS
  • 20048 - mountd
  • 20050 - nlm
  • 20051 - statd
  • 20052 - lockd

NFS v4

  • 2049 - NFS
  • 20053 - NFS v4 callback

Build Using Packer

Download Packer 1.7.8 or higher from https://packer.io/downloads.

Create Packer Variables File

Create a packer variables file (e.g. image.pkrvars.hcl).

Required

  • project (string) - GCP Project where the image will be built and stored.
  • zone (string) - The zone in which to launch the instance used to create the image. Example: "us-west1-a".

Optional

  • machine_type (string) - The machine type used to build the image. This can be increased to improve build speeds. Defaults to "c2-standard-16".
  • network_project (string) - Project hosting the network when using shared VPC. Defaults to project.
  • subnetwork (string) - The subnetwork the compute instance will use. Defaults to "default".
  • omit_external_ip (bool) - Use a private (internal) IP only. Defaults to false.
    • The subnetwork will require a NAT router in the region.
    • IAP tunnelling (default) or a VPN connection to the VPC network is required.
  • image_name (string) - The unique name of the resulting image. Defaults to "{image_family}-{timestamp}".
  • image_family (string) - The name of the image family to which the resulting image belongs. Defaults to "nfs-proxy".
  • image_storage_location (string) - Storage location, either regional or multi-regional, where snapshot content is to be stored. Defaults to a nearby regional or multi-regional location.
  • use_iap (bool) - Whether to use an IAP proxy. Defaults to true.
  • use_internal_ip (bool) - If true, use the instance's internal IP instead of its external IP during building. Defaults to true.
  • skip_create_image (bool) - Skip creating the image. Useful for setting to true during a build test stage. Defaults to false.

Example

project = "my-gcp-project"
zone    = "us-west1-a"

Run Packer Build

packer build -var-file image.pkrvars.hcl image

Run Smoke Tests

You can use the smoke test suite to verify the basic functionality of the image.

Build Manually

Navigate to Image Directory

cd image

Update settings in brackets <> below and set variables

export BUILD_MACHINE_NAME=knfsd-build-machine
export BUILD_MACHINE_TYPE=c2-standard-16
export BUILD_MACHINE_ZONE=<europe-west2-a>
export GOOGLE_CLOUD_PROJECT=<knfsd-deployment-test>
export BUILD_MACHINE_NETWORK=<knfsd-test>
export BUILD_MACHINE_SUBNET=<europe-west2-subnet>
export IMAGE_FAMILY=knfsd-proxy
export IMAGE_NAME="${IMAGE_FAMILY}-$(date -u +%F-%H%M%S)"

Create Build Machine

The default machine type is a c2-standard-16, if this is unavailable try changing the BUILD_MACHINE_TYPE to c2-standard-8 or e2-standard-16.

IMPORTANT: It is recommended not to change the disk boot-disk-size. The performance can increase but the image size will be larger and this will force any VMs to use the larger size drive.

gcloud compute instances create $BUILD_MACHINE_NAME \
    --zone=$BUILD_MACHINE_ZONE \
    --machine-type=$BUILD_MACHINE_TYPE \
    --project=$GOOGLE_CLOUD_PROJECT \
    --image=ubuntu-2204-jammy-v20221101a \
    --image-project=ubuntu-os-cloud \
    --network=$BUILD_MACHINE_NETWORK \
    --subnet=$BUILD_MACHINE_SUBNET \
    --boot-disk-size=50GB \
    --boot-disk-type=pd-ssd \
    --metadata=serial-port-enable=TRUE,block-project-ssh-keys=TRUE

(Optional) Create Firewall Rule for IAP SSH Access

gcloud compute firewall-rules create allow-ssh-ingress-from-iap --direction=INGRESS --action=allow --rules=tcp:22 --source-ranges=35.235.240.0/20 --network=$BUILD_MACHINE_NETWORK --project=$GOOGLE_CLOUD_PROJECT

Copy Resources to Build Machine

tar -czf resources.tgz -C resources .
gcloud compute scp resources.tgz build@$BUILD_MACHINE_NAME: --zone=$BUILD_MACHINE_ZONE --tunnel-through-iap --project=$GOOGLE_CLOUD_PROJECT

NOTE: You might get some errors when connecting while the instance is still booting. These errors will be generic network errors, or errors exchanging keys such as:

ERROR: (gcloud.compute.start-iap-tunnel) Error while connecting [4047: 'Failed to lookup instance'].

ERROR: (gcloud.compute.start-iap-tunnel) Error while connecting [4003: 'failed to connect to backend']. (Failed to connect to port 22)

SSH to Build Machine

gcloud compute ssh build@$BUILD_MACHINE_NAME --zone=$BUILD_MACHINE_ZONE --tunnel-through-iap --project=$GOOGLE_CLOUD_PROJECT

Run the Build Image Script

tar -zxf resources.tgz
sudo bash scripts/1_build_image.sh

When this script completes you should see:

SUCCESS: Please reboot for new kernel to take effect

Reboot Build Machine

Once the build image script has completed, check there were no errors and reboot the machine. This will restart the build machine with the new kernel.

sudo reboot

NOTE: When your Build Machine reboots, your Cloud Console will revert to your host machine.

SSH to Build Machine to run subsequent commands

gcloud compute ssh build@$BUILD_MACHINE_NAME --zone=$BUILD_MACHINE_ZONE --tunnel-through-iap --project=$GOOGLE_CLOUD_PROJECT

Validate Kernel Version

Verify that the build machine booted using the new kernel version.

uname -r

Output from above command should indicate kernel version 5.13.*-gcp.

Customize the image

If you have custom build steps, run them now.

If you have added your custom build steps to the 8_custom.sh script file, run:

sudo bash scripts/8_custom.sh

Finalize the Build Machine

This will clean up the local disk prior to creating the image (such as removing the build user).

Once the clean up is complete, the instance will shutdown.

sudo bash scripts/9_finalize.sh

You will get the following warnings, these can safely be ignored:

userdel: user build is currently used by process 1431
userdel: build mail spool (/var/mail/build) not found

On your Cloud Shell host machine, create the Custom Disk Image

gcloud compute images create $IMAGE_NAME --family=$IMAGE_FAMILY --source-disk=$BUILD_MACHINE_NAME --source-disk-zone=$BUILD_MACHINE_ZONE --project=$GOOGLE_CLOUD_PROJECT

Delete Build Machine

gcloud compute instances delete $BUILD_MACHINE_NAME --zone=$BUILD_MACHINE_ZONE --project=$GOOGLE_CLOUD_PROJECT