1. Packages
  2. threefold
  3. API Docs
  4. Deployment
Threefold Grid v0.8.1 published on Wednesday, Nov 6, 2024 by Threefold

threefold.Deployment

Explore with Pulumi AI

Create Deployment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
               args: DeploymentArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               name: Optional[str] = None,
               node_id: Optional[Any] = None,
               disks: Optional[Sequence[DiskArgs]] = None,
               network_name: Optional[str] = None,
               qsfs: Optional[Sequence[QSFSInputArgs]] = None,
               solution_provider: Optional[int] = None,
               solution_type: Optional[str] = None,
               vms: Optional[Sequence[VMInputArgs]] = None,
               zdbs: Optional[Sequence[ZDBInputArgs]] = None)
func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
type: threefold:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var deploymentResource = new Threefold.Deployment("deploymentResource", new()
{
    Name = "string",
    Node_id = "any",
    Disks = new[]
    {
        new Threefold.Inputs.DiskArgs
        {
            Name = "string",
            Size = 0,
            Description = "string",
        },
    },
    Network_name = "string",
    Qsfs = new[]
    {
        new Threefold.Inputs.QSFSInputArgs
        {
            Minimal_shards = 0,
            Encryption_key = "string",
            Expected_shards = 0,
            Groups = new[]
            {
                new Threefold.Inputs.GroupArgs
                {
                    Backends = new[]
                    {
                        new Threefold.Inputs.BackendArgs
                        {
                            Address = "string",
                            Namespace = "string",
                            Password = "string",
                        },
                    },
                },
            },
            Max_zdb_data_dir_size = 0,
            Metadata = new Threefold.Inputs.MetadataArgs
            {
                Encryption_key = "string",
                Prefix = "string",
                Backends = new[]
                {
                    new Threefold.Inputs.BackendArgs
                    {
                        Address = "string",
                        Namespace = "string",
                        Password = "string",
                    },
                },
                Encryption_algorithm = "string",
                Type = "string",
            },
            Cache = 0,
            Name = "string",
            Redundant_groups = 0,
            Redundant_nodes = 0,
            Compression_algorithm = "string",
            Description = "string",
            Encryption_algorithm = "string",
        },
    },
    Solution_provider = 0,
    Solution_type = "string",
    Vms = new[]
    {
        new Threefold.Inputs.VMInputArgs
        {
            Network_name = "string",
            Memory = 0,
            Node_id = "any",
            Cpu = 0,
            Flist = "string",
            Name = "string",
            Flist_checksum = "string",
            Gpus = new[]
            {
                "string",
            },
            Description = "string",
            Mycelium_ip_seed = "string",
            Env_vars = 
            {
                { "string", "string" },
            },
            Mounts = new[]
            {
                new Threefold.Inputs.MountArgs
                {
                    Mount_point = "string",
                    Name = "string",
                },
            },
            Mycelium = false,
            Entrypoint = "string",
            Planetary = false,
            Public_ip = false,
            Public_ip6 = false,
            Rootfs_size = 0,
            Zlogs = new[]
            {
                new Threefold.Inputs.ZlogArgs
                {
                    Output = "string",
                    Zmachine = "string",
                },
            },
        },
    },
    Zdbs = new[]
    {
        new Threefold.Inputs.ZDBInputArgs
        {
            Name = "string",
            Password = "string",
            Size = 0,
            Description = "string",
            Mode = "string",
            Public = false,
        },
    },
});
Copy
example, err := threefold.NewDeployment(ctx, "deploymentResource", &threefold.DeploymentArgs{
	Name:    pulumi.String("string"),
	Node_id: pulumi.Any("any"),
	Disks: threefold.DiskArray{
		&threefold.DiskArgs{
			Name:        pulumi.String("string"),
			Size:        pulumi.Int(0),
			Description: pulumi.String("string"),
		},
	},
	Network_name: pulumi.String("string"),
	Qsfs: threefold.QSFSInputArray{
		&threefold.QSFSInputArgs{
			Minimal_shards:  pulumi.Int(0),
			Encryption_key:  pulumi.String("string"),
			Expected_shards: pulumi.Int(0),
			Groups: threefold.GroupArray{
				&threefold.GroupArgs{
					Backends: threefold.BackendArray{
						&threefold.BackendArgs{
							Address:   pulumi.String("string"),
							Namespace: pulumi.String("string"),
							Password:  pulumi.String("string"),
						},
					},
				},
			},
			Max_zdb_data_dir_size: pulumi.Int(0),
			Metadata: &threefold.MetadataArgs{
				Encryption_key: pulumi.String("string"),
				Prefix:         pulumi.String("string"),
				Backends: threefold.BackendArray{
					&threefold.BackendArgs{
						Address:   pulumi.String("string"),
						Namespace: pulumi.String("string"),
						Password:  pulumi.String("string"),
					},
				},
				Encryption_algorithm: pulumi.String("string"),
				Type:                 pulumi.String("string"),
			},
			Cache:                 pulumi.Int(0),
			Name:                  pulumi.String("string"),
			Redundant_groups:      pulumi.Int(0),
			Redundant_nodes:       pulumi.Int(0),
			Compression_algorithm: pulumi.String("string"),
			Description:           pulumi.String("string"),
			Encryption_algorithm:  pulumi.String("string"),
		},
	},
	Solution_provider: pulumi.Int(0),
	Solution_type:     pulumi.String("string"),
	Vms: threefold.VMInputArray{
		&threefold.VMInputArgs{
			Network_name:   pulumi.String("string"),
			Memory:         pulumi.Int(0),
			Node_id:        pulumi.Any("any"),
			Cpu:            pulumi.Int(0),
			Flist:          pulumi.String("string"),
			Name:           pulumi.String("string"),
			Flist_checksum: pulumi.String("string"),
			Gpus: pulumi.StringArray{
				pulumi.String("string"),
			},
			Description:      pulumi.String("string"),
			Mycelium_ip_seed: pulumi.String("string"),
			Env_vars: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Mounts: threefold.MountArray{
				&threefold.MountArgs{
					Mount_point: pulumi.String("string"),
					Name:        pulumi.String("string"),
				},
			},
			Mycelium:    pulumi.Bool(false),
			Entrypoint:  pulumi.String("string"),
			Planetary:   pulumi.Bool(false),
			Public_ip:   pulumi.Bool(false),
			Public_ip6:  pulumi.Bool(false),
			Rootfs_size: pulumi.Int(0),
			Zlogs: threefold.ZlogArray{
				&threefold.ZlogArgs{
					Output:   pulumi.String("string"),
					Zmachine: pulumi.String("string"),
				},
			},
		},
	},
	Zdbs: threefold.ZDBInputArray{
		&threefold.ZDBInputArgs{
			Name:        pulumi.String("string"),
			Password:    pulumi.String("string"),
			Size:        pulumi.Int(0),
			Description: pulumi.String("string"),
			Mode:        pulumi.String("string"),
			Public:      pulumi.Bool(false),
		},
	},
})
Copy
var deploymentResource = new Deployment("deploymentResource", DeploymentArgs.builder()
    .name("string")
    .node_id("any")
    .disks(DiskArgs.builder()
        .name("string")
        .size(0)
        .description("string")
        .build())
    .network_name("string")
    .qsfs(QSFSInputArgs.builder()
        .minimal_shards(0)
        .encryption_key("string")
        .expected_shards(0)
        .groups(GroupArgs.builder()
            .backends(BackendArgs.builder()
                .address("string")
                .namespace("string")
                .password("string")
                .build())
            .build())
        .max_zdb_data_dir_size(0)
        .metadata(MetadataArgs.builder()
            .encryption_key("string")
            .prefix("string")
            .backends(BackendArgs.builder()
                .address("string")
                .namespace("string")
                .password("string")
                .build())
            .encryption_algorithm("string")
            .type("string")
            .build())
        .cache(0)
        .name("string")
        .redundant_groups(0)
        .redundant_nodes(0)
        .compression_algorithm("string")
        .description("string")
        .encryption_algorithm("string")
        .build())
    .solution_provider(0)
    .solution_type("string")
    .vms(VMInputArgs.builder()
        .network_name("string")
        .memory(0)
        .node_id("any")
        .cpu(0)
        .flist("string")
        .name("string")
        .flist_checksum("string")
        .gpus("string")
        .description("string")
        .mycelium_ip_seed("string")
        .env_vars(Map.of("string", "string"))
        .mounts(MountArgs.builder()
            .mount_point("string")
            .name("string")
            .build())
        .mycelium(false)
        .entrypoint("string")
        .planetary(false)
        .public_ip(false)
        .public_ip6(false)
        .rootfs_size(0)
        .zlogs(ZlogArgs.builder()
            .output("string")
            .zmachine("string")
            .build())
        .build())
    .zdbs(ZDBInputArgs.builder()
        .name("string")
        .password("string")
        .size(0)
        .description("string")
        .mode("string")
        .public_(false)
        .build())
    .build());
