tfgrid/info_tfgrid
33
3
Fork 0
Code Issues Pull Requests 2 Packages Projects Releases Activity

manual, set internal collections to filename.md template

Browse Source
This commit is contained in:
Mik-TF
2024-05-13 19:28:23 -04:00
parent 280652166f
commit 1836179a75
169 changed files with 709 additions and 709 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
collections/system_administrators/terraform/advanced/terraform_advanced_readme.md
View File

@@ -7,12 +7,12 @@
- [Mounts](./terraform_mounts.html)
- [Capacity Planning](./terraform_capacity_planning.html)
- [Updates](./terraform_updates.html)
- [SSH Connection with Wireguard](./terraform_wireguard_ssh.md)
- [Set a Wireguard VPN](./terraform_wireguard_vpn.md)
- [Synced MariaDB Databases](./terraform_mariadb_synced_databases.md)
- [Nomad](./terraform_nomad.md)
- [Nextcloud Deployments](./terraform_nextcloud_toc.md)
- [Nextcloud All-in-One Deployment](./terraform_nextcloud_aio.md)
- [Nextcloud Single Deployment](./terraform_nextcloud_single.md)
- [Nextcloud Redundant Deployment](./terraform_nextcloud_redundant.md)
- [Nextcloud 2-Node VPN Deployment](./terraform_nextcloud_vpn.md)
- [SSH Connection with Wireguard](terraform_wireguard_ssh.md)
- [Set a Wireguard VPN](terraform_wireguard_vpn.md)
- [Synced MariaDB Databases](terraform_mariadb_synced_databases.md)
- [Nomad](terraform_nomad.md)
- [Nextcloud Deployments](terraform_nextcloud_toc.md)
- [Nextcloud All-in-One Deployment](terraform_nextcloud_aio.md)
- [Nextcloud Single Deployment](terraform_nextcloud_single.md)
- [Nextcloud Redundant Deployment](terraform_nextcloud_redundant.md)
- [Nextcloud 2-Node VPN Deployment](terraform_nextcloud_vpn.md)

2
collections/system_administrators/terraform/advanced/terraform_capacity_planning.md
View File

@@ -117,7 +117,7 @@ resource "grid_scheduler" "sched" {
Here we define a `list` of requests, each request has a name and filter options e.g `cru`, `sru`, `mru`, `hru`, having `public_config` or not, `public_ips_count` for this deployment, whether or not this node should be `dedicated`, whether or not this node should be `distinct` from other nodes in this plannder, `farm_id` to search in, nodes to exlude from search in `node_exclude`, and whether or not this node should be `certified`.
The full docs for the capacity planner `scheduler` are found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/resources/scheduler.md)
The full docs for the capacity planner `scheduler` are found [here](scheduler.md)
And after that in our code we can reference the grid_scheduler object with the request name to be used instead of node_id.

4
collections/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md
View File

@@ -305,7 +305,7 @@ Note that, at any moment, if you want to see the information on your Terraform d
### SSH into the 3Nodes
* To [SSH into the 3Nodes](../../getstarted/ssh_guide/ssh_guide.md), write the following while making sure to set the proper IP address for each VM:
* To [SSH into the 3Nodes](ssh_guide.md), write the following while making sure to set the proper IP address for each VM:
* ```
ssh root@3node_IPv4_Address
```
@@ -362,7 +362,7 @@ This should set everything properly.
If you correctly receive the packets for the two VMs, you know that the VPN is properly set.
For more information on WireGuard, notably in relation to Windows, please read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md).
For more information on WireGuard, notably in relation to Windows, please read [this documentation](ssh_wireguard.md).

2
collections/system_administrators/terraform/advanced/terraform_nextcloud_aio.md
View File

@@ -20,7 +20,7 @@ We present a quick way to install Nextcloud All-in-One on the TFGrid. This guide
## Deploy a Full VM
* Deploy a Full VM with the [TF Dashboard](../../getstarted/ssh_guide/ssh_openssh.md) or [Terraform](../terraform_full_vm.md)
* Deploy a Full VM with the [TF Dashboard](ssh_openssh.md) or [Terraform](terraform_full_vm.md)
* Minimum specs:
* IPv4 Address
* 2 vcores

