detectors/gcp/gce.go

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package gcp

import (
	"context"
	"fmt"
	"regexp"
	"strings"

	"cloud.google.com/go/compute/metadata"
)

// See the available GCE instance metadata:
// https://cloud.google.com/compute/docs/metadata/predefined-metadata-keys#instance-metadata
const machineTypeMetadataAttr = "instance/machine-type"

// https://cloud.google.com/compute/docs/instance-groups/getting-info-about-migs#checking_if_a_vm_instance_is_part_of_a_mig
const createdByInstanceAttr = "created-by"

func (d *Detector) onGCE() bool {
	_, err := d.metadata.GetWithContext(context.TODO(), machineTypeMetadataAttr)
	return err == nil
}

// GCEHostType returns the machine type of the instance on which this program is running.
func (d *Detector) GCEHostType() (string, error) {
	return d.metadata.GetWithContext(context.TODO(), machineTypeMetadataAttr)
}

// GCEHostID returns the instance ID of the instance on which this program is running.
func (d *Detector) GCEHostID() (string, error) {
	return d.instanceID()
}

// GCEHostName returns the instance name of the instance on which this program is running.
// Recommended to use GCEInstanceName() or GCEInstanceHostname() to more accurately reflect which
// value is returned.
func (d *Detector) GCEHostName() (string, error) {
	return d.metadata.InstanceNameWithContext(context.TODO())
}

// GCEInstanceName returns the instance name of the instance on which this program is running.
// This is the value visible in the Cloud Console UI, and the prefix for the default hostname
// of the instance as defined by the default internal DNS name (see https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names).
func (d *Detector) GCEInstanceName() (string, error) {
	return d.metadata.InstanceNameWithContext(context.TODO())
}

// GCEInstanceHostname returns the full value of the default or custom hostname of the instance
// on which this program is running. See https://cloud.google.com/compute/docs/instances/custom-hostname-vm.
func (d *Detector) GCEInstanceHostname() (string, error) {
	return d.metadata.HostnameWithContext(context.TODO())
}

// GCEAvailabilityZoneAndRegion returns the zone and region in which this program is running.
func (d *Detector) GCEAvailabilityZoneAndRegion() (string, string, error) {
	zone, err := d.metadata.ZoneWithContext(context.TODO())
	if err != nil {
		return "", "", err
	}
	if zone == "" {
		return "", "", fmt.Errorf("no zone detected from GCE metadata server")
	}
	splitZone := strings.SplitN(zone, "-", 3)
	if len(splitZone) != 3 {
		return "", "", fmt.Errorf("zone was not in the expected format: country-region-zone.  Got %v", zone)
	}
	return zone, strings.Join(splitZone[0:2], "-"), nil
}

type ManagedInstanceGroup struct {
	Name     string
	Location string
	Type     LocationType
}

var createdByMIGRE = regexp.MustCompile(`^projects/[^/]+/(zones|regions)/([^/]+)/instanceGroupManagers/([^/]+)$`)

func (d *Detector) GCEManagedInstanceGroup() (ManagedInstanceGroup, error) {
	createdBy, err := d.metadata.InstanceAttributeValueWithContext(context.TODO(), createdByInstanceAttr)
	if _, ok := err.(metadata.NotDefinedError); ok {
		return ManagedInstanceGroup{}, nil
	} else if err != nil {
		return ManagedInstanceGroup{}, err
	}
	matches := createdByMIGRE.FindStringSubmatch(createdBy)
	if matches == nil {
		// The "created-by" key exists, but it doesn't describe a MIG.
		// Something else must have created this VM.
		return ManagedInstanceGroup{}, nil
	}

	mig := ManagedInstanceGroup{
		Name:     matches[3],
		Location: matches[2],
	}
	switch matches[1] {
	case "zones":
		mig.Type = Zone
	case "regions":
		mig.Type = Region
	}
	return mig, nil
}