Copy
deployment_resource = threefold.Deployment("deploymentResource",
    name="string",
    node_id="any",
    disks=[{
        "name": "string",
        "size": 0,
        "description": "string",
    }],
    network_name="string",
    qsfs=[{
        "minimal_shards": 0,
        "encryption_key": "string",
        "expected_shards": 0,
        "groups": [{
            "backends": [{
                "address": "string",
                "namespace": "string",
                "password": "string",
            }],
        }],
        "max_zdb_data_dir_size": 0,
        "metadata": {
            "encryption_key": "string",
            "prefix": "string",
            "backends": [{
                "address": "string",
                "namespace": "string",
                "password": "string",
            }],
            "encryption_algorithm": "string",
            "type": "string",
        },
        "cache": 0,
        "name": "string",
        "redundant_groups": 0,
        "redundant_nodes": 0,
        "compression_algorithm": "string",
        "description": "string",
        "encryption_algorithm": "string",
    }],
    solution_provider=0,
    solution_type="string",
    vms=[{
        "network_name": "string",
        "memory": 0,
        "node_id": "any",
        "cpu": 0,
        "flist": "string",
        "name": "string",
        "flist_checksum": "string",
        "gpus": ["string"],
        "description": "string",
        "mycelium_ip_seed": "string",
        "env_vars": {
            "string": "string",
        },
        "mounts": [{
            "mount_point": "string",
            "name": "string",
        }],
        "mycelium": False,
        "entrypoint": "string",
        "planetary": False,
        "public_ip": False,
        "public_ip6": False,
        "rootfs_size": 0,
        "zlogs": [{
            "output": "string",
            "zmachine": "string",
        }],
    }],
    zdbs=[{
        "name": "string",
        "password": "string",
        "size": 0,
        "description": "string",
        "mode": "string",
        "public": False,
    }])
Copy
const deploymentResource = new threefold.Deployment("deploymentResource", {
    name: "string",
    node_id: "any",
    disks: [{
        name: "string",
        size: 0,
        description: "string",
    }],
    network_name: "string",
    qsfs: [{
        minimal_shards: 0,
        encryption_key: "string",
        expected_shards: 0,
        groups: [{
            backends: [{
                address: "string",
                namespace: "string",
                password: "string",
            }],
        }],
        max_zdb_data_dir_size: 0,
        metadata: {
            encryption_key: "string",
            prefix: "string",
            backends: [{
                address: "string",
                namespace: "string",
                password: "string",
            }],
            encryption_algorithm: "string",
            type: "string",
        },
        cache: 0,
        name: "string",
        redundant_groups: 0,
        redundant_nodes: 0,
        compression_algorithm: "string",
        description: "string",
        encryption_algorithm: "string",
    }],
    solution_provider: 0,
    solution_type: "string",
    vms: [{
        network_name: "string",
        memory: 0,
        node_id: "any",
        cpu: 0,
        flist: "string",
        name: "string",
        flist_checksum: "string",
        gpus: ["string"],
        description: "string",
        mycelium_ip_seed: "string",
        env_vars: {
            string: "string",
        },
        mounts: [{
            mount_point: "string",
            name: "string",
        }],
        mycelium: false,
        entrypoint: "string",
        planetary: false,
        public_ip: false,
        public_ip6: false,
        rootfs_size: 0,
        zlogs: [{
            output: "string",
            zmachine: "string",
        }],
    }],
    zdbs: [{
        name: "string",
        password: "string",
        size: 0,
        description: "string",
        mode: "string",
        "public": false,
    }],
});
Copy
type: threefold:Deployment
properties:
    disks:
        - description: string
          name: string
          size: 0
    name: string
    network_name: string
    node_id: any
    qsfs:
        - cache: 0
          compression_algorithm: string
          description: string
          encryption_algorithm: string
          encryption_key: string
          expected_shards: 0
          groups:
            - backends:
                - address: string
                  namespace: string
                  password: string
          max_zdb_data_dir_size: 0
          metadata:
            backends:
                - address: string
                  namespace: string
                  password: string
            encryption_algorithm: string
            encryption_key: string
            prefix: string
            type: string
          minimal_shards: 0
          name: string
          redundant_groups: 0
          redundant_nodes: 0
    solution_provider: 0
    solution_type: string
    vms:
        - cpu: 0
          description: string
          entrypoint: string
          env_vars:
            string: string
          flist: string
          flist_checksum: string
          gpus:
            - string
          memory: 0
          mounts:
            - mount_point: string
              name: string
          mycelium: false
          mycelium_ip_seed: string
          name: string
          network_name: string
          node_id: any
          planetary: false
          public_ip: false
          public_ip6: false
          rootfs_size: 0
          zlogs:
            - output: string
              zmachine: string
    zdbs:
        - description: string
          mode: string
          name: string
          password: string
          public: false
          size: 0
