manual, set internal collections to filename.md template
This commit is contained in:
@@ -4,11 +4,11 @@ In this section, we delve into sophisticated topics and powerful functionalities
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Token Transfer Keygenerator](./token_transfer_keygenerator.md)
|
||||
- [Cancel Contracts](./cancel_contracts.md)
|
||||
- [Contract Bills Reports](./contract_bill_report.md)
|
||||
- [Listing Free Public IPs](./list_public_ips.md)
|
||||
- [Redis](./grid3_redis.md)
|
||||
- [IPFS](./ipfs/ipfs_toc.md)
|
||||
- [IPFS on a Full VM](./ipfs/ipfs_fullvm.md)
|
||||
- [IPFS on a Micro VM](./ipfs/ipfs_microvm.md)
|
||||
- [Token Transfer Keygenerator](token_transfer_keygenerator.md)
|
||||
- [Cancel Contracts](cancel_contracts.md)
|
||||
- [Contract Bills Reports](contract_bill_report.md)
|
||||
- [Listing Free Public IPs](list_public_ips.md)
|
||||
- [Redis](grid3_redis.md)
|
||||
- [IPFS](ipfs_toc.md)
|
||||
- [IPFS on a Full VM](ipfs_fullvm.md)
|
||||
- [IPFS on a Micro VM](ipfs_microvm.md)
|
||||
|
@@ -45,4 +45,4 @@ Go to `Extrinsics`, choose the `smartContract` module and `cancelContract` extri
|
||||
|
||||
In order to use the `grid3_client_ts` module, it is essential to first clone our official mono-repo containing the module and then navigate to it. If you are looking for a quick and efficient way to cancel contracts, we offer a code-based solution that can be found [here](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/scripts/delete_all_contracts.ts).
|
||||
|
||||
To make the most of `grid_client`, we highly recommend following our [Grid-Client guide](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/README.md) for a comprehensive overview of the many advanced capabilities offered by this powerful tool. With features like contract creation, modification, and retrieval, `grid_client` provides an intuitive and easy-to-use solution for managing your contracts effectively.
|
||||
To make the most of `grid_client`, we highly recommend following our [Grid-Client guide](README.md) for a comprehensive overview of the many advanced capabilities offered by this powerful tool. With features like contract creation, modification, and retrieval, `grid_client` provides an intuitive and easy-to-use solution for managing your contracts effectively.
|
||||
|
@@ -2,5 +2,5 @@
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [IPFS on a Full VM](./ipfs_fullvm.md)
|
||||
- [IPFS on a Micro VM](./ipfs_microvm.md)
|
||||
- [IPFS on a Full VM](ipfs_fullvm.md)
|
||||
- [IPFS on a Micro VM](ipfs_microvm.md)
|
@@ -6,10 +6,10 @@ In this section, tailored specifically for system administrators, we'll delve in
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [CLI and Scripts Basics](./cli_scripts_basics.md)
|
||||
- [Docker Basics](./docker_basics.md)
|
||||
- [Git and GitHub Basics](./git_github_basics.md)
|
||||
- [Firewall Basics](./firewall_basics/firewall_basics.md)
|
||||
- [UFW Basics](./firewall_basics/ufw_basics.md)
|
||||
- [Firewalld Basics](./firewall_basics/firewalld_basics.md)
|
||||
- [File Transfer](./file_transfer.md)
|
||||
- [CLI and Scripts Basics](cli_scripts_basics.md)
|
||||
- [Docker Basics](docker_basics.md)
|
||||
- [Git and GitHub Basics](git_github_basics.md)
|
||||
- [Firewall Basics](firewall_basics.md)
|
||||
- [UFW Basics](ufw_basics.md)
|
||||
- [Firewalld Basics](firewalld_basics.md)
|
||||
- [File Transfer](file_transfer.md)
|
@@ -164,7 +164,7 @@ docker run --rm quay.io/skopeo/stable list-tags docker://ghcr.io/<repository>/<i
|
||||
|
||||
Make sure to write the proper information for the repository and the image.
|
||||
|
||||
To install Skopeo, read [this documentation](https://github.com/containers/skopeo/blob/main/install.md).
|
||||
To install Skopeo, read [this documentation](install.md).
|
||||
|
||||
|
||||
|
||||
|
@@ -4,5 +4,5 @@ In this section, we cover the basic information concerning Firewall uses on Linu
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [UFW Basics](./ufw_basics.md)
|
||||
- [Firewalld Basics](./firewalld_basics.md)
|
||||
- [UFW Basics](ufw_basics.md)
|
||||
- [Firewalld Basics](firewalld_basics.md)
|
@@ -17,9 +17,9 @@
|
||||
|
||||
In this Threefold Guide, we show how easy it is to deploy a full VM and access Cockpit, a web-based interface to manage servers. For more information on Cockpit, visit this [link](https://cockpit-project.org/).
|
||||
|
||||
For more information on deploying a full VM and using SSH remote connection, read [this SSH guide](../../ssh_guide/ssh_guide.md).
|
||||
For more information on deploying a full VM and using SSH remote connection, read [this SSH guide](ssh_guide.md).
|
||||
|
||||
If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](../../tfgrid3_getstarted.md) of the Threefold Manual.
|
||||
If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](tfgrid3_getstarted.md) of the Threefold Manual.
|
||||
|
||||
Note that the two sections [Change the Network System Daemon](#change-the-network-system-daemon) and [Set a Firewall](#set-a-firewall) are optional. That being said, they provide more features and security to the deployment.
|
||||
|
||||
@@ -27,7 +27,7 @@ Note that the two sections [Change the Network System Daemon](#change-the-networ
|
||||
|
||||
## Deploy a Full VM and Create a Root-Access User
|
||||
|
||||
To start, you must [deploy and SSH into a full VM](../../ssh_guide/ssh_guide.md).
|
||||
To start, you must [deploy and SSH into a full VM](ssh_guide.md).
|
||||
|
||||
* Go to the [Threefold dashboard](https://dashboard.grid.tf/#/)
|
||||
* Deploy a full VM (e.g. Ubuntu 22.04)
|
||||
|
@@ -21,9 +21,9 @@ The Apache Guacamole instance has a two-factor authorization to give further sec
|
||||
|
||||
With Apache Guacamole, a user can access different deployments and command servers remotely, with desktop access.
|
||||
|
||||
This guide can be done on a Windows, MAC, or Linux computer. For more information on deploying a full VM and using SSH remote connection, read this [SSH guide](../../ssh_guide/ssh_guide.md).
|
||||
This guide can be done on a Windows, MAC, or Linux computer. For more information on deploying a full VM and using SSH remote connection, read this [SSH guide](ssh_guide.md).
|
||||
|
||||
If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](../../tfgrid3_getstarted.md) of the Threefold Manual.
|
||||
If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](tfgrid3_getstarted.md) of the Threefold Manual.
|
||||
|
||||
|
||||
|
||||
|
@@ -6,6 +6,6 @@ If you have any questions, or if you would like to see a specific guide on remot
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Cockpit: a Web-based Graphical Interface for Servers](./cockpit_guide/cockpit_guide.md)
|
||||
- [XRDP: an Open-Source Remote Desktop Procol](./xrdp_guide/xrdp_guide.md)
|
||||
- [Apache Guacamole: a Clientless Remote Desktop Gateway.](./guacamole_guide/guacamole_guide.md)
|
||||
- [Cockpit: a Web-based Graphical Interface for Servers](cockpit_guide.md)
|
||||
- [XRDP: an Open-Source Remote Desktop Procol](xrdp_guide.md)
|
||||
- [Apache Guacamole: a Clientless Remote Desktop Gateway.](guacamole_guide.md)
|
||||
|
@@ -18,9 +18,9 @@ We access Ubuntu with a desktop environment to offer a graphical user interface
|
||||
|
||||
This guide can be done on a Windows, MAC, or Linux computer. The only difference will be in the Remote Desktop app. The steps are very similar.
|
||||
|
||||
For more information on deploying a full VM and using SSH remote connection, read this [SSH guide](../../ssh_guide/ssh_guide.md).
|
||||
For more information on deploying a full VM and using SSH remote connection, read this [SSH guide](ssh_guide.md).
|
||||
|
||||
If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](../../tfgrid3_getstarted.md) of the Threefold Manual.
|
||||
If you are new to the Threefold ecosystem and you want to deploy workloads on the Threefold Grid, read the [Get Started section](tfgrid3_getstarted.md) of the Threefold Manual.
|
||||
|
||||
|
||||
|
||||
|
@@ -4,7 +4,7 @@ SSH is a secure protocol used as the primary means of connecting to Linux server
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [SSH with OpenSSH](./ssh_openssh.md)
|
||||
- [SSH with PuTTY](./ssh_putty.md)
|
||||
- [SSH with WSL](./ssh_wsl.md)
|
||||
- [WireGuard Access](./ssh_wireguard.md)
|
||||
- [SSH with OpenSSH](ssh_openssh.md)
|
||||
- [SSH with PuTTY](ssh_putty.md)
|
||||
- [SSH with WSL](ssh_wsl.md)
|
||||
- [WireGuard Access](ssh_wireguard.md)
|
@@ -20,7 +20,7 @@
|
||||
|
||||
# Introduction
|
||||
|
||||
In this Threefold Guide, we show how easy it is to deploy a full virtual machine (VM) and SSH into a 3Node with [OpenSSH](https://www.openssh.com/) on Linux, MAC and Windows with both an IPv4 and a Planetary Network connection. To connect to the 3Node with WireGuard, read [this documentation](./ssh_wireguard.md).
|
||||
In this Threefold Guide, we show how easy it is to deploy a full virtual machine (VM) and SSH into a 3Node with [OpenSSH](https://www.openssh.com/) on Linux, MAC and Windows with both an IPv4 and a Planetary Network connection. To connect to the 3Node with WireGuard, read [this documentation](ssh_wireguard.md).
|
||||
|
||||
To deploy different workloads, the SSH connection process should be very similar.
|
||||
|
||||
|
@@ -19,7 +19,7 @@
|
||||
|
||||
In this Threefold Guide, we show how to set up [WireGuard](https://www.wireguard.com/) to access a 3Node deployment with an SSH connection.
|
||||
|
||||
Note that WireGuard provides the connection to the 3Node deployment. It is up to you to decide which SSH client you want to use. This means that the steps to SSH into a 3Node deployment will be similar to the steps proposed in the guides for [Open-SSH](./ssh_openssh.md), [PuTTy](ssh_putty.md) and [WSL](./ssh_wsl.md). Please refer to [this documentation](./ssh_guide.md) if you have any questions concerning SSH clients. The main difference will be that we connect to the 3Node deployment using a WireGuard connection instead of an IPv4 or a Planetary Network connection.
|
||||
Note that WireGuard provides the connection to the 3Node deployment. It is up to you to decide which SSH client you want to use. This means that the steps to SSH into a 3Node deployment will be similar to the steps proposed in the guides for [Open-SSH](ssh_openssh.md), [PuTTy](ssh_putty.md) and [WSL](ssh_wsl.md). Please refer to [this documentation](ssh_guide.md) if you have any questions concerning SSH clients. The main difference will be that we connect to the 3Node deployment using a WireGuard connection instead of an IPv4 or a Planetary Network connection.
|
||||
|
||||
|
||||
|
||||
@@ -28,15 +28,15 @@ Note that WireGuard provides the connection to the 3Node deployment. It is up to
|
||||
Make sure to [read the introduction](../tfgrid3_getstarted.md#get-started---your-first-deployment) before going further.
|
||||
|
||||
* SSH client of your choice
|
||||
* [Open-SSH](./ssh_openssh.md)
|
||||
* [Open-SSH](ssh_openssh.md)
|
||||
* [PuTTy](ssh_putty.md)
|
||||
* [WSL](./ssh_wsl.md)
|
||||
* [WSL](ssh_wsl.md)
|
||||
|
||||
|
||||
|
||||
# Deploy a Weblet with WireGuard Access
|
||||
|
||||
For this guide on WireGuard access, we deploy a [Full VM](../../../dashboard/solutions/fullVm.md). Note that the whole process is similar with other types of ThreeFold weblets on the Dashboard.
|
||||
For this guide on WireGuard access, we deploy a [Full VM](fullVm.md). Note that the whole process is similar with other types of ThreeFold weblets on the Dashboard.
|
||||
|
||||
* On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine
|
||||
* Choose the parameters you want
|
||||
|
@@ -8,11 +8,11 @@ It's easy to get started on the TFGrid and deploy applications.
|
||||
- [Get TFT](threefold_token@@buy_sell_tft)
|
||||
- [Bridge TFT to TChain](threefold_token@@tft_bridges)
|
||||
- [Deploy an Application](dashboard@@deploy)
|
||||
- [SSH Remote Connection](./ssh_guide/ssh_guide.md)
|
||||
- [SSH with OpenSSH](./ssh_guide/ssh_openssh.md)
|
||||
- [SSH with PuTTY](./ssh_guide/ssh_putty.md)
|
||||
- [SSH with WSL](./ssh_guide/ssh_wsl.md)
|
||||
- [SSH and WireGuard](./ssh_guide/ssh_wireguard.md)
|
||||
- [SSH Remote Connection](ssh_guide.md)
|
||||
- [SSH with OpenSSH](ssh_openssh.md)
|
||||
- [SSH with PuTTY](ssh_putty.md)
|
||||
- [SSH with WSL](ssh_wsl.md)
|
||||
- [SSH and WireGuard](ssh_wireguard.md)
|
||||
|
||||
## Grid Platforms
|
||||
|
||||
@@ -21,11 +21,11 @@ It's easy to get started on the TFGrid and deploy applications.
|
||||
|
||||
## TFGrid Services and Resources
|
||||
|
||||
- [TFGrid Services](./tfgrid_services/tf_grid_services_readme.md)
|
||||
- [TFGrid Services](tf_grid_services_readme.md)
|
||||
|
||||
## Advanced Deployment Techniques
|
||||
|
||||
- [Advanced Topics](../advanced/advanced.md)
|
||||
- [Advanced Topics](advanced.md)
|
||||
|
||||
***
|
||||
|
||||
|
@@ -1,13 +1,13 @@
|
||||
# TFGrid 3.0 Whats There To Know
|
||||
|
||||
- [Storage Concepts](./tfgrid3_storage_concepts.md)
|
||||
- [Network Concepts](./tfgrid3_network_concepts.md)
|
||||
- [Storage Concepts](tfgrid3_storage_concepts.md)
|
||||
- [Network Concepts](tfgrid3_network_concepts.md)
|
||||
|
||||
## Networking
|
||||
|
||||
### Private network (ZNET)
|
||||
|
||||
For a project that needs a private network, we need a network that can span across multiple nodes, this can be achieved by the network workload reservation [Network](/getstarted/tfgrid3_network_concepts.md)
|
||||
For a project that needs a private network, we need a network that can span across multiple nodes, this can be achieved by the network workload reservation [Network](tfgrid3_network_concepts.md)
|
||||
|
||||
### Planetary network
|
||||
|
||||
@@ -35,7 +35,7 @@ As a user, you have two options
|
||||
|
||||
## Compute
|
||||
|
||||
VM workload is the only workload that you will need to run a full blown VM or an [flist-based](/flist_hub/flist_hub.md) container
|
||||
VM workload is the only workload that you will need to run a full blown VM or an [flist-based](flist_hub.md) container
|
||||
|
||||
### How can I create an flist?
|
||||
|
||||
@@ -54,5 +54,5 @@ You can easily check using [explorer-ui](dashboard@@explorer_home) , also to pla
|
||||
|
||||
## Getting started
|
||||
|
||||
Please check [Getting started](/getstarted/tfgrid3_getstarted.md) to get the necessary software / configurations
|
||||
Please check [Getting started](tfgrid3_getstarted.md) to get the necessary software / configurations
|
||||
|
||||
|
@@ -52,7 +52,7 @@ When you have decided which node to reserve, click on **Reserve** under the colu
|
||||
|
||||
## Deploy a VM with GPU
|
||||
|
||||
Now that you've reserverd a dedicated GPU node, it's time to deploy a VM to make use of the GPU! There are many ways to proceed. You can use the [Dashboard](../../dashboard/solutions/fullVm.md), [Go](developers@@grid3_go_gpu), [Terraform](../terraform/terraform_gpu_support.md), etc.
|
||||
Now that you've reserverd a dedicated GPU node, it's time to deploy a VM to make use of the GPU! There are many ways to proceed. You can use the [Dashboard](fullVm.md), [Go](developers@@grid3_go_gpu), [Terraform](terraform_gpu_support.md), etc.
|
||||
|
||||
For example, deploying a VM with GPU on the Dashboard is easy. Simply set the GPU option and make sure to select your dedicated node, as show here:
|
||||

|
||||
@@ -120,4 +120,4 @@ Here are some useful links to troubleshoot your GPU installation.
|
||||
|
||||
## GPU Support Links
|
||||
|
||||
You can consult the [GPU Table of Contents](./gpu_toc.md) to see all available GPU support links on the ThreeFold Manual.
|
||||
You can consult the [GPU Table of Contents](gpu_toc.md) to see all available GPU support links on the ThreeFold Manual.
|
@@ -6,14 +6,14 @@ Feel free to explore the different possibilities!
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [GPU Support](./gpu.md)
|
||||
- [GPU Support](gpu.md)
|
||||
- [Node Finder and GPU](dashboard@@node_finder)
|
||||
- [Javascript Client and GPU](developers@@grid3_javascript_gpu_support)
|
||||
- [GPU and Go](developers@@grid3_go_gpu)
|
||||
- [GPU Support](developers@@grid3_go_gpu_support)
|
||||
- [Deploy a VM with GPU](developers@@grid3_go_vm_with_gpu)
|
||||
- [TFCMD and GPU](developers@@tfcmd_vm)
|
||||
- [Terraform and GPU](../terraform/terraform_gpu_support.md)
|
||||
- [Terraform and GPU](terraform_gpu_support.md)
|
||||
- [Full VM and GPU](dashboard@@fullvm)
|
||||
- [Zero-OS API and GPU](developers@@api)
|
||||
- [GPU Farming](farmers@@gpu_farming)
|
@@ -116,8 +116,8 @@ same data stream used by L3 packets. As such, intermediate nodes can't distingui
|
||||
and message data.
|
||||
|
||||
The primary way to interact with the message system is through [the API](#API). The message API is
|
||||
documented in [here](./api_yaml.md). For some more info about how to
|
||||
use the message system, see [the Message section](./message.md).
|
||||
documented in [here](api_yaml.md). For some more info about how to
|
||||
use the message system, see [the Message section](message.md).
|
||||
|
||||
|
||||
## Inspecting Node Keys
|
||||
|
@@ -13,7 +13,7 @@
|
||||
The message subsystem can be used to send arbitrary length messages to receivers. A receiver is any
|
||||
other node in the network. It can be identified both by its public key, or an IP address in its announced
|
||||
range. The message subsystem can be interacted with both via the HTTP API, which is
|
||||
[documented here](./api_yaml.md), or via the `mycelium` binary. By default, the messages do not interpret
|
||||
[documented here](api_yaml.md), or via the `mycelium` binary. By default, the messages do not interpret
|
||||
the data in any way. When using the binary, the message is slightly modified to include an optional
|
||||
topic at the start of the message. Note that in the HTTP API, all messages are encoded in base64. This
|
||||
might make it difficult to consume these messages without additional tooling.
|
||||
|
@@ -5,10 +5,10 @@ In this section, we present [Mycelium](https://github.com/threefoldtech/mycelium
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Overview](./overview.md)
|
||||
- [Installation](./installation.md)
|
||||
- [Additional Information](./information.md)
|
||||
- [Message](./message.md)
|
||||
- [Packet](./packet.md)
|
||||
- [Data Packet](./data_packet.md)
|
||||
- [API YAML](./api_yaml.md)
|
||||
- [Overview](overview.md)
|
||||
- [Installation](installation.md)
|
||||
- [Additional Information](information.md)
|
||||
- [Message](message.md)
|
||||
- [Packet](packet.md)
|
||||
- [Data Packet](data_packet.md)
|
||||
- [API YAML](api_yaml.md)
|
@@ -29,7 +29,7 @@ Please note that the Pulumi plugin for ThreeFold Grid is not yet officially publ
|
||||
|
||||
## Installation
|
||||
|
||||
If this isn't already done, [install Pulumi](./pulumi_install.md) on your machine.
|
||||
If this isn't already done, [install Pulumi](pulumi_install.md) on your machine.
|
||||
|
||||
## Essential Workflow
|
||||
|
||||
|
@@ -23,7 +23,7 @@ Please note that the Pulumi plugin for ThreeFold Grid is not yet officially publ
|
||||
|
||||
There are a few things to set up before exploring Pulumi. Since we will be using the examples in the ThreeFold Pulumi repository, we must clone the repository before going further.
|
||||
|
||||
* [Install Pulumi](./pulumi_install.md) on your machine
|
||||
* [Install Pulumi](pulumi_install.md) on your machine
|
||||
* Clone the **Pulumi-ThreeFold** repository
|
||||
* ```
|
||||
git clone https://github.com/threefoldtech/pulumi-threefold
|
||||
|
@@ -6,7 +6,7 @@ In this section, we will explore the dynamic world of infrastructure as code (Ia
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Introduction to Pulumi](./pulumi_intro.md)
|
||||
- [Installing Pulumi](./pulumi_install.md)
|
||||
- [Deployment Examples](./pulumi_examples.md)
|
||||
- [Deployment Details](./pulumi_deployment_details.md)
|
||||
- [Introduction to Pulumi](pulumi_intro.md)
|
||||
- [Installing Pulumi](pulumi_install.md)
|
||||
- [Deployment Examples](pulumi_examples.md)
|
||||
- [Deployment Details](pulumi_deployment_details.md)
|
@@ -6,78 +6,78 @@ For complementary information on ThreeFold grid and its cloud component, refer t
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Getting Started](./getstarted/tfgrid3_getstarted.md)
|
||||
- [SSH Remote Connection](./getstarted/ssh_guide/ssh_guide.md)
|
||||
- [SSH with OpenSSH](./getstarted/ssh_guide/ssh_openssh.md)
|
||||
- [SSH with PuTTY](./getstarted/ssh_guide/ssh_putty.md)
|
||||
- [SSH with WSL](./getstarted/ssh_guide/ssh_wsl.md)
|
||||
- [WireGuard Access](./getstarted/ssh_guide/ssh_wireguard.md)
|
||||
- [Remote Desktop and GUI](./getstarted/remote-desktop_gui/remote-desktop_gui.md)
|
||||
- [Cockpit: a Web-based Interface for Servers](./getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md)
|
||||
- [XRDP: an Open-Source Remote Desktop Protocol](./getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md)
|
||||
- [Apache Guacamole: a Clientless Remote Desktop Gateway](./getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md)
|
||||
- [Planetary Network](./getstarted/planetarynetwork.md)
|
||||
- [TFGrid Services](./getstarted/tfgrid_services/tf_grid_services_readme.md)
|
||||
- [GPU](./gpu/gpu_toc.md)
|
||||
- [GPU Support](./gpu/gpu.md)
|
||||
- [Terraform](./terraform/terraform_toc.md)
|
||||
- [Overview](./terraform/terraform_readme.md)
|
||||
- [Installing Terraform](./terraform/terraform_install.md)
|
||||
- [Terraform Basics](./terraform/terraform_basics.md)
|
||||
- [Full VM Deployment](./terraform/terraform_full_vm.md)
|
||||
- [GPU Support](./terraform/terraform_gpu_support.md)
|
||||
- [Resources](./terraform/resources/terraform_resources_readme.md)
|
||||
- [Using Scheduler](./terraform/resources/terraform_scheduler.md)
|
||||
- [Virtual Machine](./terraform/resources/terraform_vm.md)
|
||||
- [Web Gateway](./terraform/resources/terraform_vm_gateway.md)
|
||||
- [Kubernetes Cluster](./terraform/resources/terraform_k8s.md)
|
||||
- [ZDB](./terraform/resources/terraform_zdb.md)
|
||||
- [Quantum Safe Filesystem](./terraform/resources/terraform_qsfs.md)
|
||||
- [QSFS on Micro VM](./terraform/resources/terraform_qsfs_on_microvm.md)
|
||||
- [QSFS on Full VM](./terraform/resources/terraform_qsfs_on_full_vm.md)
|
||||
- [CapRover](./terraform/resources/terraform_caprover.md)
|
||||
- [Advanced](./terraform/advanced/terraform_advanced_readme.md)
|
||||
- [Terraform Provider](./terraform/advanced/terraform_provider.md)
|
||||
- [Terraform Provisioners](./terraform/advanced/terraform_provisioners.md)
|
||||
- [Mounts](./terraform/advanced/terraform_mounts.md)
|
||||
- [Capacity Planning](./terraform/advanced/terraform_capacity_planning.md)
|
||||
- [Updates](./terraform/advanced/terraform_updates.md)
|
||||
- [SSH Connection with Wireguard](./terraform/advanced/terraform_wireguard_ssh.md)
|
||||
- [Set a Wireguard VPN](./terraform/advanced/terraform_wireguard_vpn.md)
|
||||
- [Synced MariaDB Databases](./terraform/advanced/terraform_mariadb_synced_databases.md)
|
||||
- [Nomad](./terraform/advanced/terraform_nomad.md)
|
||||
- [Nextcloud Deployments](./terraform/advanced/terraform_nextcloud_toc.md)
|
||||
- [Nextcloud All-in-One Deployment](./terraform/advanced/terraform_nextcloud_aio.md)
|
||||
- [Nextcloud Single Deployment](./terraform/advanced/terraform_nextcloud_single.md)
|
||||
- [Nextcloud Redundant Deployment](./terraform/advanced/terraform_nextcloud_redundant.md)
|
||||
- [Nextcloud 2-Node VPN Deployment](./terraform/advanced/terraform_nextcloud_vpn.md)
|
||||
- [Pulumi](./pulumi/pulumi_readme.md)
|
||||
- [Introduction to Pulumi](./pulumi/pulumi_intro.md)
|
||||
- [Installing Pulumi](./pulumi/pulumi_install.md)
|
||||
- [Deployment Examples](./pulumi/pulumi_examples.md)
|
||||
- [Deployment Details](./pulumi/pulumi_deployment_details.md)
|
||||
- [Mycelium](./mycelium/mycelium_toc.md)
|
||||
- [Overview](./mycelium/overview.md)
|
||||
- [Installation](./mycelium/installation.md)
|
||||
- [Additional Information](./mycelium/information.md)
|
||||
- [Message](./mycelium/message.md)
|
||||
- [Packet](./mycelium/packet.md)
|
||||
- [Data Packet](./mycelium/data_packet.md)
|
||||
- [API YAML](./mycelium/api_yaml.md)
|
||||
- [Computer and IT Basics](./computer_it_basics/computer_it_basics.md)
|
||||
- [CLI and Scripts Basics](./computer_it_basics/cli_scripts_basics.md)
|
||||
- [Docker Basics](./computer_it_basics/docker_basics.md)
|
||||
- [Git and GitHub Basics](./computer_it_basics/git_github_basics.md)
|
||||
- [Firewall Basics](./computer_it_basics/firewall_basics/firewall_basics.md)
|
||||
- [UFW Basics](./computer_it_basics/firewall_basics/ufw_basics.md)
|
||||
- [Firewalld Basics](./computer_it_basics/firewall_basics/firewalld_basics.md)
|
||||
- [File Transfer](./computer_it_basics/file_transfer.md)
|
||||
- [Advanced](./advanced/advanced.md)
|
||||
- [Token Transfer Keygenerator](./advanced/token_transfer_keygenerator.md)
|
||||
- [Cancel Contracts](./advanced/cancel_contracts.md)
|
||||
- [Contract Bills Reports](./advanced/contract_bill_report.md)
|
||||
- [Listing Free Public IPs](./advanced/list_public_ips.md)
|
||||
- [Redis](./advanced/grid3_redis.md)
|
||||
- [IPFS](./advanced/ipfs/ipfs_toc.md)
|
||||
- [IPFS on a Full VM](./advanced/ipfs/ipfs_fullvm.md)
|
||||
- [IPFS on a Micro VM](./advanced/ipfs/ipfs_microvm.md)
|
||||
- [Getting Started](tfgrid3_getstarted.md)
|
||||
- [SSH Remote Connection](ssh_guide.md)
|
||||
- [SSH with OpenSSH](ssh_openssh.md)
|
||||
- [SSH with PuTTY](ssh_putty.md)
|
||||
- [SSH with WSL](ssh_wsl.md)
|
||||
- [WireGuard Access](ssh_wireguard.md)
|
||||
- [Remote Desktop and GUI](remote-desktop_gui.md)
|
||||
- [Cockpit: a Web-based Interface for Servers](cockpit_guide.md)
|
||||
- [XRDP: an Open-Source Remote Desktop Protocol](xrdp_guide.md)
|
||||
- [Apache Guacamole: a Clientless Remote Desktop Gateway](guacamole_guide.md)
|
||||
- [Planetary Network](planetarynetwork.md)
|
||||
- [TFGrid Services](tf_grid_services_readme.md)
|
||||
- [GPU](gpu_toc.md)
|
||||
- [GPU Support](gpu.md)
|
||||
- [Terraform](terraform_toc.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)
|
||||
- [Pulumi](pulumi_readme.md)
|
||||
- [Introduction to Pulumi](pulumi_intro.md)
|
||||
- [Installing Pulumi](pulumi_install.md)
|
||||
- [Deployment Examples](pulumi_examples.md)
|
||||
- [Deployment Details](pulumi_deployment_details.md)
|
||||
- [Mycelium](mycelium_toc.md)
|
||||
- [Overview](overview.md)
|
||||
- [Installation](installation.md)
|
||||
- [Additional Information](information.md)
|
||||
- [Message](message.md)
|
||||
- [Packet](packet.md)
|
||||
- [Data Packet](data_packet.md)
|
||||
- [API YAML](api_yaml.md)
|
||||
- [Computer and IT Basics](computer_it_basics.md)
|
||||
- [CLI and Scripts Basics](cli_scripts_basics.md)
|
||||
- [Docker Basics](docker_basics.md)
|
||||
- [Git and GitHub Basics](git_github_basics.md)
|
||||
- [Firewall Basics](firewall_basics.md)
|
||||
- [UFW Basics](ufw_basics.md)
|
||||
- [Firewalld Basics](firewalld_basics.md)
|
||||
- [File Transfer](file_transfer.md)
|
||||
- [Advanced](advanced.md)
|
||||
- [Token Transfer Keygenerator](token_transfer_keygenerator.md)
|
||||
- [Cancel Contracts](cancel_contracts.md)
|
||||
- [Contract Bills Reports](contract_bill_report.md)
|
||||
- [Listing Free Public IPs](list_public_ips.md)
|
||||
- [Redis](grid3_redis.md)
|
||||
- [IPFS](ipfs_toc.md)
|
||||
- [IPFS on a Full VM](ipfs_fullvm.md)
|
||||
- [IPFS on a Micro VM](ipfs_microvm.md)
|
@@ -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)
|
@@ -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.
|
||||
|
||||
|
@@ -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).
|
||||
|
||||
|
||||
|
||||
|
@@ -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
|
||||
|
@@ -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.
|
||||
|
||||
|
@@ -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
|
||||
```
|
||||
|
@@ -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)
|
@@ -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).
|
||||
|
||||
|
||||
|
||||
|
@@ -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)
|
||||
|
@@ -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`.
|
||||
* ```
|
||||
|
@@ -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`.
|
||||
* ```
|
||||
|
@@ -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
|
||||
|
||||
|
@@ -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)
|
||||
|
||||
***
|
||||
|
||||
|
@@ -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.
|
||||
|
||||
|
@@ -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)
|
||||
|
||||
|
||||
|
||||
|
@@ -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)
|
||||
|
@@ -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
|
||||
|
@@ -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.
|
||||
|
||||
|
@@ -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).
|
@@ -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
|
||||
```
|
||||
|
@@ -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)
|
||||
|
@@ -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)
|
Reference in New Issue
Block a user