6
collections/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md
View File

@@ -75,7 +75,7 @@ To get an overview of the whole process, we present the main steps:
# Prerequisites
* [Install Terraform](../terraform_install.md)
* [Install Terraform](terraform_install.md)
* [Install Wireguard](https://www.wireguard.com/install/)
You need to download and install properly Terraform and Wireguard on your local computer. Simply follow the documentation depending on your operating system (Linux, MAC and Windows).
@@ -320,7 +320,7 @@ After deployments, take note of the 3nodes' IPv4 address. You will need those ad
### SSH into the 3nodes
* To [SSH into the 3nodes](../../getstarted/ssh_guide/ssh_guide.md), write the following:
* To [SSH into the 3nodes](ssh_guide.md), write the following:
* ```
ssh root@VM_IPv4_Address
```
@@ -343,7 +343,7 @@ After deployments, take note of the 3nodes' IPv4 address. You will need those ad
We now want to ping the VMs using Wireguard. This will ensure the connection is properly established.
For more information on WireGuard, notably in relation to Windows, please read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md).
For more information on WireGuard, notably in relation to Windows, please read [this documentation](ssh_wireguard.md).
First, we set Wireguard with the Terraform output.

4
collections/system_administrators/terraform/advanced/terraform_nextcloud_single.md
View File

@@ -61,7 +61,7 @@ To get an overview of the whole process, we present the main steps:
# Prerequisites
- [Install Terraform](../terraform_install.md)
- [Install Terraform](terraform_install.md)
You need to download and install properly Terraform on your local computer. Simply follow the documentation depending on your operating system (Linux, MAC and Windows).
@@ -262,7 +262,7 @@ After deployments, take note of the 3Node's IPv4 address. You will need this add
## SSH into the 3Node
* To [SSH into the 3Node](../../getstarted/ssh_guide/ssh_guide.md), write the following:
* To [SSH into the 3Node](ssh_guide.md), write the following:
* ```
ssh root@VM_IPv4_Address
```

8
collections/system_administrators/terraform/advanced/terraform_nextcloud_toc.md
View File

@@ -4,7 +4,7 @@ We present here different Nextcloud deployments. While this section is focused o
<h2> Table of Contents </h2>
- [Nextcloud All-in-One Deployment](./terraform_nextcloud_aio.md)
- [Nextcloud Single Deployment](./terraform_nextcloud_single.md)
- [Nextcloud Redundant Deployment](./terraform_nextcloud_redundant.md)
- [Nextcloud 2-Node VPN Deployment](./terraform_nextcloud_vpn.md)
- [Nextcloud All-in-One Deployment](terraform_nextcloud_aio.md)
- [Nextcloud Single Deployment](terraform_nextcloud_single.md)
- [Nextcloud Redundant Deployment](terraform_nextcloud_redundant.md)
- [Nextcloud 2-Node VPN Deployment](terraform_nextcloud_vpn.md)

6
collections/system_administrators/terraform/advanced/terraform_nomad.md
View File