Copy

Deployment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Deployment resource accepts the following input properties:

Name This property is required. string
The name of the deployment, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Node_id This property is required. object
The node ID to deploy on, required and should match the requested resources
Disks List<Disk>
The disks requested to be included in the deployment
Network_name string
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
Qsfs List<QSFSInput>
The qsfs instances requested to be included in the deployment
Solution_provider int
ID for the deployed solution which allows the creator of the solution to gain a percentage of the rewards
Solution_type string
The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
Vms List<VMInput>
The vms requested to be included in the deployment
Zdbs List<ZDBInput>
The zdbs requested to be included in the deployment
Name This property is required. string
The name of the deployment, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Node_id This property is required. interface{}
The node ID to deploy on, required and should match the requested resources
Disks []DiskArgs
The disks requested to be included in the deployment
Network_name string
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
Qsfs []QSFSInputArgs
The qsfs instances requested to be included in the deployment
Solution_provider int
ID for the deployed solution which allows the creator of the solution to gain a percentage of the rewards
Solution_type string
The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
Vms []VMInputArgs
The vms requested to be included in the deployment
Zdbs []ZDBInputArgs
The zdbs requested to be included in the deployment
name This property is required. String
The name of the deployment, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
node_id This property is required. Object
The node ID to deploy on, required and should match the requested resources
disks List<Disk>
The disks requested to be included in the deployment
network_name String
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
qsfs List<QSFSInput>
The qsfs instances requested to be included in the deployment
solution_provider Integer
ID for the deployed solution which allows the creator of the solution to gain a percentage of the rewards
solution_type String
The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
vms List<VMInput>
The vms requested to be included in the deployment
zdbs List<ZDBInput>
The zdbs requested to be included in the deployment
name This property is required. string
The name of the deployment, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
node_id This property is required. any
The node ID to deploy on, required and should match the requested resources
disks Disk[]
The disks requested to be included in the deployment
network_name string
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
qsfs QSFSInput[]
The qsfs instances requested to be included in the deployment
solution_provider number
ID for the deployed solution which allows the creator of the solution to gain a percentage of the rewards
solution_type string
The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
vms VMInput[]
The vms requested to be included in the deployment
zdbs ZDBInput[]
The zdbs requested to be included in the deployment
name This property is required. str
The name of the deployment, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
node_id This property is required. Any
The node ID to deploy on, required and should match the requested resources
disks Sequence[DiskArgs]
The disks requested to be included in the deployment
network_name str
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
qsfs Sequence[QSFSInputArgs]
The qsfs instances requested to be included in the deployment
solution_provider int
ID for the deployed solution which allows the creator of the solution to gain a percentage of the rewards
solution_type str
The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
vms Sequence[VMInputArgs]
The vms requested to be included in the deployment
zdbs Sequence[ZDBInputArgs]
The zdbs requested to be included in the deployment
name This property is required. String
The name of the deployment, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
node_id This property is required. Any
The node ID to deploy on, required and should match the requested resources
disks List<Property Map>
The disks requested to be included in the deployment
network_name String
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
qsfs List<Property Map>
The qsfs instances requested to be included in the deployment
solution_provider Number
ID for the deployed solution which allows the creator of the solution to gain a percentage of the rewards
solution_type String
The name of the solution for created contract to be consistent across threefold tooling (project name in deployment metadata)
vms List<Property Map>
The vms requested to be included in the deployment
zdbs List<Property Map>
The zdbs requested to be included in the deployment

Outputs

All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:

Contract_id int
The deployment ID
Id string
The provider-assigned unique ID for this managed resource.
Ip_range string
IP range of the node for the wireguard network (e.g. 10.1.2.0/24). Has to have a subnet mask of 24
Node_deployment_id Dictionary<string, int>
Mapping from each node to its deployment ID
Qsfs_computed List<QSFSComputed>
Vms_computed List<VMComputed>
Zdbs_computed List<ZDBComputed>
Contract_id int
The deployment ID
Id string
The provider-assigned unique ID for this managed resource.
Ip_range string
IP range of the node for the wireguard network (e.g. 10.1.2.0/24). Has to have a subnet mask of 24
Node_deployment_id map[string]int
Mapping from each node to its deployment ID
Qsfs_computed []QSFSComputed
Vms_computed []VMComputed
Zdbs_computed []ZDBComputed
contract_id Integer
The deployment ID
id String
The provider-assigned unique ID for this managed resource.
ip_range String
IP range of the node for the wireguard network (e.g. 10.1.2.0/24). Has to have a subnet mask of 24
node_deployment_id Map<String,Integer>
Mapping from each node to its deployment ID
qsfs_computed List<QSFSComputed>
vms_computed List<VMComputed>
zdbs_computed List<ZDBComputed>
contract_id number
The deployment ID
id string
The provider-assigned unique ID for this managed resource.
ip_range string
IP range of the node for the wireguard network (e.g. 10.1.2.0/24). Has to have a subnet mask of 24
node_deployment_id {[key: string]: number}
Mapping from each node to its deployment ID
qsfs_computed QSFSComputed[]
vms_computed VMComputed[]
zdbs_computed ZDBComputed[]
contract_id int
The deployment ID
id str
The provider-assigned unique ID for this managed resource.
ip_range str
IP range of the node for the wireguard network (e.g. 10.1.2.0/24). Has to have a subnet mask of 24
node_deployment_id Mapping[str, int]
Mapping from each node to its deployment ID
qsfs_computed Sequence[QSFSComputed]
vms_computed Sequence[VMComputed]
zdbs_computed Sequence[ZDBComputed]
contract_id Number
The deployment ID
id String
The provider-assigned unique ID for this managed resource.
ip_range String
IP range of the node for the wireguard network (e.g. 10.1.2.0/24). Has to have a subnet mask of 24
node_deployment_id Map<Number>
Mapping from each node to its deployment ID
qsfs_computed List<Property Map>
vms_computed List<Property Map>
zdbs_computed List<Property Map>

