gcp-metadata
Get the metadata from a Google Cloud Platform environment.
$ npm install --save gcp-metadata
const gcpMetadata = require('gcp-metadata');
Check to see if the metadata server is available
const isAvailable = await gcpMetadata.isAvailable();
Access all metadata
const data = await gcpMetadata.instance();
console.log(data);
Access specific properties
const data = await gcpMetadata.instance('hostname');
console.log(data);
const projectId = await gcpMetadata.project('project-id');
console.log(projectId);
Access nested properties with the relative path
const data = await gcpMetadata.instance('service-accounts/default/email');
console.log(data);
Access specific properties with query parameters
const data = await gcpMetadata.instance({
property: 'tags',
params: { alt: 'text' }
});
console.log(data)
await gcpMetadata.instance({
headers: { 'no-trace': '1' }
});
Take care with large number valued properties
In some cases number valued properties returned by the Metadata Service may be
too large to be representable as JavaScript numbers. In such cases we return
those values as BigNumber
objects (from the bignumber.js library). Numbers
that fit within the JavaScript number range will be returned as normal number
values.
const id = await gcpMetadata.instance('id');
console.log(id)
console.log(id.toString())
Environment variables
- GCE_METADATA_HOST: provide an alternate host or IP to perform lookup against (useful, for example, you're connecting through a custom proxy server).
For example:
export GCE_METADATA_HOST = '169.254.169.254'
- DETECT_GCP_RETRIES: number representing number of retries that should be attempted on metadata lookup.