-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8c4a14f
commit 92bc932
Showing
12 changed files
with
185 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "cudo Provider" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # cudo Provider | ||
|
|
||
|
|
||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| provider "cudo" { | ||
| api_key = "api-key" | ||
| project_id = "my-project" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Optional | ||
|
|
||
| - `api_key` (String) Your API key | ||
| - `billing_account_id` (String) Which billing account id to create resources in | ||
| - `disable_tls` (Boolean) Whether to connect the API endpoint using TLS | ||
| - `project_id` (String) Which project id to use | ||
| - `remote_addr` (String) API endpoint |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "cudo_vm Resource - terraform-provider-cudo" | ||
| subcategory: "" | ||
| description: |- | ||
| VM resource | ||
| --- | ||
|
|
||
| # cudo_vm (Resource) | ||
|
|
||
| VM resource | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| # start a vm in any data center by specifying a maximum price | ||
| resource "cudo_vm" "my-vm-max-price" { | ||
| id = "terra-vm-1" | ||
| memory_gib = 2 | ||
| vcpus = 1 | ||
| boot_disk = { | ||
| image_id = "debian-11" | ||
| } | ||
| max_price_hr = 0.003 | ||
| networks = [ | ||
| { | ||
| network_id = "my-network" | ||
| assign_public_ip = true | ||
| security_group_ids = ["my-security-group"] | ||
| } | ||
| ] | ||
| } | ||
| # pick a specific data center and machine type | ||
| resource "cudo_vm" "my-vm" { | ||
| id = "terra-vm-1" | ||
| machine_type = "standard" | ||
| data_center_id = "gb-bournemouth-1" | ||
| memory_gib = 2 | ||
| vcpus = 1 | ||
| boot_disk = { | ||
| image_id = "debian-11" | ||
| size_gib = 50 | ||
| } | ||
| ssh_key_source = "project" | ||
| start_script = <<EOF | ||
| touch /multiline-script.txt | ||
| echo $PWD > /current-dir.txt | ||
| EOF | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `boot_disk` (Attributes) Specification for boot disk (see [below for nested schema](#nestedatt--boot_disk)) | ||
| - `id` (String) ID for VM within project | ||
|
|
||
| ### Optional | ||
|
|
||
| - `cpu_model` (String) The model of the CPU. | ||
| - `data_center_id` (String) The id of the datacenter where the VM instance is located. | ||
| - `gpu_model` (String) The model of the GPU. | ||
| - `gpus` (Number) Number of GPUs | ||
| - `machine_type` (String) VM machine type, from machine type data source | ||
| - `max_price_hr` (String) The maximum price per hour for the VM instance. | ||
| - `memory_gib` (Number) Amount of VM memory in GiB | ||
| - `networks` (Attributes List) Network adapters for private networks (see [below for nested schema](#nestedatt--networks)) | ||
| - `password` (String, Sensitive) Root password for linux, or Admin password for windows | ||
| - `project_id` (String) The project the VM instance is in. | ||
| - `security_group_ids` (Set of String) Security groups to assign to the VM when using public networking | ||
| - `ssh_key_source` (String) Which SSH keys to add to the VM: project (default), user or custom | ||
| - `ssh_keys` (List of String) List of SSH keys to add to the VM, ssh_key_source must be set to custom | ||
| - `start_script` (String) A script to run when VM boots | ||
| - `vcpus` (Number) Number of VCPUs | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `external_ip_address` (String) The external IP address of the VM instance. | ||
| - `internal_ip_address` (String) The internal IP address of the VM instance. | ||
| - `price_hr` (String) The current price per hour for the VM instance. | ||
| - `renewable_energy` (Boolean) Whether the VM instance is powered by renewable energy | ||
|
|
||
| <a id="nestedatt--boot_disk"></a> | ||
| ### Nested Schema for `boot_disk` | ||
|
|
||
| Required: | ||
|
|
||
| - `image_id` (String) ID of OS image on boot disk | ||
|
|
||
| Optional: | ||
|
|
||
| - `size_gib` (Number) Size of boot disk in Gib | ||
|
|
||
|
|
||
| <a id="nestedatt--networks"></a> | ||
| ### Nested Schema for `networks` | ||
|
|
||
| Required: | ||
|
|
||
| - `network_id` (String) ID of private network to attach the NIC to | ||
|
|
||
| Optional: | ||
|
|
||
| - `assign_public_ip` (Boolean) Assign a public IP to the NIC | ||
| - `security_group_ids` (Set of String) Security groups to assign to the NIC | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `external_ip_address` (String) The external IP address of the NIC. | ||
| - `internal_ip_address` (String) The internal IP address of the NIC. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.