Supporting Types

Backend
, BackendArgs

Address This property is required. string
Address of backend ZDB (e.g. [300:a582:c60c:df75:f6da:8a92:d5ed:71ad]:9900 or 60.60.60.60:9900)
Namespace This property is required. string
ZDB namespace
Password This property is required. string
Namespace password
Address This property is required. string
Address of backend ZDB (e.g. [300:a582:c60c:df75:f6da:8a92:d5ed:71ad]:9900 or 60.60.60.60:9900)
Namespace This property is required. string
ZDB namespace
Password This property is required. string
Namespace password
address This property is required. String
Address of backend ZDB (e.g. [300:a582:c60c:df75:f6da:8a92:d5ed:71ad]:9900 or 60.60.60.60:9900)
namespace This property is required. String
ZDB namespace
password This property is required. String
Namespace password
address This property is required. string
Address of backend ZDB (e.g. [300:a582:c60c:df75:f6da:8a92:d5ed:71ad]:9900 or 60.60.60.60:9900)
namespace This property is required. string
ZDB namespace
password This property is required. string
Namespace password
address This property is required. str
Address of backend ZDB (e.g. [300:a582:c60c:df75:f6da:8a92:d5ed:71ad]:9900 or 60.60.60.60:9900)
namespace This property is required. str
ZDB namespace
password This property is required. str
Namespace password
address This property is required. String
Address of backend ZDB (e.g. [300:a582:c60c:df75:f6da:8a92:d5ed:71ad]:9900 or 60.60.60.60:9900)
namespace This property is required. String
ZDB namespace
password This property is required. String
Namespace password

Disk
, DiskArgs

Name This property is required. string
The name of the disk workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Size This property is required. int
The disk size in GB (type SSD)
Description string
The description of the disk workload, optional with no restrictions
Name This property is required. string
The name of the disk workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Size This property is required. int
The disk size in GB (type SSD)
Description string
The description of the disk workload, optional with no restrictions
name This property is required. String
The name of the disk workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
size This property is required. Integer
The disk size in GB (type SSD)
description String
The description of the disk workload, optional with no restrictions
name This property is required. string
The name of the disk workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
size This property is required. number
The disk size in GB (type SSD)
description string
The description of the disk workload, optional with no restrictions
name This property is required. str
The name of the disk workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
size This property is required. int
The disk size in GB (type SSD)
description str
The description of the disk workload, optional with no restrictions
name This property is required. String
The name of the disk workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
size This property is required. Number
The disk size in GB (type SSD)
description String
The description of the disk workload, optional with no restrictions

Group
, GroupArgs

Backends List<Backend>
List of ZDB backends configurations
Backends []Backend
List of ZDB backends configurations
backends List<Backend>
List of ZDB backends configurations
backends Backend[]
List of ZDB backends configurations
backends Sequence[Backend]
List of ZDB backends configurations
backends List<Property Map>
List of ZDB backends configurations

Metadata
, MetadataArgs

Encryption_key This property is required. string
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
Prefix This property is required. string
Data stored on the remote metadata is prefixed with
Backends List<Backend>
List of ZDB backends configurations
Encryption_algorithm string
configuration to use for the encryption stage. Currently only AES is supported
Type string
configuration for the metadata store to use, currently only ZDB is supported
Encryption_key This property is required. string
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
Prefix This property is required. string
Data stored on the remote metadata is prefixed with
Backends []Backend
List of ZDB backends configurations
Encryption_algorithm string
configuration to use for the encryption stage. Currently only AES is supported
Type string
configuration for the metadata store to use, currently only ZDB is supported
encryption_key This property is required. String
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
prefix This property is required. String
Data stored on the remote metadata is prefixed with
backends List<Backend>
List of ZDB backends configurations
encryption_algorithm String
configuration to use for the encryption stage. Currently only AES is supported
type String
configuration for the metadata store to use, currently only ZDB is supported
encryption_key This property is required. string
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
prefix This property is required. string
Data stored on the remote metadata is prefixed with
backends Backend[]
List of ZDB backends configurations
encryption_algorithm string
configuration to use for the encryption stage. Currently only AES is supported
type string
configuration for the metadata store to use, currently only ZDB is supported
encryption_key This property is required. str
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
prefix This property is required. str
Data stored on the remote metadata is prefixed with
backends Sequence[Backend]
List of ZDB backends configurations
encryption_algorithm str
configuration to use for the encryption stage. Currently only AES is supported
type str
configuration for the metadata store to use, currently only ZDB is supported
encryption_key This property is required. String
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
prefix This property is required. String
Data stored on the remote metadata is prefixed with
backends List<Property Map>
List of ZDB backends configurations
encryption_algorithm String
configuration to use for the encryption stage. Currently only AES is supported
type String
configuration for the metadata store to use, currently only ZDB is supported

Mount
, MountArgs

Mount_point This property is required. string
The mount point of the disk/volume
Name This property is required. string
The name of the mounted disk/volume, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Mount_point This property is required. string
The mount point of the disk/volume
Name This property is required. string
The name of the mounted disk/volume, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
mount_point This property is required. String
The mount point of the disk/volume
name This property is required. String
The name of the mounted disk/volume, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
mount_point This property is required. string
The mount point of the disk/volume
name This property is required. string
The name of the mounted disk/volume, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
mount_point This property is required. str
The mount point of the disk/volume
name This property is required. str
The name of the mounted disk/volume, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
mount_point This property is required. String
The mount point of the disk/volume
name This property is required. String
The name of the mounted disk/volume, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported

