gcp_compute_instance_group_manager

all_instances_config

Type: STRUCT
Provider name: allInstancesConfig
Description: Specifies configuration that overrides the instance template configuration for the group.

• properties
  Type: STRUCT
  Provider name: properties
  Description: Properties to set on all instances in the group. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting allInstancesConfig on the group, you must update the group’s instances to apply the configuration. To apply the configuration, set the group’s updatePolicy.type field to use proactive updates or use the applyUpdatesToInstances method.
  

ancestors

Type: UNORDERED_LIST_STRING

auto_healing_policies

Type: UNORDERED_LIST_STRUCT
Provider name: autoHealingPolicies
Description: The autohealing policy for this managed instance group. You can specify only one value.

• health_check
  Type: STRING
  Provider name: healthCheck
  Description: The URL for the health check that signals autohealing.
  
• initial_delay_sec
  Type: INT32
  Provider name: initialDelaySec
  Description: The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM’s initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.
  

base_instance_name

Type: STRING
Provider name: baseInstanceName
Description: The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of “vm-###” results in “vm-001” as a VM name. @pattern a-z

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

current_actions

Type: STRUCT
Provider name: currentActions
Description: [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

• abandoning
  Type: INT32
  Provider name: abandoning
  Description: [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
  
• creating
  Type: INT32
  Provider name: creating
  Description: [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
  
• creating_without_retries
  Type: INT32
  Provider name: creatingWithoutRetries
  Description: [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group’s targetSize value accordingly.
  
• deleting
  Type: INT32
  Provider name: deleting
  Description: [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
  
• none
  Type: INT32
  Provider name: none
  Description: [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
  
• recreating
  Type: INT32
  Provider name: recreating
  Description: [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
  
• refreshing
  Type: INT32
  Provider name: refreshing
  Description: [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
  
• restarting
  Type: INT32
  Provider name: restarting
  Description: [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
  
• resuming
  Type: INT32
  Provider name: resuming
  Description: [Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.
  
• starting
  Type: INT32
  Provider name: starting
  Description: [Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.
  
• stopping
  Type: INT32
  Provider name: stopping
  Description: [Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.
  
• suspending
  Type: INT32
  Provider name: suspending
  Description: [Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.
  
• verifying
  Type: INT32
  Provider name: verifying
  Description: [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.
  

description

Type: STRING
Provider name: description
Description: An optional description of this resource.

distribution_policy

Type: STRUCT
Provider name: distributionPolicy
Description: Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

• target_shape
  Type: STRING
  Provider name: targetShape
  Description: The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).
  Possible values:
  
  • ANY - The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.
    
  • ANY_SINGLE_ZONE - The group creates all VM instances within a single zone. The zone is selected based on the present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads with heavy interprocess communication.
    
  • BALANCED - The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.
    
  • EVEN - The group schedules VM instance creation and deletion to achieve and maintain an even number of managed instances across the selected zones. The distribution is even when the number of managed instances does not differ by more than 1 between any two zones. Recommended for highly available serving workloads.
    
• zones
  Type: UNORDERED_LIST_STRUCT
  Provider name: zones
  Description: Zones where the regional managed instance group will create and manage its instances.
  
  • zone
    Type: STRING
    Provider name: zone
    Description: The URL of the zone. The zone must exist in the region where the managed instance group is located.
    

gcp_status

Type: STRUCT
Provider name: status
Description: [Output Only] The status of this managed instance group.

• all_instances_config
  Type: STRUCT
  Provider name: allInstancesConfig
  Description: [Output only] Status of all-instances configuration on the group.
  
  • current_revision
    Type: STRING
    Provider name: currentRevision
    Description: [Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.
    
  • effective
    Type: BOOLEAN
    Provider name: effective
    Description: [Output Only] A bit indicating whether this configuration has been applied to all managed instances in the group.
    
• autoscaler
  Type: STRING
  Provider name: autoscaler
  Description: [Output Only] The URL of the Autoscaler that targets this instance group manager.
  
• is_stable
  Type: BOOLEAN
  Provider name: isStable
  Description: [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
  
• stateful
  Type: STRUCT
  Provider name: stateful
  Description: [Output Only] Stateful status of the given Instance Group Manager.
  
  • has_stateful_config
    Type: BOOLEAN
    Provider name: hasStatefulConfig
    Description: [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
    
  • per_instance_configs
    Type: STRUCT
    Provider name: perInstanceConfigs
    Description: [Output Only] Status of per-instance configurations on the instances.
    
    • all_effective
      Type: BOOLEAN
      Provider name: allEffective
      Description: A bit indicating if all of the group’s per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.
      
• version_target
  Type: STRUCT
  Provider name: versionTarget
  Description: [Output Only] A status of consistency of Instances’ versions with their target version specified by version field on Instance Group Manager.
  
  • is_reached
    Type: BOOLEAN
    Provider name: isReached
    Description: [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances’ target version are specified by version field on Instance Group Manager.
    

id

Type: STRING
Provider name: id
Description: [Output Only] A unique identifier for this resource type. The server generates this identifier.

instance_flexibility_policy

Type: STRUCT
Provider name: instanceFlexibilityPolicy
Description: Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

instance_group

Type: STRING
Provider name: instanceGroup
Description: [Output Only] The URL of the Instance Group resource.

instance_lifecycle_policy

Type: STRUCT
Provider name: instanceLifecyclePolicy
Description: The repair policy for this managed instance group.

• default_action_on_failure
  Type: STRING
  Provider name: defaultActionOnFailure
  Description: The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM.
  Possible values:
  
  • DO_NOTHING - MIG does not repair a failed or an unhealthy VM.
    
  • REPAIR - (Default) MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG.
    
• force_update_on_repair
  Type: STRING
  Provider name: forceUpdateOnRepair
  Description: A bit indicating whether to forcefully apply the group’s latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group’s update policy. - YES: If configuration updates are available, they are applied during repair.
  Possible values:
  
  • NO
  • YES

instance_template

Type: STRING
Provider name: instanceTemplate
Description: The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group’s updatePolicy.type to PROACTIVE.

kind

Type: STRING
Provider name: kind
Description: [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

labels

Type: UNORDERED_LIST_STRING

list_managed_instances_results

Type: STRING
Provider name: listManagedInstancesResults
Description: Pagination behavior of the listManagedInstances API method for this managed instance group.
Possible values:

• PAGELESS - (Default) Pagination is disabled for the group’s listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response.
  
• PAGINATED - Pagination is enabled for the group’s listManagedInstances API method. maxResults and pageToken query parameters are respected.
  

name

Type: STRING
Provider name: name
Description: The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

named_ports

Type: UNORDERED_LIST_STRUCT
Provider name: namedPorts
Description: [Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

• name
  Type: STRING
  Provider name: name
  Description: The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
  
• port
  Type: INT32
  Provider name: port
  Description: The port number, which can be a value between 1 and 65535.
  

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

region

Type: STRING
Provider name: region
Description: [Output Only] The URL of the region where the managed instance group resides (for regional resources).

resource_name

Type: STRING

resource_policies

Type: STRUCT
Provider name: resourcePolicies
Description: Resource policies for this managed instance group.

• workload_policy
  Type: STRING
  Provider name: workloadPolicy
  Description: The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy
  

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: [Output Only] Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: [Output Only] Reserved for future use.

self_link

Type: STRING
Provider name: selfLink
Description: [Output Only] The URL for this managed instance group. The server defines this URL.

standby_policy

Type: STRUCT
Provider name: standbyPolicy
Description: Standby policy for stopped and suspended instances.

• initial_delay_sec
  Type: INT32
  Provider name: initialDelaySec
  Description: Specifies the number of seconds that the MIG should wait to suspend or stop a VM after that VM was created. The initial delay gives the initialization script the time to prepare your VM for a quick scale out. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.
  
• mode
  Type: STRING
  Provider name: mode
  Description: Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is MANUAL.
  Possible values:
  
  • MANUAL - MIG does not automatically resume or start VMs in the standby pool when the group scales out.
    
  • SCALE_OUT_POOL - MIG automatically resumes or starts VMs in the standby pool when the group scales out, and replenishes the standby pool afterwards.
    

stateful_policy

Type: STRUCT
Provider name: statefulPolicy
Description: Stateful configuration for this Instanced Group Manager

• preserved_state
  Type: STRUCT
  Provider name: preservedState
  

tags

Type: UNORDERED_LIST_STRING

target_pools

Type: UNORDERED_LIST_STRING
Provider name: targetPools
Description: The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

target_size

Type: INT32
Provider name: targetSize
Description: The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.

target_stopped_size

Type: INT32
Provider name: targetStoppedSize
Description: The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method.

target_suspended_size

Type: INT32
Provider name: targetSuspendedSize
Description: The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method.

update_policy

Type: STRUCT
Provider name: updatePolicy
Description: The update policy for this managed instance group.

• instance_redistribution_type
  Type: STRING
  Provider name: instanceRedistributionType
  Description: The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled.
  Possible values:
  
  • NONE - No action is being proactively performed in order to bring this IGM to its target instance distribution.
    
  • PROACTIVE - This IGM will actively converge to its target instance distribution.
    
• max_surge
  Type: STRUCT
  Provider name: maxSurge
  Description: The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
  
  • calculated
    Type: INT32
    Provider name: calculated
    Description: [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
    
  • fixed
    Type: INT32
    Provider name: fixed
    Description: Specifies a fixed number of VM instances. This must be a positive integer.
    
  • percent
    Type: INT32
    Provider name: percent
    Description: Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
    
• max_unavailable
  Type: STRUCT
  Provider name: maxUnavailable
  Description: The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance’s status is RUNNING. - If there is a health check on the instance group, the instance’s health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
  
  • calculated
    Type: INT32
    Provider name: calculated
    Description: [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
    
  • fixed
    Type: INT32
    Provider name: fixed
    Description: Specifies a fixed number of VM instances. This must be a positive integer.
    
  • percent
    Type: INT32
    Provider name: percent
    Description: Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
    
• minimal_action
  Type: STRING
  Provider name: minimalAction
  Description: Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes.
  Possible values:
  
  • NONE - Do not perform any action.
    
  • REFRESH - Do not stop the instance.
    
  • REPLACE - (Default.) Replace the instance according to the replacement method option.
    
  • RESTART - Stop the instance and start it again.
    
• most_disruptive_allowed_action
  Type: STRING
  Provider name: mostDisruptiveAllowedAction
  Description: Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
  Possible values:
  
  • NONE - Do not perform any action.
    
  • REFRESH - Do not stop the instance.
    
  • REPLACE - (Default.) Replace the instance according to the replacement method option.
    
  • RESTART - Stop the instance and start it again.
    
• replacement_method
  Type: STRING
  Provider name: replacementMethod
  Description: What action should be used to replace instances. See minimal_action.REPLACE
  Possible values:
  
  • RECREATE - Instances will be recreated (with the same name)
    
  • SUBSTITUTE - Default option: instances will be deleted and created (with a new name)
    
• type
  Type: STRING
  Provider name: type
  Description: The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update.
  Possible values:
  
  • OPPORTUNISTIC - MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.
    
  • PROACTIVE - MIG will automatically apply new configurations to all or a subset of existing VMs and also to new VMs that are added to the group.
    

versions

Type: UNORDERED_LIST_STRUCT
Provider name: versions
Description: Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

• instance_template
  Type: STRING
  Provider name: instanceTemplate
  Description: The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the targetSize for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group’s updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the targetSize for this version is reached.
  
• name
  Type: STRING
  Provider name: name
  Description: Name of the version. Unique among all versions in the scope of this managed instance group.
  
• target_size
  Type: STRUCT
  Provider name: targetSize
  Description: Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
  
  • calculated
    Type: INT32
    Provider name: calculated
    Description: [Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
    
  • fixed
    Type: INT32
    Provider name: fixed
    Description: Specifies a fixed number of VM instances. This must be a positive integer.
    
  • percent
    Type: INT32
    Provider name: percent
    Description: Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
    

zone

Type: STRING
Provider name: zone
Description: [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).