@@ -42,7 +42,7 @@ Nomad's versatility extends beyond its user-friendliness. It seamlessly handles
You need to download and install properly Terraform and Wireguard on your local computer. Simply follow the documentation depending on your operating system (Linux, MAC and Windows).
If you are new to Terraform, feel free to read this basic [Terraform Full VM guide](../terraform_full_vm.md) to get you started.
If you are new to Terraform, feel free to read this basic [Terraform Full VM guide](terraform_full_vm.md) to get you started.
@@ -299,7 +299,7 @@ Note that the IP addresses will be shown under `Outputs` after running the comma
### SSH with the Planetary Network
* To [SSH with the Planetary network](../../getstarted/ssh_guide/ssh_openssh.md), write the following with the proper IP address
* To [SSH with the Planetary network](ssh_openssh.md), write the following with the proper IP address
* ```
ssh root@planetary_ip
```
@@ -334,7 +334,7 @@ We are now ready to SSH into the client and server nodes with WireGuard.
ssh root@wg_ip
```
You now have an SSH connection access over WireGuard to the client and server nodes of your Nomad cluster. For more information on connecting with WireGuard, read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md).
You now have an SSH connection access over WireGuard to the client and server nodes of your Nomad cluster. For more information on connecting with WireGuard, read [this documentation](ssh_wireguard.md).

2
collections/system_administrators/terraform/advanced/terraform_provider.md
View File

@@ -49,5 +49,5 @@ The *_URL variables can be used to override the dafault urls associated with the
## Remarks
- Grid terraform provider is hosted on terraform registry [here](https://registry.terraform.io/providers/threefoldtech/grid/latest/docs?pollNotifications=true)
- All provider input variables and their description can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/index.md)
- All provider input variables and their description can be found [here](index.md)
- Capitalized environment variables can be used instead of writing them in the provider (e.g. MNEMONICS)

4
collections/system_administrators/terraform/advanced/terraform_wireguard_ssh.md
View File

@@ -22,7 +22,7 @@ In this ThreeFold Guide, we show how simple it is to deploy a micro VM on the Th
## Prerequisites
* [Install Terraform](../terraform_install.md)
* [Install Terraform](terraform_install.md)
* [Install Wireguard](https://www.wireguard.com/install/)
You need to download and install properly Terraform and Wireguard on your local computer. Simply follow the linked documentation depending on your operating system (Linux, MAC and Windows).
@@ -220,7 +220,7 @@ Note that, at any moment, if you want to see the information on your Terraform d
To set the Wireguard connection, on your local computer, you will need to take the Terraform `wg_config` output and create a `wg.conf` file in the directory: `/usr/local/etc/wireguard/wg.conf`. Note that the Terraform output starts and ends with EOT.
For more information on WireGuard, notably in relation to Windows, please read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md).
For more information on WireGuard, notably in relation to Windows, please read [this documentation](ssh_wireguard.md).
* Create a file named `wg.conf` in the directory: `/usr/local/etc/wireguard/wg.conf`.
* ```

4
collections/system_administrators/terraform/advanced/terraform_wireguard_vpn.md
View File