QSFSComputed
, QSFSComputedArgs

Metrics_endpoint This property is required. string
Exposed metrics endpoint
Metrics_endpoint This property is required. string
Exposed metrics endpoint
metrics_endpoint This property is required. String
Exposed metrics endpoint
metrics_endpoint This property is required. string
Exposed metrics endpoint
metrics_endpoint This property is required. str
Exposed metrics endpoint
metrics_endpoint This property is required. String
Exposed metrics endpoint

QSFSInput
, QSFSInputArgs

Cache This property is required. int
The size of the fuse mountpoint on the node in MBs (holds qsfs local data before pushing)
Encryption_key This property is required. string
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
Expected_shards This property is required. int
The amount of shards which are generated when the data is encoded. Essentially, this is the amount of shards which is needed to be able to recover the data, and some disposable shards which could be lost. The amount of disposable shards can be calculated as expected_shards - minimal_shards
Groups This property is required. List<Group>
The backend groups to write the data to
Max_zdb_data_dir_size This property is required. int
Maximum size of the data dir in MiB, if this is set and the sum of the file sizes in the data dir gets higher than this value, the least used, already encoded file will be removed
Metadata This property is required. Metadata
List of ZDB backends configurations
Minimal_shards This property is required. int
The minimum amount of shards which are needed to recover the original data
Name This property is required. string
The name of the qsfs workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Redundant_groups This property is required. int
The amount of groups which one should be able to loose while still being able to recover the original data
Redundant_nodes This property is required. int
The amount of nodes that can be lost in every group while still being able to recover the original data
Compression_algorithm string
configuration to use for the compression stage. Currently only snappy is supported
Description string
The description of the qsfs workload, optional with no restrictions
Encryption_algorithm string
configuration to use for the encryption stage. Currently only AES is supported
Cache This property is required. int
The size of the fuse mountpoint on the node in MBs (holds qsfs local data before pushing)
Encryption_key This property is required. string
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
Expected_shards This property is required. int
The amount of shards which are generated when the data is encoded. Essentially, this is the amount of shards which is needed to be able to recover the data, and some disposable shards which could be lost. The amount of disposable shards can be calculated as expected_shards - minimal_shards
Groups This property is required. []Group
The backend groups to write the data to
Max_zdb_data_dir_size This property is required. int
Maximum size of the data dir in MiB, if this is set and the sum of the file sizes in the data dir gets higher than this value, the least used, already encoded file will be removed
Metadata This property is required. Metadata
List of ZDB backends configurations
Minimal_shards This property is required. int
The minimum amount of shards which are needed to recover the original data
Name This property is required. string
The name of the qsfs workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Redundant_groups This property is required. int
The amount of groups which one should be able to loose while still being able to recover the original data
Redundant_nodes This property is required. int
The amount of nodes that can be lost in every group while still being able to recover the original data
Compression_algorithm string
configuration to use for the compression stage. Currently only snappy is supported
Description string
The description of the qsfs workload, optional with no restrictions
Encryption_algorithm string
configuration to use for the encryption stage. Currently only AES is supported
cache This property is required. Integer
The size of the fuse mountpoint on the node in MBs (holds qsfs local data before pushing)
encryption_key This property is required. String
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
expected_shards This property is required. Integer
The amount of shards which are generated when the data is encoded. Essentially, this is the amount of shards which is needed to be able to recover the data, and some disposable shards which could be lost. The amount of disposable shards can be calculated as expected_shards - minimal_shards
groups This property is required. List<Group>
The backend groups to write the data to
max_zdb_data_dir_size This property is required. Integer
Maximum size of the data dir in MiB, if this is set and the sum of the file sizes in the data dir gets higher than this value, the least used, already encoded file will be removed
metadata This property is required. Metadata
List of ZDB backends configurations
minimal_shards This property is required. Integer
The minimum amount of shards which are needed to recover the original data
name This property is required. String
The name of the qsfs workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
redundant_groups This property is required. Integer
The amount of groups which one should be able to loose while still being able to recover the original data
redundant_nodes This property is required. Integer
The amount of nodes that can be lost in every group while still being able to recover the original data
compression_algorithm String
configuration to use for the compression stage. Currently only snappy is supported
description String
The description of the qsfs workload, optional with no restrictions
encryption_algorithm String
configuration to use for the encryption stage. Currently only AES is supported
cache This property is required. number
The size of the fuse mountpoint on the node in MBs (holds qsfs local data before pushing)
encryption_key This property is required. string
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
expected_shards This property is required. number
The amount of shards which are generated when the data is encoded. Essentially, this is the amount of shards which is needed to be able to recover the data, and some disposable shards which could be lost. The amount of disposable shards can be calculated as expected_shards - minimal_shards
groups This property is required. Group[]
The backend groups to write the data to
max_zdb_data_dir_size This property is required. number
Maximum size of the data dir in MiB, if this is set and the sum of the file sizes in the data dir gets higher than this value, the least used, already encoded file will be removed
metadata This property is required. Metadata
List of ZDB backends configurations
minimal_shards This property is required. number
The minimum amount of shards which are needed to recover the original data
name This property is required. string
The name of the qsfs workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
redundant_groups This property is required. number
The amount of groups which one should be able to loose while still being able to recover the original data
redundant_nodes This property is required. number
The amount of nodes that can be lost in every group while still being able to recover the original data
compression_algorithm string
configuration to use for the compression stage. Currently only snappy is supported
description string
The description of the qsfs workload, optional with no restrictions
encryption_algorithm string
configuration to use for the encryption stage. Currently only AES is supported
cache This property is required. int
The size of the fuse mountpoint on the node in MBs (holds qsfs local data before pushing)
encryption_key This property is required. str
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
expected_shards This property is required. int
The amount of shards which are generated when the data is encoded. Essentially, this is the amount of shards which is needed to be able to recover the data, and some disposable shards which could be lost. The amount of disposable shards can be calculated as expected_shards - minimal_shards
groups This property is required. Sequence[Group]
The backend groups to write the data to
max_zdb_data_dir_size This property is required. int
Maximum size of the data dir in MiB, if this is set and the sum of the file sizes in the data dir gets higher than this value, the least used, already encoded file will be removed
metadata This property is required. Metadata
List of ZDB backends configurations
minimal_shards This property is required. int
The minimum amount of shards which are needed to recover the original data
name This property is required. str
The name of the qsfs workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
redundant_groups This property is required. int
The amount of groups which one should be able to loose while still being able to recover the original data
redundant_nodes This property is required. int
The amount of nodes that can be lost in every group while still being able to recover the original data
compression_algorithm str
configuration to use for the compression stage. Currently only snappy is supported
description str
The description of the qsfs workload, optional with no restrictions
encryption_algorithm str
configuration to use for the encryption stage. Currently only AES is supported
cache This property is required. Number
The size of the fuse mountpoint on the node in MBs (holds qsfs local data before pushing)
encryption_key This property is required. String
64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
expected_shards This property is required. Number
The amount of shards which are generated when the data is encoded. Essentially, this is the amount of shards which is needed to be able to recover the data, and some disposable shards which could be lost. The amount of disposable shards can be calculated as expected_shards - minimal_shards
groups This property is required. List<Property Map>
The backend groups to write the data to
max_zdb_data_dir_size This property is required. Number
Maximum size of the data dir in MiB, if this is set and the sum of the file sizes in the data dir gets higher than this value, the least used, already encoded file will be removed
metadata This property is required. Property Map
List of ZDB backends configurations
minimal_shards This property is required. Number
The minimum amount of shards which are needed to recover the original data
name This property is required. String
The name of the qsfs workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
redundant_groups This property is required. Number
The amount of groups which one should be able to loose while still being able to recover the original data
redundant_nodes This property is required. Number
The amount of nodes that can be lost in every group while still being able to recover the original data
compression_algorithm String
configuration to use for the compression stage. Currently only snappy is supported
description String
The description of the qsfs workload, optional with no restrictions
encryption_algorithm String
configuration to use for the encryption stage. Currently only AES is supported

