provisioning_configs

Creates, updates, deletes, gets or lists a provisioning_configs resource.

Overview

Name	provisioning_configs
Type	Resource
Id	google.baremetalsolution.provisioning_configs

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The system-generated name of the provisioning config. This follows the UUID format.
cloudConsoleUri	string	Output only. URI to Cloud Console UI view of this provisioning config.
customId	string	Optional. The user-defined identifier of the provisioning config.
email	string	Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
handoverServiceAccount	string	A service account to enable customers to access instance credentials upon handover.
instances	array	Instances to be created.
location	string	Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
networks	array	Networks to be created.
pod	string	Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
state	string	Output only. State of ProvisioningConfig.
statusMessage	string	Optional status messages associated with the FAILED state.
ticketId	string	A generated ticket id to track provisioning request.
updateTime	string (google-datetime)	Output only. Last update timestamp.
volumes	array	Volumes to be created.
vpcScEnabled	boolean	If true, VPC SC is enabled for the cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, provisioningConfigsId		Get ProvisioningConfig by name.
create	insert	projectsId, locationsId	email	Create new ProvisioningConfig.
patch	update	projectsId, locationsId, provisioningConfigsId	updateMask, email	Update existing ProvisioningConfig.
submit	exec	projectsId, locationsId		Submit a provisioning configuration for a given project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
provisioningConfigsId	string
email	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get ProvisioningConfig by name.

SELECT
name,
cloudConsoleUri,
customId,
email,
handoverServiceAccount,
instances,
location,
networks,
pod,
state,
statusMessage,
ticketId,
updateTime,
volumes,
vpcScEnabled
FROM google.baremetalsolution.provisioning_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND provisioningConfigsId = '{{ provisioningConfigsId }}' -- required;

INSERT examples

create

Create new ProvisioningConfig.

INSERT INTO google.baremetalsolution.provisioning_configs (
data__instances,
data__networks,
data__volumes,
data__ticketId,
data__handoverServiceAccount,
data__email,
data__location,
data__vpcScEnabled,
data__statusMessage,
data__customId,
data__pod,
projectsId,
locationsId,
email
)
SELECT 
'{{ instances }}',
'{{ networks }}',
'{{ volumes }}',
'{{ ticketId }}',
'{{ handoverServiceAccount }}',
'{{ email }}',
'{{ location }}',
{{ vpcScEnabled }},
'{{ statusMessage }}',
'{{ customId }}',
'{{ pod }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ email }}'
RETURNING
name,
cloudConsoleUri,
customId,
email,
handoverServiceAccount,
instances,
location,
networks,
pod,
state,
statusMessage,
ticketId,
updateTime,
volumes,
vpcScEnabled
;

Manifest

# Description fields are for documentation purposes
- name: provisioning_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the provisioning_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the provisioning_configs resource.
    - name: instances
      value: array
      description: >
        Instances to be created.
        
    - name: networks
      value: array
      description: >
        Networks to be created.
        
    - name: volumes
      value: array
      description: >
        Volumes to be created.
        
    - name: ticketId
      value: string
      description: >
        A generated ticket id to track provisioning request.
        
    - name: handoverServiceAccount
      value: string
      description: >
        A service account to enable customers to access instance credentials upon handover.
        
    - name: email
      value: string
      description: >
        Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
        
    - name: location
      value: string
      description: >
        Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
        
    - name: vpcScEnabled
      value: boolean
      description: >
        If true, VPC SC is enabled for the cluster.
        
    - name: statusMessage
      value: string
      description: >
        Optional status messages associated with the FAILED state.
        
    - name: customId
      value: string
      description: >
        Optional. The user-defined identifier of the provisioning config.
        
    - name: pod
      value: string
      description: >
        Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
        
    - name: email
      value: string

UPDATE examples

patch

Update existing ProvisioningConfig.

UPDATE google.baremetalsolution.provisioning_configs
SET 
data__instances = '{{ instances }}',
data__networks = '{{ networks }}',
data__volumes = '{{ volumes }}',
data__ticketId = '{{ ticketId }}',
data__handoverServiceAccount = '{{ handoverServiceAccount }}',
data__email = '{{ email }}',
data__location = '{{ location }}',
data__vpcScEnabled = {{ vpcScEnabled }},
data__statusMessage = '{{ statusMessage }}',
data__customId = '{{ customId }}',
data__pod = '{{ pod }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND provisioningConfigsId = '{{ provisioningConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
AND email = '{{ email}}'
RETURNING
name,
cloudConsoleUri,
customId,
email,
handoverServiceAccount,
instances,
location,
networks,
pod,
state,
statusMessage,
ticketId,
updateTime,
volumes,
vpcScEnabled;

Lifecycle Methods

submit

Submit a provisioning configuration for a given project.

EXEC google.baremetalsolution.provisioning_configs.submit 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"provisioningConfig": "{{ provisioningConfig }}", 
"email": "{{ email }}"
}';