Skip to content

Commit

Permalink
add mycelium to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Eslam-Nawara committed Jun 10, 2024
1 parent 73da27f commit 5fc7b66
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
5 changes: 4 additions & 1 deletion tfrobot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ vms:
mem: 2 # amount of memory in GB
public_ip4: false
public_ip6: false
ygg_ip: false
mycelium_ip: true
flist: "https://hub.grid.tf/tf-official-apps/threefoldtech-ubuntu-22.04.flist"
entry_point: '/sbin/zinit init'
root_size: 0 # root size in GB, 0 is the default
Expand Down Expand Up @@ -115,7 +117,8 @@ tfrobot deploy -c path/to/your/config.yaml
| node_group | name of node_group the vm belongs to | should be defined in node_groups |
| cpu | number of cpu for vm | nonzero positive integer max = 32 |
| mem | free memory in the vm in GB | min = 0.25, max 256 |
| planetary | should the vm have yggdrasil ip | `true` or `false` |
| ygg_ip | should the vm have yggdrasil ip | `true` or `false` |
| mycelium_ip | should the vm have mycelium ip | `true` or `false` |
| public_ip4 | should the vm have free ip v4 | `true` or `false` |
| public_ip6 | should the vm have free ip v6 | `true` or `false` |
| flist | should be a link to valid flist | valid flist url with `.flist` or `.fl` extension |
Expand Down
1 change: 1 addition & 0 deletions tfrobot/example/conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ vms:
mount_point: /mnt/ssd
public_ip4: false
public_ip6: false
mycelium_ip: true
flist: https://hub.grid.tf/tf-official-apps/base:latest.flist
entry_point: /sbin/zinit init
root_size: 0 # root size in GB, 0 for default root size, max 10TB
Expand Down
1 change: 1 addition & 0 deletions tfrobot/example/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ vms:
- name: example_b #test deployment of vms with ssd storage
vms_count: 20
node_group: group_b
mycelium_ip: true
cpu: 1
mem: 4
ssd:
Expand Down
4 changes: 2 additions & 2 deletions tfrobot/pkg/deployer/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ type Vms struct {
SSDDisks []Disk `yaml:"ssd" json:"ssd"`
PublicIP4 bool `yaml:"public_ip4" json:"public_ip4"`
PublicIP6 bool `yaml:"public_ip6" json:"public_ip6"`
Ygg bool `yaml:"ygg" json:"ygg"`
Mycelium bool `yaml:"mycelium" json:"mycelium"`
Ygg bool `yaml:"ygg_ip" json:"ygg_ip"`
Mycelium bool `yaml:"mycelium_ip" json:"mycelium_ip"`
Flist string `yaml:"flist" validate:"required" json:"flist"`
RootSize uint64 `yaml:"root_size" validate:"max=10240" json:"root_size"` // max 10 TB
Entrypoint string `yaml:"entry_point" validate:"required" json:"entry_point"`
Expand Down

0 comments on commit 5fc7b66

Please sign in to comment.