VMComputed
, VMComputedArgs

Computed_ip This property is required. string
The reserved public ipv4 if any
Computed_ip6 This property is required. string
The reserved public ipv6 if any
Console_url This property is required. string
The url to access the vm via cloud console on private interface using wireguard
Mycelium_ip This property is required. string
The allocated mycelium IP
Mycelium_ip_seed This property is required. string
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
Planetary_ip This property is required. string
The allocated Yggdrasil IP
Ip string
The private wireguard IP of the vm
Computed_ip This property is required. string
The reserved public ipv4 if any
Computed_ip6 This property is required. string
The reserved public ipv6 if any
Console_url This property is required. string
The url to access the vm via cloud console on private interface using wireguard
Mycelium_ip This property is required. string
The allocated mycelium IP
Mycelium_ip_seed This property is required. string
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
Planetary_ip This property is required. string
The allocated Yggdrasil IP
Ip string
The private wireguard IP of the vm
computed_ip This property is required. String
The reserved public ipv4 if any
computed_ip6 This property is required. String
The reserved public ipv6 if any
console_url This property is required. String
The url to access the vm via cloud console on private interface using wireguard
mycelium_ip This property is required. String
The allocated mycelium IP
mycelium_ip_seed This property is required. String
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
planetary_ip This property is required. String
The allocated Yggdrasil IP
ip String
The private wireguard IP of the vm
computed_ip This property is required. string
The reserved public ipv4 if any
computed_ip6 This property is required. string
The reserved public ipv6 if any
console_url This property is required. string
The url to access the vm via cloud console on private interface using wireguard
mycelium_ip This property is required. string
The allocated mycelium IP
mycelium_ip_seed This property is required. string
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
planetary_ip This property is required. string
The allocated Yggdrasil IP
ip string
The private wireguard IP of the vm
computed_ip This property is required. str
The reserved public ipv4 if any
computed_ip6 This property is required. str
The reserved public ipv6 if any
console_url This property is required. str
The url to access the vm via cloud console on private interface using wireguard
mycelium_ip This property is required. str
The allocated mycelium IP
mycelium_ip_seed This property is required. str
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
planetary_ip This property is required. str
The allocated Yggdrasil IP
ip str
The private wireguard IP of the vm
computed_ip This property is required. String
The reserved public ipv4 if any
computed_ip6 This property is required. String
The reserved public ipv6 if any
console_url This property is required. String
The url to access the vm via cloud console on private interface using wireguard
mycelium_ip This property is required. String
The allocated mycelium IP
mycelium_ip_seed This property is required. String
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
planetary_ip This property is required. String
The allocated Yggdrasil IP
ip String
The private wireguard IP of the vm

VMInput
, VMInputArgs