@@ -23,7 +23,7 @@ Note that this concept can be extended with more than two micro VMs. Once you un
## Prerequisites
* [Install Terraform](../terraform_install.md)
* [Install Terraform](terraform_install.md)
* [Install Wireguard](https://www.wireguard.com/install/)
You need to download and install properly Terraform and Wireguard on your local computer. Simply follow the linked documentation depending on your operating system (Linux, MAC and Windows).
@@ -276,7 +276,7 @@ Note that, at any moment, if you want to see the information on your Terraform d
To set the Wireguard connection, on your local computer, you will need to take the terraform `wg_config` output and create a `wg.conf` file in the directory: `/usr/local/etc/wireguard/wg.conf`. Note that the Terraform output starts and ends with EOT.
For more information on WireGuard, notably in relation to Windows, please read [this documentation](../../getstarted/ssh_guide/ssh_wireguard.md).
For more information on WireGuard, notably in relation to Windows, please read [this documentation](ssh_wireguard.md).
* Create a file named `wg.conf` in the directory: `/usr/local/etc/wireguard/wg.conf`.
* ```

2
collections/system_administrators/terraform/resources/terraform_k8s.md
View File

@@ -199,7 +199,7 @@ We will be mainly interested in the master node public ip `computed IP` and the
## More Info
A complete list of k8s resource parameters can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/resources/kubernetes.md).
A complete list of k8s resource parameters can be found [here](kubernetes.md).
## Demo Video

4
collections/system_administrators/terraform/resources/terraform_qsfs.md
View File

@@ -2,8 +2,8 @@
<h2> Table of Contents </h2>
- [QSFS on Micro VM](./terraform_qsfs_on_microvm.md)
- [QSFS on Full VM](./terraform_qsfs_on_full_vm.md)
- [QSFS on Micro VM](terraform_qsfs_on_microvm.md)
- [QSFS on Full VM](terraform_qsfs_on_full_vm.md)
***

4
collections/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md
View File

@@ -23,7 +23,7 @@ The main goal of this guide is to show you all the necessary steps to deploy a F
## Prerequisites
- [Install Terraform](../terraform_install.md)
- [Install Terraform](terraform_install.md)
You need to download and install properly Terraform. Simply follow the documentation depending on your operating system (Linux, MAC and Windows).
@@ -36,7 +36,7 @@ Deploying a FullVM is a bit different than deploying a MicroVM, let take a look
- QSFS disk is based on `virtiofs`, and you can't use QSFS disk as the first mount in a FullVM, instead you need a regular disk.
- Any extra disks/mounts will be available on the vm but unlike mounts on MicroVMs, extra disks won't be mounted automatically. you will need to mount it manually after the deployment.
Let modify the qsfs-on-microVM [example](./terraform_qsfs_on_microvm.md) to deploy a QSFS on FullVM this time:
Let modify the qsfs-on-microVM [example](terraform_qsfs_on_microvm.md) to deploy a QSFS on FullVM this time:
- Inside the `grid_deployment` resource we will need to add a disk for the vm root fs.

2
collections/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md
View File

@@ -23,7 +23,7 @@ In this ThreeFold Guide, we will learn how to deploy a Quantum Safe File System
In this guide, we will be using Terraform to deploy a QSFS workload on a micro VM that runs on the TFGrid. Make sure to have the latest Terraform version.
- [Install Terraform](../terraform_install.md)
- [Install Terraform](terraform_install.md)

8
collections/system_administrators/terraform/resources/terraform_resources_readme.md
View File

@@ -2,12 +2,12 @@
<h2> Table of Contents </h2>
- [Using Scheduler](./terraform_scheduler.md)
- [Using Scheduler](terraform_scheduler.md)
- [Virtual Machine](./terraform_vm.html)
- [Web Gateway](./terraform_vm_gateway.html)
- [Kubernetes Cluster](./terraform_k8s.html)
- [ZDB](./terraform_zdb.html)
- [Quantum Safe Filesystem](./terraform_qsfs.md)
- [QSFS on Micro VM](./terraform_qsfs_on_microvm.md)
- [QSFS on Full VM](./terraform_qsfs_on_full_vm.md)
- [Quantum Safe Filesystem](terraform_qsfs.md)
- [QSFS on Micro VM](terraform_qsfs_on_microvm.md)
- [QSFS on Full VM](terraform_qsfs_on_full_vm.md)
- [CapRover](./terraform_caprover.html)

4
collections/system_administrators/terraform/resources/terraform_vm.md
View File

@@ -171,7 +171,7 @@ It's bit long for sure but let's try to dissect it a bit
## Which flists to use
see [list of flists](../../../developers/flist/grid3_supported_flists.md)
see [list of flists](grid3_supported_flists.md)
## Remark multiple VMs
@@ -204,7 +204,7 @@ So to add a VM
```
- We give it a name within our deployment `vm1`
- `flist` is used to define the flist to run within the VM. Check the [list of flists](../../../developers/flist/grid3_supported_flists.md)
- `flist` is used to define the flist to run within the VM. Check the [list of flists](grid3_supported_flists.md)
- `cpu` and `memory` are used to define the cpu and memory
- `publicip` is usued to define if it requires a public IP or not
- `entrypoint` is used define the entrypoint which in most of the cases in `/sbin/zinit init`, but in case of flists based on vms it can be specific to each flist

4
collections/system_administrators/terraform/resources/terraform_vm_gateway.md
View File

@@ -15,7 +15,7 @@ In this section, we provide the basic information for a VM web gateway using Ter
## Expose with Prefix
A complete list of gateway name workload parameters can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/resources/name_proxy.md).
A complete list of gateway name workload parameters can be found [here](name_proxy.md).
```
terraform {
@@ -93,7 +93,7 @@ Here
## Expose with Full Domain
A complete list of gateway fqdn workload parameters can be found [here](https://github.com/threefoldtech/terraform-provider-grid/blob/development/docs/resources/fqdn_proxy.md).
A complete list of gateway fqdn workload parameters can be found [here](fqdn_proxy.md).
it is more like the above example the only difference is you need to create an `A record` on your name provider for `remote.omar.grid.tf` to gateway node `7` IPv4.

12
collections/system_administrators/terraform/terraform_basics.md
View File

@@ -24,14 +24,14 @@
We cover some important aspects of Terraform deployments on the ThreeFold Grid.
For a complete guide on deploying a full VM on the TFGrid, read [this documentation](./terraform_full_vm.md).
For a complete guide on deploying a full VM on the TFGrid, read [this documentation](terraform_full_vm.md).
## Requirements
Here are the requirements to use Terraform on the TFGrid:
- [Set your TFGrid account](../getstarted/tfgrid3_getstarted.md)
- [Install Terraform](../terraform/terraform_install.md)
- [Set your TFGrid account](tfgrid3_getstarted.md)
- [Install Terraform](terraform_install.md)
## Basic Commands
@@ -48,7 +48,7 @@ Here are some very useful commands to use with Terraform:
There are two options when it comes to finding a node to deploy on. You can use the scheduler or search for a node with the Nodes Explorer.
- Use the [scheduler](resources/terraform_scheduler.md)
- Use the [scheduler](terraform_scheduler.md)
- Scheduler will help you find a node that matches your criteria
- Use the Nodes Explorer
- You can check the [Node Finder](dashboard@@node_finder) to know which nodes fits your deployment criteria.
@@ -117,7 +117,7 @@ When writing the main file, you can decide to leave a variable content empty. In
export NETWORK="..."
```
For more info, consult the [Provider Manual](./advanced/terraform_provider.md).
For more info, consult the [Provider Manual](terraform_provider.md).
### Output Section
@@ -184,4 +184,4 @@ This gives you the following benefits:
## Conclusion
This was a quick introduction to Terraform, for a complete guide, please read [this documentation](./terraform_full_vm.md). For advanced tutorials and deployments, read [this section](./advanced/terraform_advanced_readme.md). To learn more about the different resources to deploy with Terraform on the TFGrid, read [this section](./resources/terraform_resources_readme.md).
This was a quick introduction to Terraform, for a complete guide, please read [this documentation](terraform_full_vm.md). For advanced tutorials and deployments, read [this section](terraform_advanced_readme.md). To learn more about the different resources to deploy with Terraform on the TFGrid, read [this section](terraform_resources_readme.md).

