instance_metadata.yaml

# Copyright 2017 Google Inc.
# 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.

# TODO(nelsonjr): Implement updating metadata *after* resource is created.

# Expose instance 'metadata' as a simple name/value pair hash. However the API
# defines metadata as a NestedObject with the following layout:
#
# metadata {
#   fingerprint: 'hash-of-last-metadata'
#   items: [
#     {
#       key: 'metadata1-key'
#       value: 'metadata1-value'
#     },
#     ...
#   ]
# }
#
# Fingerpint is an optimistic locking mechanism for updates, which requires
# adding the 'fingerprint' of the last metadata to allow update.
#
# To comply with the API please add an encoder: and decoder: to the provider.
- !ruby/object:Api::Type::NameValues
  name: 'metadata'
  description: |
    The metadata key/value pairs to assign to instances that are
    created from this template. These pairs can consist of custom
    metadata or predefined keys.
  key_type: Api::Type::String
  value_type: Api::Type::String