Cpu This property is required. int
The cpu units needed for the virtual machine. Range in [1: 32]
Flist This property is required. string
The flist to be mounted in the virtual machine, required and should be valid. Example: https://hub.grid.tf/tf-official-apps/base:latest.flist
Memory This property is required. int
The memory capacity for the virtual machine in MB. Min is 250 MB
Name This property is required. string
The name of the virtual machine workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Network_name This property is required. string
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
Node_id This property is required. object
The node ID to deploy the virtual machine on, required and should match the requested resources
Description string
The description of the virtual machine workload, optional with no restrictions
Entrypoint string
The entry point for the flist. Example: /sbin/zinit init
Env_vars Dictionary<string, string>
The environment variables to be passed to the virtual machine. Example: SSH_KEY
Flist_checksum string
The checksum of the flist which should match the checksum of the given flist, optional
Gpus List<string>
A list of gpu IDs to be used in the virtual machine. GPU ID format: //. Example: 0000:28:00.0/1002/731f
Mounts List<Mount>
A list of mounted disks or volumes
Mycelium bool
A flag to generate a random mycelium IP seed to support mycelium in the virtual machine
Mycelium_ip_seed string
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
Planetary bool
A flag to enable generating a yggdrasil IP for the virtual machine
Public_ip bool
A flag to enable generating a public IP for the virtual machine, public node is required for it
Public_ip6 bool
A flag to enable generating a public IPv6 for the virtual machine, public node is required for it
Rootfs_size int
The root fs size in GB (type SSD). Can be set as 0 to get the default minimum
Zlogs List<Zlog>
A list of virtual machine loggers
Cpu This property is required. int
The cpu units needed for the virtual machine. Range in [1: 32]
Flist This property is required. string
The flist to be mounted in the virtual machine, required and should be valid. Example: https://hub.grid.tf/tf-official-apps/base:latest.flist
Memory This property is required. int
The memory capacity for the virtual machine in MB. Min is 250 MB
Name This property is required. string
The name of the virtual machine workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Network_name This property is required. string
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
Node_id This property is required. interface{}
The node ID to deploy the virtual machine on, required and should match the requested resources
Description string
The description of the virtual machine workload, optional with no restrictions
Entrypoint string
The entry point for the flist. Example: /sbin/zinit init
Env_vars map[string]string
The environment variables to be passed to the virtual machine. Example: SSH_KEY
Flist_checksum string
The checksum of the flist which should match the checksum of the given flist, optional
Gpus []string
A list of gpu IDs to be used in the virtual machine. GPU ID format: //. Example: 0000:28:00.0/1002/731f
Mounts []Mount
A list of mounted disks or volumes
Mycelium bool
A flag to generate a random mycelium IP seed to support mycelium in the virtual machine
Mycelium_ip_seed string
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
Planetary bool
A flag to enable generating a yggdrasil IP for the virtual machine
Public_ip bool
A flag to enable generating a public IP for the virtual machine, public node is required for it
Public_ip6 bool
A flag to enable generating a public IPv6 for the virtual machine, public node is required for it
Rootfs_size int
The root fs size in GB (type SSD). Can be set as 0 to get the default minimum
Zlogs []Zlog
A list of virtual machine loggers
cpu This property is required. Integer
The cpu units needed for the virtual machine. Range in [1: 32]
flist This property is required. String
The flist to be mounted in the virtual machine, required and should be valid. Example: https://hub.grid.tf/tf-official-apps/base:latest.flist
memory This property is required. Integer
The memory capacity for the virtual machine in MB. Min is 250 MB
name This property is required. String
The name of the virtual machine workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
network_name This property is required. String
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
node_id This property is required. Object
The node ID to deploy the virtual machine on, required and should match the requested resources
description String
The description of the virtual machine workload, optional with no restrictions
entrypoint String
The entry point for the flist. Example: /sbin/zinit init
env_vars Map<String,String>
The environment variables to be passed to the virtual machine. Example: SSH_KEY
flist_checksum String
The checksum of the flist which should match the checksum of the given flist, optional
gpus List<String>
A list of gpu IDs to be used in the virtual machine. GPU ID format: //. Example: 0000:28:00.0/1002/731f
mounts List<Mount>
A list of mounted disks or volumes
mycelium Boolean
A flag to generate a random mycelium IP seed to support mycelium in the virtual machine
mycelium_ip_seed String
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
planetary Boolean
A flag to enable generating a yggdrasil IP for the virtual machine
public_ip Boolean
A flag to enable generating a public IP for the virtual machine, public node is required for it
public_ip6 Boolean
A flag to enable generating a public IPv6 for the virtual machine, public node is required for it
rootfs_size Integer
The root fs size in GB (type SSD). Can be set as 0 to get the default minimum
zlogs List<Zlog>
A list of virtual machine loggers
cpu This property is required. number
The cpu units needed for the virtual machine. Range in [1: 32]
flist This property is required. string
The flist to be mounted in the virtual machine, required and should be valid. Example: https://hub.grid.tf/tf-official-apps/base:latest.flist
memory This property is required. number
The memory capacity for the virtual machine in MB. Min is 250 MB
name This property is required. string
The name of the virtual machine workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
network_name This property is required. string
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
node_id This property is required. any
The node ID to deploy the virtual machine on, required and should match the requested resources
description string
The description of the virtual machine workload, optional with no restrictions
entrypoint string
The entry point for the flist. Example: /sbin/zinit init
env_vars {[key: string]: string}
The environment variables to be passed to the virtual machine. Example: SSH_KEY
flist_checksum string
The checksum of the flist which should match the checksum of the given flist, optional
gpus string[]
A list of gpu IDs to be used in the virtual machine. GPU ID format: //. Example: 0000:28:00.0/1002/731f
mounts Mount[]
A list of mounted disks or volumes
mycelium boolean
A flag to generate a random mycelium IP seed to support mycelium in the virtual machine
mycelium_ip_seed string
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
planetary boolean
A flag to enable generating a yggdrasil IP for the virtual machine
public_ip boolean
A flag to enable generating a public IP for the virtual machine, public node is required for it
public_ip6 boolean
A flag to enable generating a public IPv6 for the virtual machine, public node is required for it
rootfs_size number
The root fs size in GB (type SSD). Can be set as 0 to get the default minimum
zlogs Zlog[]
A list of virtual machine loggers
cpu This property is required. int
The cpu units needed for the virtual machine. Range in [1: 32]
flist This property is required. str
The flist to be mounted in the virtual machine, required and should be valid. Example: https://hub.grid.tf/tf-official-apps/base:latest.flist
memory This property is required. int
The memory capacity for the virtual machine in MB. Min is 250 MB
name This property is required. str
The name of the virtual machine workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
network_name This property is required. str
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
node_id This property is required. Any
The node ID to deploy the virtual machine on, required and should match the requested resources
description str
The description of the virtual machine workload, optional with no restrictions
entrypoint str
The entry point for the flist. Example: /sbin/zinit init
env_vars Mapping[str, str]
The environment variables to be passed to the virtual machine. Example: SSH_KEY
flist_checksum str
The checksum of the flist which should match the checksum of the given flist, optional
gpus Sequence[str]
A list of gpu IDs to be used in the virtual machine. GPU ID format: //. Example: 0000:28:00.0/1002/731f
mounts Sequence[Mount]
A list of mounted disks or volumes
mycelium bool
A flag to generate a random mycelium IP seed to support mycelium in the virtual machine
mycelium_ip_seed str
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
planetary bool
A flag to enable generating a yggdrasil IP for the virtual machine
public_ip bool
A flag to enable generating a public IP for the virtual machine, public node is required for it
public_ip6 bool
A flag to enable generating a public IPv6 for the virtual machine, public node is required for it
rootfs_size int
The root fs size in GB (type SSD). Can be set as 0 to get the default minimum
zlogs Sequence[Zlog]
A list of virtual machine loggers
cpu This property is required. Number
The cpu units needed for the virtual machine. Range in [1: 32]
flist This property is required. String
The flist to be mounted in the virtual machine, required and should be valid. Example: https://hub.grid.tf/tf-official-apps/base:latest.flist
memory This property is required. Number
The memory capacity for the virtual machine in MB. Min is 250 MB
name This property is required. String
The name of the virtual machine workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
network_name This property is required. String
The name of the network, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported. Network must exist
node_id This property is required. Any
The node ID to deploy the virtual machine on, required and should match the requested resources
description String
The description of the virtual machine workload, optional with no restrictions
entrypoint String
The entry point for the flist. Example: /sbin/zinit init
env_vars Map<String>
The environment variables to be passed to the virtual machine. Example: SSH_KEY
flist_checksum String
The checksum of the flist which should match the checksum of the given flist, optional
gpus List<String>
A list of gpu IDs to be used in the virtual machine. GPU ID format: //. Example: 0000:28:00.0/1002/731f
mounts List<Property Map>
A list of mounted disks or volumes
mycelium Boolean
A flag to generate a random mycelium IP seed to support mycelium in the virtual machine
mycelium_ip_seed String
The seed used for mycelium IP generated for the virtual machine. It's length should be 6
planetary Boolean
A flag to enable generating a yggdrasil IP for the virtual machine
public_ip Boolean
A flag to enable generating a public IP for the virtual machine, public node is required for it
public_ip6 Boolean
A flag to enable generating a public IPv6 for the virtual machine, public node is required for it
rootfs_size Number
The root fs size in GB (type SSD). Can be set as 0 to get the default minimum
zlogs List<Property Map>
A list of virtual machine loggers

