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

finalized info_fgrid sync

Browse Source
This commit is contained in:
mik-tf
2024-08-29 19:22:26 -04:00
parent a75e59d42c
commit 0c33119601
53 changed files with 1088 additions and 571 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -9,6 +9,4 @@
- [ZDB](./terraform_zdb.html)
- [Zlogs](./terraform_zlogs.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)

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

@@ -1,4 +1,4 @@
<h1>Terraform Complete Full VM Deployment</h1>
<h1>Terraform Full VM Deployment</h1>
<h2>Table of Contents</h2>
@@ -22,7 +22,7 @@ This short ThreeFold Guide will teach you how to deploy a Full VM on the TFGrid
The steps are very simple. You first need to create the Terraform files, the variables file and the deployment file, and then deploy the full VM. After the deployment is done, you can SSH into the full VM.
The main goal of this guide is to show you all the necessary steps to deploy a Full VM on the TGrid using Terraform. Once you get acquainted with this first basic deployment, you should be able to explore on your own the possibilities that the TFGrid and Terraform combined provide.
The main goal of this guide is to show you all the necessary steps to deploy a Full VM on the TFGrid using Terraform. Once you get acquainted with this first basic deployment, you should be able to explore on your own the possibilities that the TFGrid and Terraform combined provide.
@@ -71,10 +71,11 @@ We show here how to find a suitable 3Node using the ThreeFold Explorer.
- For proper understanding, we give further information on some relevant columns:
- `ID` refers to the node ID
- `Free Public IPs` refers to available IPv4 public IP addresses
- `HRU` refers to HDD storage
- `SRU` refers to SSD storage
- `MRU` refers to RAM (memory)
- `CRU` refers to virtual cores (vcores)
- Resource unit codes (consult [this page](cloud@@esource_units_calc_cloudunits) for more information)
- `HRU` is the code for the HDD unit (storage capacity in GB)
- `SRU` is the code for the SSD unit (storage capacity in GB)
- `MRU` is the code for the the memory unit (memory capacity in GB)
- `CRU` is the code for the core unit (virtual cores capacity)
- To quicken the process of finding a proper 3Node, you can narrow down the search by adding filters:
- At the top left of the screen, in the `Filters` box, select the parameter(s) you want.
- For each parameter, a new field will appear where you can enter a minimum number requirement for the 3Nodes.
@@ -227,11 +228,9 @@ cpu = "1"
memory = "512"
```
Make sure to add your own seed phrase and SSH public key. You will also need to specify the node ID of the server used. Simply replace the three dots by the content.
We set here the minimum specs for a full VM, but you can adjust these parameters.
Make sure to add your own mnemonics and SSH public key. You will also need to specify the node ID of the server used. Simply replace the three dots by the content.
We set here the minimum specs for a full VM, but you can adjust these parameters. Here `size` is the SSD storage capacity in GB, `cpu` is the number of virtual core and `memory` is the memory capacity in MB.
## Deploy the Full VM with Terraform
@@ -275,6 +274,4 @@ Make sure that you are in the Terraform directory you created for this deploymen
## Conclusion
You now have the basic knowledge and know-how to deploy on the TFGrid using Terraform.
As always, if you have any questions, you can ask the ThreeFold community for help on the [ThreeFold Forum](http://forum.threefold.io/) or on the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram.
You now have the basic knowledge and know-how to deploy on the TFGrid using Terraform.

29
collections/system_administrators/terraform/terraform_install.md
View File

@@ -4,11 +4,10 @@
- [Introduction](#introduction)
- [Install Terraform](#install-terraform)
- [Install Terraform on Linux](#install-terraform-on-linux)
- [Install Terraform on MAC](#install-terraform-on-mac)
- [Install Terraform on Windows](#install-terraform-on-windows)
- [Linux](#linux)
- [MacOS](#macos)
- [Windows](#windows)
- [ThreeFold Terraform Plugin](#threefold-terraform-plugin)
- [Questions and Feedback](#questions-and-feedback)
***
@@ -22,32 +21,28 @@ You can get Terraform from the Terraform website [download page](https://www.ter
We cover here the basic steps for Linux, MAC and Windows for convenience. Refer to the official Terraform documentation if needed.
### Install Terraform on Linux
### Linux
To install Terraform on Linux, we follow the official [Terraform documentation](https://developer.hashicorp.com/terraform/downloads).
* [Install Terraform on Linux](../computer_it_basics/cli_scripts_basics.md#install-terraform)
* [Install Terraform on Linux](cli_scripts_basics.md#install-terraform)
### Install Terraform on MAC
### MacOS
To install Terraform on MAC, install Brew and then install Terraform.
* [Install Brew](../computer_it_basics/cli_scripts_basics.md#install-brew)
* [Install Terraform with Brew](../computer_it_basics/cli_scripts_basics.md#install-terraform-with-brew)
* [Install Brew](cli_scripts_basics.md#install-brew)
* [Install Terraform with Brew](cli_scripts_basics.md#install-terraform-with-brew)
### Install Terraform on Windows
### Windows
To install Terraform on Windows, a quick way is to first install Chocolatey and then install Terraform.
* [Install Chocolatey](../computer_it_basics/cli_scripts_basics.md#install-chocolatey)
* [Install Terraform with Chocolatey](../computer_it_basics/cli_scripts_basics.md#install-terraform-with-chocolatey)
* [Install Chocolatey](cli_scripts_basics.md#install-chocolatey)
* [Install Terraform with Chocolatey](cli_scripts_basics.md#install-terraform-with-chocolatey)
## ThreeFold Terraform Plugin
The ThreeFold [Terraform plugin](https://github.com/threefoldtech/terraform-provider-grid) is supported on Linux, MAC and Windows.
There's no need to specifically install the ThreeFold Terraform plugin. Terraform will automatically load it from an online directory according to instruction within the deployment file.
## Questions and Feedback
If you have any questions, let us know by writing a post on the [Threefold Forum](http://forum.threefold.io/) or by reaching out to the [ThreeFold Grid Tester Community](https://t.me/threefoldtesting) on Telegram.
There's no need to specifically install the ThreeFold Terraform plugin. Terraform will automatically load it from an online directory according to instruction within the deployment file.

36
collections/system_administrators/terraform/terraform_readme.md
View File

@@ -1,16 +1,12 @@
<h1> Terraform </h1>
Welcome to the *Terraform* section of the ThreeFold Manual!
In this section, we'll embark on a journey to explore the powerful capabilities of Terraform within the ThreeFold Grid ecosystem. Terraform, a cutting-edge infrastructure as code (IaC) tool, empowers you to define and provision your infrastructure efficiently and consistently.
<h1> Introduction to Terraform </h1>
<h2>Table of Contents</h2>
- [What is Terraform?](#what-is-terraform)
- [Terraform on ThreeFold Grid: Unleashing Power and Simplicity](#terraform-on-threefold-grid-unleashing-power-and-simplicity)
- [Get Started](#get-started)
- [Deployment Examples](#deployment-examples)
- [Features](#features)
- [What is Not Supported](#what-is-not-supported)
- [OpenTofu: Alternative to Terraform](#opentofu-alternative-to-terraform)
@@ -19,32 +15,36 @@ In this section, we'll embark on a journey to explore the powerful capabilities
## What is Terraform?
Terraform is an open-source tool that enables you to describe and deploy infrastructure using a declarative configuration language. With Terraform, you can define your infrastructure components, such as virtual machines, networks, and storage, in a human-readable configuration file. This file, often referred to as the Terraform script, becomes a blueprint for your entire infrastructure.
[Terraform](https://www.terraform.io/) is an open-source tool that enables you to describe and deploy infrastructure using a declarative configuration language. With Terraform, you can define your infrastructure components, such as virtual machines, networks, and storage, in a human-readable configuration file. This file, often referred to as the Terraform script, becomes a blueprint for your entire infrastructure.
The beauty of Terraform lies in its ability to automate the provisioning and management of infrastructure across various cloud providers, ensuring that your deployments are reproducible and scalable. It promotes collaboration, version control, and the ability to treat your infrastructure as code, providing a unified and seamless approach to managing complex environments.
## Terraform on ThreeFold Grid: Unleashing Power and Simplicity
Within the ThreeFold Grid ecosystem, Terraform plays a pivotal role in streamlining the deployment and orchestration of decentralized, peer-to-peer infrastructure. Leveraging the unique capabilities of the ThreeFold Grid, you can use Terraform to define and deploy your workloads, tapping into the TFGrid decentralized architecture for unparalleled scalability, reliability, and sustainability.
This manual will guide you through the process of setting up, configuring, and managing your infrastructure on the ThreeFold Grid using Terraform. Whether you're a seasoned developer, a DevOps professional, or someone exploring the world of decentralized computing for the first time, this guide is designed to provide clear and concise instructions to help you get started.
This section of the manual will guide you through the process of setting up, configuring, and managing your infrastructure on the ThreeFold Grid using Terraform. Whether you're a seasoned developer, a DevOps professional, or someone exploring the world of decentralized computing for the first time, this guide is designed to provide clear and concise instructions to help you get started.
## Get Started
![ ](../terraform/img//terraform_works.png)
To get started, [install Terraform](./terraform_install.md) and [deploy a full VM](./terraform_full_vm.md) on the grid with Terraform.
Threefold loves Open Source! In v3.0 we are integrating one of the most popular 'Infrastructure as Code' (IaC) tools of the cloud industry, [Terraform](https://terraform.io). Utilizing the Threefold grid v3 using Terraform gives a consistent workflow and a familiar experience for everyone coming from different background. Terraform describes the state desired of how the deployment should look like instead of imperatively describing the low level details and the mechanics of how things should be glued together.
Once you're acquainted with the basics, you can explore different [Terraform deployment examples](https://github.com/threefoldtech/terraform-provider-grid/tree/development/examples).
## Deployment Examples
Consult the ThreeFold `terraform-provider-grid` repo for different [Terraform deployment examples](https://github.com/threefoldtech/terraform-provider-grid/tree/development/examples).
You can also read the [Resources](terraform_resources_readme.md) section for more details on different Terraform deployments.
## Features
- All basic primitives from ThreeFold grid can be deployed, which is a lot.
- Terraform can destroy a deployment
- All basic primitives from ThreeFold grid can be deployed
- Terraform can destroy deployments
- Terraform shows all the outputs
## What is Not Supported
- we don't support updates/upgrades, if you want a change you need to destroy a deployment & re-create your deployment this in case you want to change the current running instances properties or change the node, but adding a vm to an existing deployment this shouldn't affect other running vm and same if we need to decommission a vm from a deployment this also shouldn't affect the others
- We do not support updates nor upgrades.
- If you want a change, you need to destroy a deployment & re-create your deployment in case you want to change the current running instances properties or change the node.
- Adding a VM to an existing deployment or decommissioning a vm from a deployment shouldn't affect other running VMs.
## OpenTofu: Alternative to Terraform
[OpenTofu](https://opentofu.org/) is a fully open-source Terraform fork that is backward compatible with all prior versions of Terraform up to version 1.6. This alternative can be used instead of Terraform for the following sections. You might need to make changes depending on the version you are working with. Check the [OpenTofu Docs](https://opentofu.org/docs/) for more information.

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

@@ -2,37 +2,12 @@
<h2>Table of Contents</h2>
- [Overview](terraform_readme.md)
- [Introduction to Terraform](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)
- [Zlogs](terraform_zlogs.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)
- [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)
- [Advanced](terraform_advanced_readme.md)