6
collections/system_administrators/terraform/terraform_full_vm.md
View File

@@ -42,7 +42,7 @@ Once this is done, initialize and apply Terraform to deploy your workload, then
## Prerequisites
- [Install Terraform](./terraform_install.md)
- [Install Terraform](terraform_install.md)
You need to download and install properly Terraform. Simply follow the documentation depending on your operating system (Linux, MAC and Windows).
@@ -58,7 +58,7 @@ We present two options to find a suitable node: the scheduler and the TFGrid Exp
### Using the Grid Scheduler
Using the TFGrid scheduler can be very efficient depending on what you are trying to achieve. To learn more about the scheduler, please refer to this [Scheduler Guide](resources/terraform_scheduler.md).
Using the TFGrid scheduler can be very efficient depending on what you are trying to achieve. To learn more about the scheduler, please refer to this [Scheduler Guide](terraform_scheduler.md).
@@ -254,7 +254,7 @@ After deployments, take note of the 3Node' IPv4 address. You will need this addr
## SSH into the 3Node
- To [SSH into the 3Node](../getstarted/ssh_guide/ssh_guide.md), write the following:
- To [SSH into the 3Node](ssh_guide.md), write the following:
- ```
ssh root@VM_IPv4_Address
```

4
collections/system_administrators/terraform/terraform_get_started.md
View File