ZDBComputed
, ZDBComputedArgs

Ips This property is required. List<string>
Computed IPs of the ZDB. Two IPs are returned: a public IPv6, and a YggIP, in this order
Namespace This property is required. string
Namespace of the ZDB
Port This property is required. int
Port of the ZDB
Ips This property is required. []string
Computed IPs of the ZDB. Two IPs are returned: a public IPv6, and a YggIP, in this order
Namespace This property is required. string
Namespace of the ZDB
Port This property is required. int
Port of the ZDB
ips This property is required. List<String>
Computed IPs of the ZDB. Two IPs are returned: a public IPv6, and a YggIP, in this order
namespace This property is required. String
Namespace of the ZDB
port This property is required. Integer
Port of the ZDB
ips This property is required. string[]
Computed IPs of the ZDB. Two IPs are returned: a public IPv6, and a YggIP, in this order
namespace This property is required. string
Namespace of the ZDB
port This property is required. number
Port of the ZDB
ips This property is required. Sequence[str]
Computed IPs of the ZDB. Two IPs are returned: a public IPv6, and a YggIP, in this order
namespace This property is required. str
Namespace of the ZDB
port This property is required. int
Port of the ZDB
ips This property is required. List<String>
Computed IPs of the ZDB. Two IPs are returned: a public IPv6, and a YggIP, in this order
namespace This property is required. String
Namespace of the ZDB
port This property is required. Number
Port of the ZDB

ZDBInput
, ZDBInputArgs

Name This property is required. string
The name of the 0-db workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Password This property is required. string
The 0-db password
Size This property is required. int
The 0-db size in GB (type HDD)
Description string
The description of the 0-db workload, optional with no restrictions
Mode string
the enumeration of the modes 0-db can operate in (default user)
Public bool
A flag to make 0-db namespace public - readable by anyone
Name This property is required. string
The name of the 0-db workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Password This property is required. string
The 0-db password
Size This property is required. int
The 0-db size in GB (type HDD)
Description string
The description of the 0-db workload, optional with no restrictions
Mode string
the enumeration of the modes 0-db can operate in (default user)
Public bool
A flag to make 0-db namespace public - readable by anyone
name This property is required. String
The name of the 0-db workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
password This property is required. String
The 0-db password
size This property is required. Integer
The 0-db size in GB (type HDD)
description String
The description of the 0-db workload, optional with no restrictions
mode String
the enumeration of the modes 0-db can operate in (default user)
public_ Boolean
A flag to make 0-db namespace public - readable by anyone
name This property is required. string
The name of the 0-db workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
password This property is required. string
The 0-db password
size This property is required. number
The 0-db size in GB (type HDD)
description string
The description of the 0-db workload, optional with no restrictions
mode string
the enumeration of the modes 0-db can operate in (default user)
public boolean
A flag to make 0-db namespace public - readable by anyone
name This property is required. str
The name of the 0-db workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
password This property is required. str
The 0-db password
size This property is required. int
The 0-db size in GB (type HDD)
description str
The description of the 0-db workload, optional with no restrictions
mode str
the enumeration of the modes 0-db can operate in (default user)
public bool
A flag to make 0-db namespace public - readable by anyone
name This property is required. String
The name of the 0-db workload, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
password This property is required. String
The 0-db password
size This property is required. Number
The 0-db size in GB (type HDD)
description String
The description of the 0-db workload, optional with no restrictions
mode String
the enumeration of the modes 0-db can operate in (default user)
public Boolean
A flag to make 0-db namespace public - readable by anyone

Zlog
, ZlogArgs

Output This property is required. string
The output logs URL, should be a valid url
Zmachine This property is required. string
The name of virtual machine, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
Output This property is required. string
The output logs URL, should be a valid url
Zmachine This property is required. string
The name of virtual machine, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
output This property is required. String
The output logs URL, should be a valid url
zmachine This property is required. String
The name of virtual machine, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
output This property is required. string
The output logs URL, should be a valid url
zmachine This property is required. string
The name of virtual machine, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
output This property is required. str
The output logs URL, should be a valid url
zmachine This property is required. str
The name of virtual machine, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported
output This property is required. String
The output logs URL, should be a valid url
zmachine This property is required. String
The name of virtual machine, it's required and cannot exceed 50 characters. Only alphanumeric and underscores characters are supported

Package Details

Repository
threefold threefoldtech/pulumi-threefold
License
Apache-2.0