gcp-metadata

Variables

• BASE_PATH
• GCE_LINUX_BIOS_PATHS
• gcpResidencyCache
• HEADER_NAME
• HEADER_VALUE
• HEADERS
• HOST_ADDRESS
• METADATA_SERVER_DETECTION
• SECONDARY_HOST_ADDRESS

Functions

• bulk()
• detectGCPResidency()
• getGCPResidency()
• instance()
• isAvailable()
• isGoogleCloudServerless()
• isGoogleComputeEngine()
• isGoogleComputeEngineLinux()
• isGoogleComputeEngineMACAddress()
• project()
• requestTimeout()
• resetIsAvailableCache()
• setGCPResidency()
• universe()

Interfaces

• MetadataAccessor

  • fastFail
  • headers
  • metadataKey
  • noResponseRetries
  • params
• Options

  • headers
  • params
  • property

Type Aliases

• BulkResults

variable BASE_PATH

const BASE_PATH: string;

• Copyright 2018 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

  http://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.

variable GCE_LINUX_BIOS_PATHS

const GCE_LINUX_BIOS_PATHS: { BIOS_DATE: string; BIOS_VENDOR: string };

• Known paths unique to Google Compute Engine Linux instances

variable gcpResidencyCache

let gcpResidencyCache: boolean;

• A cache for the detected GCP Residency.

variable HEADER_NAME

const HEADER_NAME: string;

variable HEADER_VALUE

const HEADER_VALUE: string;

variable HEADERS

const HEADERS: Readonly<{ 'Metadata-Flavor': 'Google' }>;

variable HOST_ADDRESS

const HOST_ADDRESS: string;

variable METADATA_SERVER_DETECTION

const METADATA_SERVER_DETECTION: Readonly<{
    'assume-present': "don't try to ping the metadata server, but assume it's present";
    none: "don't try to ping the metadata server, but don't try to use it either";
    'bios-only': "treat the result of a BIOS probe as canonical (don't fall back to pinging)";
    'ping-only': 'skip the BIOS probe, and go straight to pinging';
}>;

• Metadata server detection override options.

  Available via process.env.METADATA_SERVER_DETECTION.

variable SECONDARY_HOST_ADDRESS

const SECONDARY_HOST_ADDRESS: string;

function bulk

bulk: <
    T extends readonly Readonly<MetadataAccessor>[],
    R extends BulkResults<T> = BulkResults<T>
>(
    properties: T
) => Promise<R>;

• Retrieve metadata items in parallel.

  Parameter properties

  The metadata properties to retrieve

  Returns

  The metadata in metadatakey:value format

  Example 1

  const data = await bulk([
    {
      metadataKey: 'instance',
    },
    {
      metadataKey: 'project/project-id',
    },
  ] as const);
  
  // data.instance;
  // data['project/project-id'];

  See Also

  • https://cloud.google.com/compute/docs/metadata/predefined-metadata-keys

function detectGCPResidency

detectGCPResidency: () => boolean;

• Determines if the process is running on Google Cloud Platform.

  Returns

  {boolean} true if the process is running on GCP, false otherwise.

function getGCPResidency

getGCPResidency: () => boolean;

• Detects GCP Residency. Caches results to reduce costs for subsequent calls.

  See Also

  • setGCPResidency for setting

function instance

instance: <T = any>(options?: string | Options) => Promise<T>;

• Obtain metadata for the current GCE instance.

  Example 1

  const serviceAccount: {} = await instance('service-accounts/');
  const serviceAccountEmail: string = await instance('service-accounts/default/email');

  See Also

  • https://cloud.google.com/compute/docs/metadata/predefined-metadata-keys

function isAvailable

isAvailable: () => Promise<boolean>;

• Determine if the metadata server is currently available.

function isGoogleCloudServerless

isGoogleCloudServerless: () => boolean;

• Determines if the process is running on a Google Cloud Serverless environment (Cloud Run or Cloud Functions instance).

  Uses the: - . - .

  Returns

  {boolean} true if the process is running on GCP serverless, false otherwise.

function isGoogleComputeEngine

isGoogleComputeEngine: () => boolean;

• Determines if the process is running on a Google Compute Engine instance.

  Returns

  {boolean} true if the process is running on GCE, false otherwise.

function isGoogleComputeEngineLinux

isGoogleComputeEngineLinux: () => boolean;

• Determines if the process is running on a Linux Google Compute Engine instance.

  Returns

  {boolean} true if the process is running on Linux GCE, false otherwise.

function isGoogleComputeEngineMACAddress

isGoogleComputeEngineMACAddress: () => boolean;

• Determines if the process is running on a Google Compute Engine instance with a known MAC address.

  Returns

  {boolean} true if the process is running on GCE (as determined by MAC address), false otherwise.

function project

project: <T = any>(options?: string | Options) => Promise<T>;

• Obtain metadata for the current GCP project.

  Example 1

  const projectId: string = await project('project-id');
  const numericProjectId: number = await project('numeric-project-id');

  See Also

  • https://cloud.google.com/compute/docs/metadata/predefined-metadata-keys

function requestTimeout

requestTimeout: () => number;

• Obtain the timeout for requests to the metadata server.

  In certain environments and conditions requests can take longer than the default timeout to complete. This function will determine the appropriate timeout based on the environment.

  Returns

  {number} a request timeout duration in milliseconds.

function resetIsAvailableCache

resetIsAvailableCache: () => void;

• reset the memoized isAvailable() lookup.

function setGCPResidency

setGCPResidency: (value?: boolean | null) => void;

• Sets the detected GCP Residency. Useful for forcing metadata server detection behavior.

  Set null to autodetect the environment (default behavior).

  See Also

  • getGCPResidency for getting

function universe

universe: <T>(options?: string | Options) => Promise<T>;

• Obtain metadata for the current universe.

  Example 1

  const universeDomain: string = await universe('universe-domain');

  See Also

  • https://cloud.google.com/compute/docs/metadata/predefined-metadata-keys

type BulkResults

type BulkResults<T extends readonly MetadataAccessor[]> = {
    [key in T[number]['metadataKey']]: ReturnType<JSON['parse']>;
};