Documentation
¶
Overview ¶
Package metadata provides access to Google Compute Engine (GCE) metadata and API service accounts.
This package is a wrapper around the GCE metadata service, as documented at https://developers.google.com/compute/docs/metadata.
Index ¶
- func ExternalIP(ctx context.Context) (string, error)
- func Get(ctx context.Context, suffix string) (string, error)
- func Hostname(ctx context.Context) (string, error)
- func InstanceAttributeValue(ctx context.Context, attr string) (string, error)
- func InstanceAttributes(ctx context.Context) ([]string, error)
- func InstanceID(ctx context.Context) (string, error)
- func InstanceName(ctx context.Context) (string, error)
- func InstanceTags(ctx context.Context) ([]string, error)
- func InternalIP(ctx context.Context) (string, error)
- func NumericProjectID(ctx context.Context) (string, error)
- func OnGCE() bool
- func ProjectAttributeValue(ctx context.Context, attr string) (string, error)
- func ProjectAttributes(ctx context.Context) ([]string, error)
- func ProjectID(ctx context.Context) (string, error)
- func Scopes(ctx context.Context, serviceAccount string) ([]string, error)
- func Subscribe(ctx context.Context, suffix string, fn func(v string, ok bool) error) error
- func Zone(ctx context.Context) (string, error)
- type Client
- func (c Client) ExternalIP(ctx context.Context) (string, error)
- func (c Client) Get(ctx context.Context, suffix string) (string, error)
- func (c Client) Hostname(ctx context.Context) (string, error)
- func (c Client) InstanceAttributeValue(ctx context.Context, attr string) (string, error)
- func (c Client) InstanceAttributes(ctx context.Context) ([]string, error)
- func (c Client) InstanceID(ctx context.Context) (string, error)
- func (c Client) InstanceName(ctx context.Context) (string, error)
- func (c Client) InstanceTags(ctx context.Context) ([]string, error)
- func (c Client) InternalIP(ctx context.Context) (string, error)
- func (c Client) NumericProjectID(ctx context.Context) (string, error)
- func (c Client) ProjectAttributeValue(ctx context.Context, attr string) (string, error)
- func (c Client) ProjectAttributes(ctx context.Context) ([]string, error)
- func (c Client) ProjectID(ctx context.Context) (string, error)
- func (c Client) Scopes(ctx context.Context, serviceAccount string) ([]string, error)
- func (c Client) Subscribe(ctx context.Context, suffix string, fn func(v string, ok bool) error) error
- func (c Client) Zone(ctx context.Context) (string, error)
- type Error
- type NotDefinedError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExternalIP ¶
ExternalIP returns the instance's primary external (public) IP address.
func Hostname ¶
Hostname returns the instance's hostname. This will be of the form "<instanceID>.c.<projID>.internal".
func InstanceAttributeValue ¶
InstanceAttributeValue calls Client.InstanceAttributeValue on the default client.
func InstanceAttributes ¶
InstanceAttributes calls Client.InstanceAttributes on the default client.
func InstanceID ¶
InstanceID returns the current VM's numeric instance ID.
func InstanceName ¶
InstanceName returns the current VM's instance ID string.
func InstanceTags ¶
InstanceTags returns the list of user-defined instance tags, assigned when initially creating a GCE instance.
func InternalIP ¶
InternalIP returns the instance's primary internal IP address.
func NumericProjectID ¶
NumericProjectID returns the current instance's numeric project ID.
func OnGCE ¶
func OnGCE() bool
OnGCE reports whether this process is running on Google Compute Engine.
func ProjectAttributeValue ¶
ProjectAttributeValue calls Client.ProjectAttributeValue on the default client.
func ProjectAttributes ¶
ProjectAttributes calls Client.ProjectAttributes on the default client.
Types ¶
type Client ¶
A Client provides a client for retrieving metadata.
func NewClient ¶
NewClient returns a Client that can be used to fetch metadata. All HTTP requests will use the given http.Client instead of the default client.
func (Client) ExternalIP ¶
ExternalIP returns the instance's primary external (public) IP address.
func (Client) Get ¶
Get returns a value from the metadata service. The suffix is appended to "http://${GCE_METADATA_HOST}/computeMetadata/v1/".
If the GCE_METADATA_HOST environment variable is not defined, a default of 169.254.169.254 will be used instead.
If the requested metadata is not defined, the returned error will be of type NotDefinedError.
func (Client) Hostname ¶
Hostname returns the instance's hostname. This will be of the form "<instanceID>.c.<projID>.internal".
func (Client) InstanceAttributeValue ¶
InstanceAttributeValue returns the value of the provided VM instance attribute.
If the requested attribute is not defined, the returned error will be of type NotDefinedError.
InstanceAttributeValue may return ("", nil) if the attribute was defined to be the empty string.
func (Client) InstanceAttributes ¶
InstanceAttributes returns the list of user-defined attributes, assigned when initially creating a GCE VM instance. The value of an attribute can be obtained with InstanceAttributeValue.
func (Client) InstanceID ¶
InstanceID returns the current VM's numeric instance ID.
func (Client) InstanceName ¶
InstanceName returns the current VM's instance ID string.
func (Client) InstanceTags ¶
InstanceTags returns the list of user-defined instance tags, assigned when initially creating a GCE instance.
func (Client) InternalIP ¶
InternalIP returns the instance's primary internal IP address.
func (Client) NumericProjectID ¶
NumericProjectID returns the current instance's numeric project ID.
func (Client) ProjectAttributeValue ¶
ProjectAttributeValue returns the value of the provided project attribute.
If the requested attribute is not defined, the returned error will be of type NotDefinedError.
ProjectAttributeValue may return ("", nil) if the attribute was defined to be the empty string.
func (Client) ProjectAttributes ¶
ProjectAttributes returns the list of user-defined attributes applying to the project as a whole, not just this VM. The value of an attribute can be obtained with ProjectAttributeValue.
func (Client) Scopes ¶
Scopes returns the service account scopes for the given account. The account may be empty or the string "default" to use the instance's main account.
func (Client) Subscribe ¶
func (c Client) Subscribe(ctx context.Context, suffix string, fn func(v string, ok bool) error) error
Subscribe subscribes to a value from the metadata service. The suffix is appended to "http://${GCE_METADATA_HOST}/computeMetadata/v1/". The suffix may contain query parameters.
Subscribe calls fn with the latest metadata value indicated by the provided suffix. If the metadata value is deleted, fn is called with the empty string and ok false. Subscribe blocks until fn returns a non-nil error or the value is deleted. Subscribe returns the error value returned from the last call to fn, which may be nil when ok == false.
type Error ¶
type Error struct {
// Code is the HTTP response status code.
Code int
// Message is the server response message.
Message string
}
Error contains an error response from the server.
type NotDefinedError ¶
type NotDefinedError string
NotDefinedError is returned when requested metadata is not defined.
The underlying string is the suffix after "/computeMetadata/v1/".
This error is not returned if the value is defined to be the empty string.
func (NotDefinedError) Error ¶
func (suffix NotDefinedError) Error() string
Source Files