package cloud.deploymentmanager.autogen
Get desktop application:
View/edit binary Protocol Buffers messages
LINT.IfChange(gpuTypes)
Used in: ,
repeated string types = 1
One or more accelerator types. If the list contains exactly one item, the type will not be selectable by the user. Currently available types: nvidia-tesla-k80 nvidia-tesla-p100 nvidia-tesla-v100 nvidia-tesla-p100-vws nvidia-tesla-p4 nvidia-tesla-p4-vws nvidia-tesla-t4 nvidia-tesla-t4-vws nvidia-tesla-a100 nvidia-a100-80gb nvidia-l4 nvidia-l4-vws nvidia-h100-80gb
string default_type = 2
Default accelerator type, which should be one of those listed above
int32 default_count = 3
Default number of accelerators. Currently, only values of 0, 1, 2, 4, and 8 are supported.
int32 min_count = 4
Minimum number of accelerators (inclusive) that may be selected. Currently, only values of 0, 1, 2, 4, and 8 are supported.
int32 max_count = 5
Maximum number of accelerators (inclusive) that may be selected. Currently, only values of 0, 1, 2, 4, and 8 are supported.
Specifies how to monitor application installation status in order to detect when the application is ready or has failed. This is not supported for Terraform Autogen.
Used in: ,
ApplicationStatusSpec.StatusType type = 1
Defines how to monitor application installation status. Required.
optional waiter = 2
Required if type is `WAITER`.
Defines how to monitor application installation status.
Used in:
NONE = 0
LEGACY_DETECTOR = 1
Deprecated.
WAITER = 2
Uses runtime config waiter to block the deployment until the application finishes installing. Accompanied by WaiterSpec.
Specifies how the waiter is setup.
Used in:
int32 waiter_timeout_secs = 1
Timeout when the waiter fails itself in absence of status signals. Required.
optional script = 2
Optional integration with the VM to signal the waiter via startup-script. If the script spec is not present, the application is expected to directly signal the waiter.
Specifies the integration with the VM to signal the waiter via startup-script.
Used in:
int32 check_timeout_secs = 1
If not set, the waiter timeout will be used.
string check_script_content = 2
Optional bash script to check the status. This should return 0 if the application is ready, 1 if the application is not yet ready but the check should be retried, and greater than 1 if the check has failed permanently. If the script is not present, the waiter is signaled as soon as the VM finishes booting.
bool disable_startup_script_url = 3
If true, the generated template will include an empty "startup-script-url" VM metadata value. This effectively disables project-wide startup_script_url settings which took precedence over instance-level startup_script settings in older versions of the Google instance init logic. This option is not necessary for images that use Google base packages newer than June, 2016. See b/31729022 for more context. TODO(volkman): Remove this once all images (Brocade, etc.) have moved to the new base package version.
message
autogen.proto:201Used as an input for batch generating many deployment packages as once. See AutogenCli.
repeated solutions = 1
message
autogen.proto:207Used as an output of batch generating many deployment packages as once. See AutogenCli.
repeated solutions = 1
message
autogen.proto:208Used in:
string partner_id = 1
string solution_id = 2
optional package = 3
Allows to build an expression which value should be evaluated to boolean.
Used in: , ,
optional has_external_ip = 1
optional boolean_deploy_input_field = 2
Uses the value of a deploy input field of type boolean.
Used in:
string name = 1
Name of the deploy input field. Required.
bool negated = 2
If true, negate the value of the input field.
Allows to specify a condition based on external ip configuration for a single instance (for single vm) or all instances in a tier (multi vm).
Used in:
bool negated = 1
Specifies if expression is based on external IP being available or not.
string tier = 2
Multi-vm's tier name. It is required for multi vm spec.
Used in:
string name = 1
Name of the field. Letters, numbers, dashes, and underscores only. Required.
string title = 2
Title of the field. Required.
string description = 3
Optional description appearing below the title.
string tooltip = 4
Optional tooltip.
int32 level = 5
Indicates the "advanced" level of the input property. Level 0 (default) will always be shown. Level 1 corresponds to one expansion (user clicks "show advanced options" or "more options"). Higher levels correspond to further expansions, or they may be collapsed to level 1 by the UI implementation. Optional.
bool required = 6
If required, the user must input a valid value.
oneof type
boolean_checkbox = 101
grouped_boolean_checkbox = 102
integer_box = 103
integer_dropdown = 104
string_box = 105
string_dropdown = 106
zone_dropdown = 107
email_box = 108
A checkbox for a boolean value.
Used in:
bool default_value = 1
A specialized textbox for email addresses.
Used in:
string default_value = 1
optional validation = 2
string placeholder = 3
A placeholder to hint the user what to enter here. If not specified, user@example.com is used.
string test_default_value = 4
This attribute is used as field's value in automated tests. Defaults to default-user@example.com if this field is required unless the default_value or this field is explicitly present. If present, it overrides the `default_value`.
Used in:
string description = 1
Description shown to the user if the input value fails validation. If not specified, a default message is used.
string regex = 2
Optional pattern.
A dropdown with GCE zones as values.
Used in:
optional default_value = 1
A checkbox displayed next to other checkboxes under a common group title. The group is intended for display purposes only. This is not a radio group; the checkboxes are still independently selectable by the user. The first checkbox in the group should define the display_group. The immediately following GroupedBooleanCheckboxes without a display_group are part of such group. In other words, the group ends when either a different field type or one with a display_group is encountered.
Used in:
bool default_value = 1
optional display_group = 2
Used in:
string name = 1
Name of the group. Required. Convention is to use an UPPERCASE_UNDERSCORE name.
string title = 2
Title of the group. Required.
string description = 3
Optional description appearing below the title.
string tooltip = 4
Optional tooltip.
A textbox for entering an integer, with optional validation.
Used in:
optional default_value = 1
optional validation = 2
string placeholder = 3
optional test_default_value = 4
This attribute is used as field's value in automated tests. If present, it overrides the `default_value`. For required fields without `default_value`, it is required to set `test_default_value`.
Used in:
string description = 1
Description shown to the user if the input value fails validation.
optional min = 2
Optional inclusive minimum value.
optional max = 3
Optional inclusive maximum value.
A dropdown with integer values, with optional labels.
Used in:
repeated int32 values = 1
optional default_value_index = 2
map<int32, string> value_labels = 3
Optional labels for values (not indices). If a value does not have a corresponding label, its numeric string is used.
A textbox for entering a string, with optional validation.
Used in:
string default_value = 1
optional validation = 2
string placeholder = 3
string test_default_value = 4
This attribute is used as field's value in automated tests. If present, it overrides the `default_value`. For required fields without `default_value`, it is required to set `test_default_value`.
Used in:
string description = 1
Description shown to the user if the input value fails validation.
string regex = 2
Optional pattern.
A dropdown with string values, with optional labels.
Used in:
repeated string values = 1
optional default_value_index = 2
map<string, string> value_labels = 3
Optional labels for values. If a value does not have a corresponding label, its raw value will be displayed.
Used in:
DeployInputSection.Placement placement = 1
Required.
string name = 2
Section name, required if this section is a custom one. Must be unique among all sections. Convention is to use an UPPERCASE_UNDERSCORE name.
string tier = 7
For `Placement.TIER`, this specifies the required tier name.
string title = 3
Section title, required if this section is a custom one.
string description = 4
Optional description appearing below the title.
string tooltip = 5
Optional tooltip.
repeated fields = 6
Defines where this section should be placed.
Used in:
PLACEMENT_UNSPECIFIED = 0
MAIN = 1
The predefined untitled section that appears at the top. Image, zone, machine type fields are in this section. Custom fields will appear below the predefined ones. Only one such section can be defined.
CUSTOM_TOP = 2
A custom section sitting right below the main section. Sections of this type appear in the order they are defined.
CUSTOM_BOTTOM = 3
A custom section sitting after all other sections. Sections of this type appear in the order they are defined.
TIER = 4
In a multi-VM configuration, each VM tier has its own section. This placement enables adding input fields into a tier section.
Used in: ,
repeated sections = 1
One or more sections containing input fields.
Top level spec.
Used in:
oneof spec
single_vm = 1
For solution deploying a single VM.
multi_vm = 2
For solution deploying multiple tiers of VMs.
string version = 3
Human readable version of the deployment package.
DeploymentPackageAutogenSpec.DeploymentTool deployment_tool = 4
The deployment tool for which Autogen generates output. If unspecified, generates Deployment Manager template.
Used in:
DEPLOYMENT_TOOL_UNSPECIFIED = 0
DEPLOYMENT_MANAGER = 1
TERRAFORM = 2
Warning: Terraform Autogen is still in development.
message
autogen.proto:156Input for generating a deployment package. (== yamlExample # BEGIN Legacy field, required but will be removed in the future partnerId: my-partner-id solutionId: example-autogen-solution # END Legacy field, required but will be removed in the future solutionInfo: name: Autogen Solution Example packagedSoftwareGroups: - type: SOFTWARE_GROUP_OS components: - name: Ubuntu version: 16.04 LTS - components: - name: Apache version: 2.4.23 spec: version: 1.0 deploymentTool: TERRAFORM # multiVm option is also available singleVm: images: # if more than one image is provided, the user will be able to select which one they want - project: your-project-id-that-the-image-belongs-to name: name-of-your-image label: Label to show in the selection dropdown machineType: # Check http://cloud.google.com/compute/docs/machine-types for all available types defaultMachineType: gceMachineType: e2-standard-4 # Minimum CPU and memory constraints for the machine type to run your solution properly minimum: cpu: 2 ramGb: 4 bootDisk: # Describes the default and minimum disk size (GB) that user should have to run your solution properly diskSize: defaultSizeGb: 30 minSizeGb: 20 diskType: # For more information about disk types: http://cloud.google.com/compute/docs/reference/latest/diskTypes # Some types: pd-standard, local-ssd, pd-ssd defaultType: pd-standard # Defaults to Boot Disk displayLabel: My Boot Disk # Additional SSDs to be attached to you VM localSsds: count: 2 # Adds the option for the use to set IP forwarding when deploying this solution # More info: http://cloud.google.com/compute/docs/networking#eventualconsistency ipForwarding: defaultOff: true # List of firewall rules for this solution. If not specified, allowedSource will be set to PUBLIC by default # More details in deployment_package_autogen_spec.proto firewallRules: - protocol: TCP # Can be a range of ports, in the format 32768-40000 port: 80 # Rules to specify how to generate passwords passwords: # This password identifier that - metadataKey: my-password-1 length: 8 allowSpecialChars: true username: solutionuser # Label to describe the purpose of this password (will default to Admin in case only one password is provided) displayLabel: Admin gceStartupScript: bashScriptContent: echo SUCCESS > /var/log/startup-log.txt # Post deployment information that will be displayed to the user to actions upon postDeploy: # List of suggested action items for users, after deployment is successful actionItems: - heading: Log on now description: "Start using your application by accessing the following URL: https://www.google.com" snippet: $ some code snippets can go here, to show some examples - heading: Another label description: Another description showIf: # We make this action only show in the post deployment page if a boolean expression is satisfied # In this example, only if an input field (see deployInput sections below) in the DM config UI is selected booleanDeployInputField: name: booleanField1 # In the post deployment page we can show a table to expose some more details about the deployed solution infoRows: - label: Property 1 value: Value for property 1 - label: Property 2 # We can specify values from custom deploy input fields present in this spec valueFromDeployInputField: additionalEmail # Field describing the accelerators that can be attached to this VM. For now, only one acceleratorSpec is allowed accelerators: # List of available GPUs (user can only pick one type). This list is required. Types: https://cloud.google.com/compute/docs/gpus/ # Check the ids of the GPUs through GCP API: https://cloud.google.com/compute/docs/reference/latest/acceleratorTypes - types: - nvidia-tesla-k80 - nvidia-tesla-p100 defaultType: nvidia-tesla-p100 # Only values of 0, 1, 2, 4, and 8 are supported. defaultCount: 2 # Here we can specify extra input fields to be passed to the deployment manager deployInput: sections: # The place int he Deployment Manager config that this section will appear. More details in deployment_package_autogen_spec.proto - placement: MAIN name: idOfThisSection title: Title that will appear on top of this section description: This will appear below the title tooltip: Tooltip for this section # List of input fields that this section has fields: - required: true name: adminEmail title: Enter your e-mail here description: Some description to go below the title tooltip: Tooltipe for this input field emailBox: {} - required: false name: additionalEmail title: Additional email address emailBox: {} - required: name: booleanField1 title: Boolean checkbox used to tell whether our actionItem above should be displayed or not booleanCheckbox: {} ==)
Used in:
string partner_id = 1
The partner ID. Required.
string solution_id = 2
The solution ID. Required.
optional partner_info = 3
Partner marketing info. Optional.
optional solution_info = 4
Solution marketing info. Optional.
optional spec = 5
Autogen spec. Required.
optional logo = 6
Image to use as the logo. Optional.
optional icon = 7
Image to use as the icon. Optional.
optional architecture_diagram = 8
Image to use as the architecture diagram. Optional.
Specifies a persistent disk.
Used in: ,
optional disk_size = 1
optional disk_type = 2
string display_label = 4
A short descriptive label for this disk. Optional for boot disk; default is 'Boot disk'. Optional if this is the only one additional disk; default is 'Data disk'. Required otherwise.
optional device_name_suffix = 5
Specifies the device name suffix. Ignored for boot disk. Optional. The final device name will be a concatenation of an instance name with the specified device name.
bool prevent_auto_deletion = 6
Whether to leave the disk when the instance is deleted. Ignored for boot disk.
Used in:
oneof device_name
string name = 1
Device name specified as a constant string. Optional. By default takes the value of disk's name.
string name_from_deploy_input_field = 2
Specifies a deploy input field name from which the device name should be read.
Used in:
int32 default_size_gb = 1
The default disk size in GB. Required.
int32 min_size_gb = 2
Specifies the min disk size allowed in GB.
int32 max_size_gb = 3
Specifies the max disk size allowed in GB. Not supported yet.
bool not_configurable = 4
Whether to restrict the user from changing away from the default settings. Not supported yet (always false).
Used in:
string default_type = 1
The default disk type. Required. See http://cloud.google.com/compute/docs/reference/latest/diskTypes.
bool not_configurable = 2
Whether to restrict the user from changing away from the default settings. Not supported yet (always false).
Defines how a VM is exposed on the Internet.
Used in: , ,
ExternalIpSpec.Type default_type = 1
Required.
bool not_configurable = 2
Whether to restrict the user from changing away from the default settings.
How the VM is exposed on the Internet.
Used in:
TYPE_UNSPECIFIED = 0
NONE = 1
The VM is not accessible from the Internet.
EPHEMERAL = 2
The VM is accessible from the Internet with an ephemeral IP.
Specifies a firewall rule.
Used in: ,
FirewallRuleSpec.Protocol protocol = 1
The IP Protocol that the firewall rule allows. Required.
string port = 2
The target ports on the VM, which could be a single port number like "80" or a port range like "32768-40000".
bool default_off = 3
Specifies that by default it should be off. Applicable to `TrafficSource.PUBLIC` only.
bool not_configurable = 4
Whether to restrict the user from changing away from the default settings. Not supported yet (always false). Applicable to `TrafficSource.PUBLIC` only.
FirewallRuleSpec.TrafficSource allowed_source = 5
Source of traffic, wrapping range/tags with friendly enum. Defaults to `TrafficSource.PUBLIC`.
The IP Protocol that the firewall rule allows.
Used in:
PROTOCOL_UNSPECIFIED = 0
TCP = 1
UDP = 2
ICMP = 3
Description of network source.
Used in:
SOURCE_UNSPECIFIED = 0
Defaults to Public to keep backward compatibility.
PUBLIC = 1
Applies to traffic incoming from the internet, with default source range of 0.0.0.0/0 or configurable by end user. This rule can be enabled or disabled by end user.
TIER = 2
Applies to traffic between instances within a tier.
DEPLOYMENT = 3
Applies to traffic between all instances in the deployment.
Used in: ,
string key = 1
Metadata item key. Required.
oneof value_spec
string value = 2
Static metadata item value.
tier_vm_names = 3
The value is the names of one or more VMs in a tier.
string value_from_deploy_input_field = 4
Value referenced from deploy input field. Should specify existing input field's name.
Used in:
string tier = 1
The tier name.
oneof vm_selection_spec
int32 vm_index = 2
0-based index of a VM. A negative index can be used, with -1 referring the last, -2 the second last, etc.
all_vms = 3
All VM names as a string list.
Used in:
string delimiter = 1
Delimiter for the VM names in the list, for example a comma. Required.
Specifies the initial startup script for a VM instance.
Used in: ,
string bash_script_content = 1
Specifies a complete startup script. If waiter specifies its check script, those two will be combined with a software_status_script.py resource. Required.
Specifies access to an GCP API on the VM. This effectively configures the corresponding scope under the VM's service account.
Used in: ,
GcpAuthScopeSpec.Scope scope = 1
API scope. Required.
bool default_off = 2
Specifies that by default it should be off.
bool not_configurable = 3
Whether to restrict the user from changing away from the default settings. Not supported yet (always false).
API scope.
Used in:
SCOPE_UNSPECIFIED = 0
CLOUD_PLATFORM_READONLY = 1
https://www.googleapis.com/auth/cloud-platform.read-only
CLOUD_PLATFORM = 2
https://www.googleapis.com/auth/cloud-platform
COMPUTE_READONLY = 3
https://www.googleapis.com/auth/compute.readonly
COMPUTE = 4
https://www.googleapis.com/auth/compute
SOURCE_READ_WRITE = 5
https://www.googleapis.com/auth/source.read_write
PROJECTHOSTING = 6
https://www.googleapis.com/auth/projecthosting
message
autogen.proto:179Describes an image to be generated into the deployment package, or a reference to one.
Used in:
optional raw = 1
The image bytes are supplied directly.
string description = 2
message
autogen.proto:181Provides the raw bytes and type of the image.
Used in:
RawImage.ContentType content_type = 1
Content type of the image bytes. Required.
bytes content = 2
Raw binary bytes of the image. Required.
Used in:
CONTENT_TYPE_UNSPECIFIED = 0
PNG = 1
JPEG = 2
Specifies a disk image resource.
Used in: ,
string project = 1
The GCP project containing the image. Required.
string name = 2
The name of the image. Required.
string label = 3
A descriptive label for this image, useful in a list of images for the user to select from.
Specifies a URL used for accessing the application on the VM. The domain is implied as the VM instance address. Currently the machine IP is used, but that might change to another endpoint in the future.
Used in: ,
InstanceUrlSpec.Scheme scheme = 1
The URL scheme.
int32 port = 2
The URL port.
string path = 3
The URL path, without the leading forward slash.
string query = 4
The URL query, without the leading question mark.
string fragment = 5
The URL fragment, without the leading hash sign.
optional tier_vm = 6
Specifies a VM from tier whose address would be used. Required in a multi-VM configuration.
The URL scheme. Required.
Used in:
SCHEME_UNSPECIFIED = 0
HTTP = 1
HTTPS = 2
Used in:
repeated int32 values = 1
Used in:
int32 start_value = 1
The inclusive starting value. Required.
int32 end_value = 2
The inclusive ending value. Required.
Specifies if the VM can route IP packets. See http://cloud.google.com/compute/docs/networking#eventualconsistency.
Used in: ,
bool default_off = 1
Specifies that by default it should be off.
bool not_configurable = 2
Whether to restrict the user from changing away from the default settings. Not supported yet (always false).
message
marketing_info.proto:148Used in:
string url = 1
The URL, for example for a video, website, pdf etc. Url (max length: 2047) Required.
string title = 2
The title for the link. Plain text (length min:1, max: 40). Required.
string description = 3
The description for the link. Plain text (length min:1, max: 80). Optional.
repeated LinkInfo.DestinationType destinations = 4
Destinations where the link is to be displayed. Optional.
LinkInfo.LinkType type = 5
Type of link. Optional.
Defines the destinations where the link is to be displayed.
Used in:
DESTINATION_TYPE_UNSPECIFIED = 0
Unspecified destination.
DESTINATION_SOLUTION_DETAILS = 1
Solution details page.
DESTINATION_CONFIGURATION = 2
Configuration page.
DESTINATION_POST_DEPLOY = 3
Post deployment page.
DESTINATION_SOLUTION_CALL_TO_ACTION = 4
Call-to-action area.
Defines the link types.
Used in:
LINK_GENERAL = 0
General URL.
LINK_VIDEO = 1
Video link. Currently only youtube video links are supported.
Used in: ,
oneof count_spec
int32 count = 1
Specifies the number of local SSDs to be attached to a vm instance.
string count_from_deploy_input_field = 2
Specifies the number of local SSDs by referencing a value from a deploy input field.
Specifies the default machine type, and any size constraints which restrict what the user can select.
Used in: ,
optional default_machine_type = 1
Specifies the machine type that should be selecteed by default. Required.
optional minimum = 2
Specifies the minimum requirement for a user-selected machine type.
optional maximum = 3
Specifies the minimum requirement for a user-selected machine type. Not supported yet (no max).
bool not_configurable = 4
Whether to restrict the user from changing away from the default settings. Not supported yet (always false).
Specifies a machine type.
Used in:
string gce_machine_type = 1
A predefined or custom machine type. Required. See http://cloud.google.com/compute/docs/machine-types.
Specifies an upper- or lower-bound constraint.
Used in:
int32 cpu = 1
float ram_gb = 2
Specifies a solution that deploys Multiple VMs. Next ID: 9 (== yamlExample partnerId: my-partner-id solutionId: example-autogen-solution spec: multiVm: siteUrl: scheme: HTTP tierVm: tier: debian tiers: - name: debian title: Debian 10 firewallRules: - port: "80" protocol: TCP allowedSource: PUBLIC images: - name: debian-10-buster-v20191210 project: debian-cloud instanceCount: defaultValue: 3 range: startValue: 1 endValue: 12 gceStartupScript: bashScriptContent: |- apt-get update apt-get install -y apache2 cat <<EOF > /var/www/html/index.html <html><body><h1>Hello World</h1> <p>This page was created from a simple startup script!</p> </body></html> ==)
Used in:
repeated tiers = 1
One or more tiers.
optional site_url = 2
Declares a URL to access the deployed application.
optional admin_url = 3
Declares a URL to administer the deployed application.
repeated passwords = 4
Defines how to generate passwords at deployment time.
optional post_deploy = 5
Customizes post-deploy information displayed to the user. This helps get the user started with using the deployed solution.
optional deploy_input = 6
Customizes additional inputs configured by user prior to deployment. Currently, the configured values can be passed through to the VM via metadata items.
optional zone = 7
Customizes the zone selector.
optional stackdriver = 8
Integration with Stackdriver.
Network interfaces configuration for this solution.
Used in: ,
int32 min_count = 2
Minimum number of Network Interfaces (defaults to 1).
int32 max_count = 3
Maximum number of Network Interfaces (can't exceed 8 and if not specified, will take the value of min_count).
optional external_ip = 5
repeated string labels = 6
Label that will be in front of each Network Interface (according to the index in this list). If the list is greater than min_count, the last label will be used to name all networks added beyond min_count.
Used in: , , ,
int32 value = 1
Used in:
string value = 2
message
marketing_info.proto:106Describes a software group packaged in a deployable solution.
Used in:
PackagedSoftwareGroup.SoftwareGroupType type = 1
Software group type. Optional.
repeated components = 2
List of software components of this type. Required.
message
marketing_info.proto:119Defines the component of a software group.
Used in:
string name = 1
The name for the software component. Plain text (length min:1, max: 30). Required.
string version = 2
Version. Plain text (length min:1, max: 16). Optional.
string url = 3
Link to development site or marketing page for this software component. Url (max length: 2047). Optional.
string license_title = 4
License title. Optional.
string license_url = 5
License url. Optional.
Defines the type for the software group.
Used in:
SOFTWARE_GROUP_TYPE_UNSPECIFIED = 0
Unspecified.
SOFTWARE_GROUP_OS = 1
OS software group.
message
marketing_info.proto:24Marketing information provided by a partner.
Used in:
string name = 1
Name displayed to customers. Plain text (length min: 1, max: 128). Required.
string description = 2
Description of partner. Plain text (length min: 1, max: 2048). Required.
string url = 3
Url to Partner's site. Url (max length: 2047). Optional.
string short_description = 4
Short description of the partner. Plain text (length min: 1, max: 300). Required.
Specifies a generated password and username combination.
Used in: ,
string metadata_key = 1
Specifies the name of the metadata entry, whose value contains the generated password, accessible to the VM. Must be unique per password spec in the same package spec. Required.
int32 length = 2
The length of the generated password. Required.
bool allow_special_chars = 3
Whether special characters should be included in the generated password.
oneof username_spec
string username = 4
Specifies a static username accompanying this password.
string username_from_deploy_input_field = 6
Specifies that the username should come from a deploy input field whose name is specified here.
string display_label = 5
A label describing the purpose of this username/password. Required, unless this is the only password, in which case the label defaults to "Admin".
optional generate_if = 7
Specifies a condition to decide if password should be generated or not. Optional. If it is not specified, the password is generated.
Customizes post-deploy information displayed to the user. This information helps get the user started with using the deployed solution.
Used in: ,
repeated action_items = 1
repeated info_rows = 2
string connect_button_label = 3
Optional label to use for the button that connects to the VM. Deprecated in favor of `ConnectToInstanceSpec.displayLabel`.
optional connect_button = 4
Specifies an action item for the user to take. Text content fields can either contain non-localized en-US text or a reference (e.g. @ACTION_1_HEADING) into a localized text file. The latter is not yet implemented, so only en-US text for now.
Used in:
string heading = 1
Summary heading for the item. UTF-8 text. No markup. At most 64 characters. Required.
string description = 2
Longer description of the item. UTF-8 text. HTML <code><a href></code> tags only. At most 512 characters. Optional. At least one of description or snippet is required.
string snippet = 3
Fixed-width formatted code snippet. Accepts string expressions. UTF-8 text. No markup. At most 512 characters. Optional. At least one of description or snippet is required.
optional show_if = 4
Specify the condition to display this action item. Optional.
Specifies a connect button configuration.
Used in:
optional tier_vm = 1
Specifies a VM from tier whose address would be used. Required in a multi-vm configuration. Mustn't be specified for a single-vm.
string display_label = 2
Optional label to use for the button that connects to the VM.
Specifies a row in the application info table. Text content fields can either contain non-localized en-US text or a reference (e.g. @ROW_1_HEADING) into a localized text file. The latter is not yet implemented, so only en-US text for now.
Used in:
string label = 1
Row label. Required. Accepts string expressions. UTF-8 text. No markup. At most 64 characters.
oneof value_spec
Required.
string value = 2
Row value. Accepts string expressions. UTF-8 text. HTML <code><a href></code> tags only. At most 128 characters.
string value_from_deploy_input_field = 4
Row value referenced from deploy input field. Should specify existing input field's name.
optional show_if = 3
Specify the condition to display this row. Optional.
Specifies a solution that deploys a single VM. Next ID: 22 (== yamlExample partnerId: my-partner-id solutionId: example-autogen-solution spec: singleVm: siteUrl: scheme: HTTP firewallRules: - port: "80" protocol: TCP images: - name: debian-10-buster-v20191210 project: debian-cloud gceStartupScript: bashScriptContent: |- apt-get update apt-get install -y apache2 cat <<EOF > /var/www/html/index.html <html><body><h1>Hello World</h1> <p>This page was created from a simple startup script!</p> </body></html> ==)
Used in:
repeated images = 1
Defines the disk images. If there are more than one, the user can select which image to deploy with. The 1st image is the default. Required.
optional machine_type = 2
Specifies the default machine type, and any size constraints which restrict what the user can select. Will use defaults if not specified.
optional boot_disk = 3
Defines boot disk. Will use defaults if not specified.
optional local_ssds = 17
Specifies additionally added local SSD disks (with a default naming convention).
repeated additional_disks = 16
Defines additional persistent disks. Optional.
optional ip_forwarding = 4
If not specified, IP forwarding is forced off and not user-configurable.
optional network_interfaces = 21
Spec to define Multi/Single NIC(s) usage for this solution.
repeated firewall_rules = 5
Specifies the default firewall rules to access the deployed application. They could be off by default, but should still be listed so that the user can get instructions on how to enable them post-deployment.
optional site_url = 6
Declares a URL to access the deployed application.
optional admin_url = 7
Declares a URL to administer the deployed application.
repeated passwords = 8
Defines how to generate passwords at deployment time.
repeated gcp_auth_scopes = 9
Declares what GCP APIs should be available to the VM.
optional gce_startup_script = 18
Specifies a startup script for a VM instance.
optional application_status = 10
Defines how to determine the application installation status in post-deployment. This tells when the application is ready for consumption. This is not supported for Terraform Autogen.
optional external_ip = 11
Defines how the VM is accessible from the Internet. Will use defaults if not specified. DEPRECATED! Use NetworkInterfacesSpec instead.
optional post_deploy = 12
Customizes post-deploy information displayed to the user. This helps get the user started with using the deployed solution.
repeated gce_metadata_items = 13
Customizes metadata items on a GCE VM instance.
repeated accelerators = 14
Attach accelerator hardware (GPU) to the VM. Currently at most one accelerator spec is supported.
optional deploy_input = 15
Customizes additional inputs configured by user prior to deployment. Currently, the configured values can be passed through to the VM via metadata items.
optional zone = 19
Customizes the zone selector.
optional stackdriver = 20
Integration with Stackdriver.
message
marketing_info.proto:47Publicly visible marketing information pertaining to a solution.
Used in:
string name = 1
Name of the solution that is displayed to the end user. Plain text (length min: 1, max: 64). Required.
string version = 2
Version text for the solution that is displayed to the end user. Plain text (length min: 1, max: 64). Required.
string description = 3
Description of the solution that is displayed to the user in the UI. Html (length min: 1, max: 2048; <p>, <b>, <i>, <a href> and list tags). Required.
string url = 4
Link to an external marketing site describing this solution. Url (max length: 2047). Optional.
string tagline = 5
A short description of the solution displayed to the end user. Plain text (length min: 1, max: 100). Optional.
string support_url = 6
Link to a page providing support for this solution. This is treated as the primary means of getting support and displayed prominently. URL may contain a template of format {external_account_id} that will be replaced by a valid end user identifier for providing support validation. Url (max length: 2047). Optional.
string support_info = 7
A description of the support provided for this solution. Html (length min: 1, max: 2048; <p>, <b>, <i>, <a href> and list tags). Required.
string eula_url = 8
Link to the end user license agreement. Url (max length: 2047). Optional.
repeated documentations = 9
A list of documentation and video links for the solution. At most one youtube video link can be provided. Optional.
repeated packaged_software_groups = 10
A list of software groups packaged with the solution. Optional.
bool show_support_id = 11
True to show the customer's support ID in the post-deploy UI. Optional.
message
autogen.proto:216Used in:
repeated files = 1
The full set of files within the [SolutionPackage][].
message
autogen.proto:218Represents a file entry in the [SolutionPackage][].
Used in:
string path = 1
The relative path of the file within the [SolutionPackage][].
string content = 2
The contents of the file. Binary data gets encoded with Base64.
Used in: ,
optional logging = 1
Shows a checkbox that enable Stackdriver Logging.
optional monitoring = 2
Shows a checkbox that enable Stackdriver Monitoring.
Used in:
bool default_on = 1
Specifies that by default it should be on.
Used in:
bool default_on = 1
Specifies that by default it should be on.
Identifies a specific VM in a tier.
Used in: ,
string tier = 1
Name of the tier.
int32 index = 2
0-based index of the VM in the tier. A negative index can be used, with -1 referring the last, -2 the second last, etc.
A tier consists of one or more VMs of the same type. Each VM is uniquely identified by its index. Next ID: 18
Used in:
string name = 1
Unique name for this tier. Only lowercases. Required.
string title = 2
Display title for this tier. Required.
optional instance_count = 3
Defines the number of VM instances in this tier.
repeated images = 4
Defines the disk images. If there are more than one, the user can select which image to deploy with. The 1st image is the default. Required.
optional machine_type = 5
Specifies the default machine type, and any size constraints which restrict what the user can select. Will use defaults if not specified.
optional boot_disk = 6
Defines boot disk. Will use defaults if not specified.
repeated additional_disks = 14
Defines additional persistent disks to attach to each VM. Optional
optional local_ssds = 15
Specifies additionally added local SSD disks (with a default naming convention).
optional ip_forwarding = 7
If not specified, IP forwarding is forced off and not user-configurable.
optional network_interfaces = 17
Spec to define Multi/Single NIC(s) usage for this solution.
repeated gcp_auth_scopes = 8
Declares what GCP APIs should be available to the VM.
optional gce_startup_script = 16
Specifies a startup script for each VM instance in this tier.
optional application_status = 9
Defines how to determine that VMs in this tier are ready to serve. The entire deployment is ready to serve when all tiers are. This is not supported for Terraform Autogen.
optional external_ip = 10
Defines how the VMs are accessible from the Internet. Will use defaults if not specified. DEPRECATED! Use NetworkInterfacesSpec instead.
repeated gce_metadata_items = 11
Customizes metadata items on each GCE VM instance.
repeated accelerators = 12
Attach accelerator hardware (GPU) to the VM. Currently at most accelerator is supported.
repeated firewall_rules = 13
Specifies the default firewall rules to access the VMs in this tier. They could be off by default, but should still be listed so that the user can get instructions on how to enable them post-deployment.
Used in:
int32 default_value = 1
The default number of instances. Must satisfy the constraint.
oneof constraint
range = 2
Specifies a range of contiguous values.
list = 3
Explicitly lists out the supported values.
string tooltip = 4
Optional. Specify the tooltip text. If not specified, it will get a default value.
string description = 5
Optional. Field's description.
Used in: ,
string default_zone = 1
Sets the default zone.
repeated string whitelisted_zones = 2
Lists the zones that are allowed to be used in this DM package. If list is empty, all zones are allowed.
repeated string whitelisted_regions = 3
Lists the regions that are allowed to be used in this DM package. Only the zones that belong to the specified regions will be allowed to be used.