@@ -56,7 +56,7 @@ export NETWORK="....."
```
For more info see [Provider Manual](./advanced/terraform_provider.md)
For more info see [Provider Manual](terraform_provider.md)
### output section
@@ -84,4 +84,4 @@ Output parameters show what has been done:
### Which flists to use in VM
see [list of flists](../manual3_iac/grid3_supported_flists.md)
see [list of flists](grid3_supported_flists.md)

60
collections/system_administrators/terraform/terraform_toc.md
View File

@@ -2,33 +2,33 @@
<h2>Table of Contents</h2>
- [Overview](./terraform_readme.md)
- [Installing Terraform](./terraform_install.md)
- [Terraform Basics](./terraform_basics.md)
- [Full VM Deployment](./terraform_full_vm.md)
- [GPU Support](./terraform_gpu_support.md)
- [Resources](./resources/terraform_resources_readme.md)
- [Using Scheduler](./resources/terraform_scheduler.md)
- [Virtual Machine](./resources/terraform_vm.md)
- [Web Gateway](./resources/terraform_vm_gateway.md)
- [Kubernetes Cluster](./resources/terraform_k8s.md)
- [ZDB](./resources/terraform_zdb.md)
- [Quantum Safe Filesystem](./resources/terraform_qsfs.md)
- [QSFS on Micro VM](./resources/terraform_qsfs_on_microvm.md)
- [QSFS on Full VM](./resources/terraform_qsfs_on_full_vm.md)
- [CapRover](./resources/terraform_caprover.md)
- [Advanced](./advanced/terraform_advanced_readme.md)
- [Terraform Provider](./advanced/terraform_provider.md)
- [Terraform Provisioners](./advanced/terraform_provisioners.md)
- [Mounts](./advanced/terraform_mounts.md)
- [Capacity Planning](./advanced/terraform_capacity_planning.md)
- [Updates](./advanced/terraform_updates.md)
- [SSH Connection with Wireguard](./advanced/terraform_wireguard_ssh.md)
- [Set a Wireguard VPN](./advanced/terraform_wireguard_vpn.md)
- [Synced MariaDB Databases](./advanced/terraform_mariadb_synced_databases.md)
- [Nomad](./advanced/terraform_nomad.md)
- [Nextcloud Deployments](./advanced/terraform_nextcloud_toc.md)
- [Nextcloud All-in-One Deployment](./advanced/terraform_nextcloud_aio.md)
- [Nextcloud Single Deployment](./advanced/terraform_nextcloud_single.md)
- [Nextcloud Redundant Deployment](./advanced/terraform_nextcloud_redundant.md)
- [Nextcloud 2-Node VPN Deployment](./advanced/terraform_nextcloud_vpn.md)
- [Overview](terraform_readme.md)
- [Installing Terraform](terraform_install.md)
- [Terraform Basics](terraform_basics.md)
- [Full VM Deployment](terraform_full_vm.md)
- [GPU Support](terraform_gpu_support.md)
- [Resources](terraform_resources_readme.md)
- [Using Scheduler](terraform_scheduler.md)
- [Virtual Machine](terraform_vm.md)
- [Web Gateway](terraform_vm_gateway.md)
- [Kubernetes Cluster](terraform_k8s.md)
- [ZDB](terraform_zdb.md)
- [Quantum Safe Filesystem](terraform_qsfs.md)
- [QSFS on Micro VM](terraform_qsfs_on_microvm.md)
- [QSFS on Full VM](terraform_qsfs_on_full_vm.md)
- [CapRover](terraform_caprover.md)
- [Advanced](terraform_advanced_readme.md)
- [Terraform Provider](terraform_provider.md)
- [Terraform Provisioners](terraform_provisioners.md)
- [Mounts](terraform_mounts.md)
- [Capacity Planning](terraform_capacity_planning.md)
- [Updates](terraform_updates.md)
- [SSH Connection with Wireguard](terraform_wireguard_ssh.md)
- [Set a Wireguard VPN](terraform_wireguard_vpn.md)
- [Synced MariaDB Databases](terraform_mariadb_synced_databases.md)
- [Nomad](terraform_nomad.md)
- [Nextcloud Deployments](terraform_nextcloud_toc.md)
- [Nextcloud All-in-One Deployment](terraform_nextcloud_aio.md)
- [Nextcloud Single Deployment](terraform_nextcloud_single.md)
- [Nextcloud Redundant Deployment](terraform_nextcloud_redundant.md)
- [Nextcloud 2-Node VPN Deployment](terraform_nextcloud_vpn.md)