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

8
collections/system_administrators/getstarted/ssh_guide/advanced_methods/advanced_methods.md Normal file
View File

@@ -0,0 +1,8 @@
# Advanced Methods
<h2>Table of Contents</h2>
- [SSH with PuTTY](ssh_putty.md)
- [SSH with WSL](ssh_wsl.md)
- [WireGuard](ssh_wireguard.md)
- [Planetary Network](planetarynetwork.md)

224
collections/system_administrators/getstarted/ssh_guide/advanced_methods/planetarynetwork.md Normal file
View File

@@ -0,0 +1,224 @@
<h1> Planetary Network </h1>
<h2>Table of Contents</h2>
- [Introduction](#introduction)
- [Install](#install)
- [Run](#run)
- [Linux](#linux)
- [MacOS](#macos)
- [Test Connectivity](#test-connectivity)
- [Firewalls](#firewalls)
- [Linux](#linux-1)
- [MacOS](#macos-1)
- [Get Yggdrasil IP](#get-yggdrasil-ip)
- [Add Peers](#add-peers)
- [Peers](#peers)
- [Central Europe](#central-europe)
- [Ghent](#ghent)
- [Austria](#austria)
- [Planetary Network Clients](#planetary-network-clients)
***
## Introduction
In a first phase, to get started, you need to launch the planetary network by running [Yggdrasil](https://yggdrasil-network.github.io) from the command line.
Yggdrasil is an implementation of a fully end-to-end encrypted IPv6 network. It is lightweight, self-arranging, supported on multiple platforms, and allows pretty much any IPv6-capable application to communicate securely with other nodes on the network. Yggdrasil does not require you to have IPv6 Internet connectivity - it also works over IPv4.
## Install
Yggdrasil is necessary for communication between your local machine and the nodes on the Grid that you deploy to. Binaries and packages are available for all major operating systems, or it can be built from source. Find installation instructions here.
After installation, you'll need to add at least one publicly available peer to your Yggdrasil configuration file. By default on Unix based systems, you'll find the file at `/etc/yggdrasil.conf`. To find peers, check this site, which compiles and displays the peer information available on Github.
Add peers to your configuration file like so:
```
Peers: ["PEER_URL:PORT", "PEER_URL:PORT", ...]
```
Please consult [yggdrasil installation page](https://yggdrasil-network.github.io/installation.html) for more information and clients
## Run
### Linux
On Linux with `systemd`, Yggdrasil can be started and enabled as a service, or run manually from the command line:
```
sudo yggdrasil -useconffile /etc/yggdrasil.conf
```
Get your IPv6 address with following command :
```
yggdrasilctl getSelf
```
### MacOS
The MacOS package will automatically install and start the `launchd` service. After adding peers to your config file, restart Yggdrasil by stopping the service (it will be restarted automatically):
```
sudo launchctl stop yggdrasil
```
Get your IPv6 address with following command :
```
sudo yggdrasilctl getSelf
```
## Test Connectivity
To ensure that you have successfully connected to the Yggdrasil network, try loading the site in your browser:
```
http://[319:3cf0:dd1d:47b9:20c:29ff:fe2c:39be]/
```
## Firewalls
Creating deployments on the Grid also requires that nodes can reach your machine as well. This means that a local firewall preventing inbound connections will cause deployments to fail.
### Linux
On systems using `iptables`, check:
```
sudo ip6tables -S INPUT
```
If the first line is `-P INPUT DROP`, then all inbound connections over IPv6 will be blocked. To open inbound connections, run:
```
sudo ip6tables -P INPUT ACCEPT
```
To make this persist after a reboot, run:
```
sudo ip6tables-save
```
If you'd rather close the firewall again after you're done, use:
```
sudo ip6tables -P INPUT DROP
```
### MacOS
The MacOS system firewall is disabled by default. You can check your firewall settings according to instructions here.
## Get Yggdrasil IP
Once Yggdrasil is installed, you can find your Yggdrasil IP address using this command on both Linux and Mac:
```
yggdrasil -useconffile /etc/yggdrasil.conf -address
```
You'll need this address when registering your twin on TFChain later.
## Add Peers
- Add the needed [peers](https://publicpeers.neilalexander.dev/) in the config file generated under Peers.
**example**:
```
Peers:
[
tls://54.37.137.221:11129
]
```
- Restart yggdrasil by
systemctl restart yggdrasil
## Peers
### Central Europe
#### Ghent
- tcp://gent01.grid.tf:9943
- tcp://gent02.grid.tf:9943
- tcp://gent03.grid.tf:9943
- tcp://gent04.grid.tf:9943
- tcp://gent01.test.grid.tf:9943
- tcp://gent02.test.grid.tf:9943
- tcp://gent01.dev.grid.tf:9943
- tcp://gent02.dev.grid.tf:9943
### Austria
- tcp://gw291.vienna1.greenedgecloud.com:9943
- tcp://gw293.vienna1.greenedgecloud.com:9943
- tcp://gw294.vienna1.greenedgecloud.com:9943
- tcp://gw297.vienna1.greenedgecloud.com:9943
- tcp://gw298.vienna1.greenedgecloud.com:9943
- tcp://gw299.vienna2.greenedgecloud.com:9943
- tcp://gw300.vienna2.greenedgecloud.com:9943
- tcp://gw304.vienna2.greenedgecloud.com:9943
- tcp://gw306.vienna2.greenedgecloud.com:9943
- tcp://gw307.vienna2.greenedgecloud.com:9943
- tcp://gw309.vienna2.greenedgecloud.com:9943
- tcp://gw313.vienna2.greenedgecloud.com:9943
- tcp://gw324.salzburg1.greenedgecloud.com:9943
- tcp://gw326.salzburg1.greenedgecloud.com:9943
- tcp://gw327.salzburg1.greenedgecloud.com:9943
- tcp://gw328.salzburg1.greenedgecloud.com:9943
- tcp://gw330.salzburg1.greenedgecloud.com:9943
- tcp://gw331.salzburg1.greenedgecloud.com:9943
- tcp://gw333.salzburg1.greenedgecloud.com:9943
- tcp://gw422.vienna2.greenedgecloud.com:9943
- tcp://gw423.vienna2.greenedgecloud.com:9943
- tcp://gw424.vienna2.greenedgecloud.com:9943
- tcp://gw425.vienna2.greenedgecloud.com:9943
## Planetary Network Clients
```
Peers:
[
# Threefold Lochrist
tcp://gent01.grid.tf:9943
tcp://gent02.grid.tf:9943
tcp://gent03.grid.tf:9943
tcp://gent04.grid.tf:9943
tcp://gent01.test.grid.tf:9943
tcp://gent02.test.grid.tf:9943
tcp://gent01.dev.grid.tf:9943
tcp://gent02.dev.grid.tf:9943
# GreenEdge
tcp://gw291.vienna1.greenedgecloud.com:9943
tcp://gw293.vienna1.greenedgecloud.com:9943
tcp://gw294.vienna1.greenedgecloud.com:9943
tcp://gw297.vienna1.greenedgecloud.com:9943
tcp://gw298.vienna1.greenedgecloud.com:9943
tcp://gw299.vienna2.greenedgecloud.com:9943
tcp://gw300.vienna2.greenedgecloud.com:9943
tcp://gw304.vienna2.greenedgecloud.com:9943
tcp://gw306.vienna2.greenedgecloud.com:9943
tcp://gw307.vienna2.greenedgecloud.com:9943
tcp://gw309.vienna2.greenedgecloud.com:9943
tcp://gw313.vienna2.greenedgecloud.com:9943
tcp://gw324.salzburg1.greenedgecloud.com:9943
tcp://gw326.salzburg1.greenedgecloud.com:9943
tcp://gw327.salzburg1.greenedgecloud.com:9943
tcp://gw328.salzburg1.greenedgecloud.com:9943
tcp://gw330.salzburg1.greenedgecloud.com:9943
tcp://gw331.salzburg1.greenedgecloud.com:9943
tcp://gw333.salzburg1.greenedgecloud.com:9943
tcp://gw422.vienna2.greenedgecloud.com:9943
tcp://gw423.vienna2.greenedgecloud.com:9943
tcp://gw424.vienna2.greenedgecloud.com:9943
tcp://gw425.vienna2.greenedgecloud.com:9943
]
```

28
collections/system_administrators/getstarted/ssh_guide/ssh_wireguard.md → collections/system_administrators/getstarted/ssh_guide/advanced_methods/ssh_wireguard.md
View File

@@ -1,4 +1,4 @@
<h1> WireGuard Access </h1>
<h1> WireGuard </h1>
<h2> Table of Contents </h2>
@@ -11,7 +11,6 @@
- [Windows](#windows)
- [Test the WireGuard Connection](#test-the-wireguard-connection)
- [SSH into the Deployment with Wireguard](#ssh-into-the-deployment-with-wireguard)
- [Questions and Feedback](#questions-and-feedback)
***
@@ -19,15 +18,14 @@
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). The main difference will be that we connect to the 3Node deployment using a WireGuard connection instead of an IPv4 or a [Mycelium](mycelium_toc.md) connection.
# Prerequisites
Make sure to [read the introduction](tfgrid3_getstarted.md#get-started---your-first-deployment) before going further.
* SSH client of your choice
* SSH client of your choice:
* [Open-SSH](ssh_openssh.md)
* [PuTTy](ssh_putty.md)
* [WSL](ssh_wsl.md)
@@ -36,7 +34,7 @@ Make sure to [read the introduction](tfgrid3_getstarted.md#get-started---your-fi
# Deploy a Weblet with WireGuard Access
For this guide on WireGuard access, we deploy a [Full VM](dashboard@fullvm). 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](dashboard@@fullVm). 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
@@ -69,19 +67,19 @@ To set the WireGuard connection on Linux or MAC, create a WireGuard configuratio
* Copy the content **WireGuard Config** from the Dashboard **Details** window
* Paste the content to a file with the extension `.conf` (e.g. **wg.conf**) in the directory `/etc/wireguard`
```
* ```
sudo nano /etc/wireguard/wg.conf
```
* Start WireGuard with the command **wg-quick** and, as a parameter, pass the configuration file without the extension (e.g. *wg.conf -> wg*)
```
* ```
wg-quick up wg
```
* Note that you can also specify a config file by path, stored in any location
```
* ```
wg-quick up /etc/wireguard/wg.conf
```
* If you want to stop the WireGuard service, you can write the following in the terminal
```
* ```
wg-quick down wg
```
@@ -105,7 +103,7 @@ To set the WireGuard connection on Windows, add and activate a tunnel with the W
As a test, you can [ping](cli_scripts_basics.md#test-the-network-connectivity-of-a-domain-or-an-ip-address-with-ping) the virtual IP address of the VM to make sure the WireGuard connection is properly established. Make sure to replace `VM_WireGuard_IP` with the proper WireGuard IP address:
* Ping the deployment
```
* ```
ping VM_WireGuard_IP
```
@@ -116,14 +114,8 @@ As a test, you can [ping](cli_scripts_basics.md#test-the-network-connectivity-of
To SSH into the deployment with Wireguard, use the **WireGuard IP** shown in the Dashboard **Details** window.
* SSH into the deployment
```
* ```
ssh root@VM_WireGuard_IP
```
You now have access to the deployment over a WireGuard SSH connection.
# 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.

4
collections/system_administrators/getstarted/ssh_guide/ssh_guide.md
View File

@@ -5,6 +5,4 @@ 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)
- [Advanced Methods](advanced_methods.md)

266
collections/system_administrators/getstarted/ssh_guide/ssh_openssh.md
View File

@@ -3,195 +3,104 @@
<h2> Table of Contents </h2>
- [Introduction](#introduction)
- [Main Steps and Prerequisites](#main-steps-and-prerequisites)
- [Step-by-Step Process with OpenSSH](#step-by-step-process-with-openssh)
- [Linux](#linux)
- [SSH into a 3Node with IPv4 on Linux](#ssh-into-a-3node-with-ipv4-on-linux)
- [SSH into a 3Node with the Planetary Network on Linux](#ssh-into-a-3node-with-the-planetary-network-on-linux)
- [MAC](#mac)
- [SSH into a 3Node with IPv4 on MAC](#ssh-into-a-3node-with-ipv4-on-mac)
- [SSH into a 3Node with the Planetary Network on MAC](#ssh-into-a-3node-with-the-planetary-network-on-mac)
- [Windows](#windows)
- [SSH into a 3Node with IPv4 on Windows](#ssh-into-a-3node-with-ipv4-on-windows)
- [SSH into a 3Node with the Planetary Network on Windows](#ssh-into-a-3node-with-the-planetary-network-on-windows)
- [Questions and Feedback](#questions-and-feedback)
- [Overview](#overview)
- [Linux](#linux)
- [MacOS](#macos)
- [Windows](#windows)
***
# Introduction
## 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, MacOS and Windows with either an IPv4 or a Mycelium connection.
To deploy different workloads, the SSH connection process should be very similar.
If you have any questions, feel free to write a post on the [Threefold Forum](http://forum.threefold.io/).
## Overview
# Main Steps and Prerequisites
Make sure to [read the introduction](../tfgrid3_getstarted.md#get-started---your-first-deployment) before going further.
Make sure to [read the introduction](tfgrid3_getstarted.md#get-started---your-first-deployment) before going further.
The main steps for the whole process are the following:
* Create an SSH Key pair
* Deploy a 3Node
* Choose IPv4 or the Planetary Network
* Create an SSH key pair
* Deploy a VM on a 3Node
* SSH into the 3Node
* For the Planetary Network, download the Planetary Network Connector
# Step-by-Step Process with OpenSSH
## Linux
### SSH into a 3Node with IPv4 on Linux
Here are the steps to SSH into a 3Node with either IPv4 or Mycelium on Linux.
Here are the steps to SSH into a 3Node with IPv4 on Linux.
If you are using Mycelium, make sure to [read this section](mycelium_toc.md).
* To create the SSH key pair, write in the terminal
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
* To see the public key, write in the terminal
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
* To deploy a full VM
* On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine
* Choose the parameters you want
* Minimum CPU: 1 vCore
* Minimum Memory: 512 Mb
* Minimum Disk Size: 15 Gb
* Select IPv4 in `Network`
* Select `IPv4` or `Mycelium` in `Network`
* In `Node Selection`, click on `Load Nodes`
* Click `Deploy`
* To SSH into the VM once the 3Node is deployed
* Copy the IPv4 address
* Copy the IP address
* Open the terminal, write the following with the deployment address and write **yes** to confirm
```
ssh root@IPv4_address
```
```
ssh root@IP_address
```
You now have an SSH connection on Linux with IPv4.
You now have an SSH connection on Linux.
## MacOS
Here are the steps to SSH into a 3Node with either IPv4 or Mycelium on MacOS.
### SSH into a 3Node with the Planetary Network on Linux
Here are the steps to SSH into a 3Node with the Planetary Network on Linux.
* Set a [Planetary Network connection](planetarynetwork.md)
* To create the SSH key pair, write in the terminal
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
* To see the public key, write in the terminal
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
* To deploy a full VM
* On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine
* Choose the parameters you want
* Minimum CPU: 1 vCore
* Minimum Memory: 512 Mb
* Minimum Disk Size: 15 Gb
* Select Planetary Network in `Network`
* In `Node Selection`, click on `Load Nodes`
* Click `Deploy`
* To SSH into the VM once the 3Node is deployed
* Copy the Planetary Network address
* Open the terminal, write the following with the deployment address and write **yes** to confirm
```
ssh root@planetary_network_address
```
You now have an SSH connection on Linux with the Planetary Network.
## MAC
### SSH into a 3Node with IPv4 on MAC
Here are the steps to SSH into a 3Node with IPv4 on MAC.
If you are using Mycelium, make sure to [read this section](mycelium_toc.md).
* To create the SSH key pair, in the terminal write
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
* To see the public key, write in the terminal
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
* To deploy a full VM
* On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine
* Choose the parameters you want
* Minimum CPU: 1 vCore
* Minimum Memory: 512 Mb
* Minimum Disk Size: 15 Gb
* Select IPv4 in `Network`
* Select `IPv4` or `Mycelium` in `Network`
* In `Node Selection`, click on `Load Nodes`
* Click `Deploy`
* To SSH into the VM once the 3Node is deployed
* Copy the IPv4 address
* Copy the IP address
* Open the terminal, write the following with the deployment address and write **yes** to confirm
```
ssh root@IPv4_address
```
You now have an SSH connection on MAC with IPv4.
### SSH into a 3Node with the Planetary Network on MAC
Here are the steps to SSH into a 3Node with the Planetary Network on MAC.
* Set a [Planetary Network connection](planetarynetwork.md)
* To create the SSH key pair, write in the terminal
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
* To see the public key, write in the terminal
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
* To deploy a full VM
* On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine
* Choose the parameters you want
* Minimum CPU: 1 vCore
* Minimum Memory: 512 Mb
* Minimum Disk Size: 15 Gb
* Select Planetary Network in `Network`
* In `Node Selection`, click on `Load Nodes`
* Click `Deploy`
* To SSH into the VM once the 3Node is deployed
* Copy the Planetary Network address
* Open the terminal, write the following with the deployment address and write **yes** to confirm
```
ssh root@planetary_network_address
```
You now have an SSH connection on MAC with the Planetary Network.
```
ssh root@IP_address
```
You now have an SSH connection on MacOS.
## Windows
### SSH into a 3Node with IPv4 on Windows
Here are the steps to SSH into a 3Node with either IPv4 or Mycelium on Windows.
If you are using Mycelium, make sure to [read this section](../../mycelium/mycelium_toc.md).
* To download OpenSSH client and OpenSSH server
* Open the `Settings` and select `Apps`
@@ -203,79 +112,30 @@ You now have an SSH connection on MAC with the Planetary Network.
* Search OpenSSH
* Install OpenSSH Client and OpenSSH Server
* To create the SSH key pair, open `PowerShell` and write
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
* To see the public key, write in `PowerShell`
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
* To deploy a full VM
* On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine
* Choose the parameters you want
* Minimum CPU: 1 vCore
* Minimum Memory: 512 Mb
* Minimum Disk Size: 15 Gb
* Select IPv4 in `Network`
* Select `IPv4` or `Mycelium` in `Network`
* In `Node Selection`, click on `Load Nodes`
* Click `Deploy`
* To SSH into the VM once the 3Node is deployed
* Copy the IPv4 address
* Copy the IP address
* Open `PowerShell`, write the following with the deployment address and write **yes** to confirm
```
ssh root@IPv4_address
```
```
ssh root@IP_address
```
You now have an SSH connection on Window with IPv4.
### SSH into a 3Node with the Planetary Network on Windows
* Set a [Planetary Network connection](planetarynetwork.md)
* To download OpenSSH client and OpenSSH server
* Open the `Settings` and select `Apps`
* Click `Apps & Features`
* Click `Optional Features`
* Verifiy if OpenSSH Client and OpenSSH Server are there
* If not
* Click `Add a feature`
* Search OpenSSH
* Install OpenSSH Client and OpenSSH Server
* To create the SSH key pair, open `PowerShell` and write
```
ssh-keygen
```
* Save in default location
* Write a password (optional)
* To see the public key, write in `PowerShell`
```
cat ~/.ssh/id_rsa.pub
```
* Select and copy the public key when needed
* To deploy a full VM
* On the [Threefold Dashboard](https://dashboard.grid.tf/), go to: Deploy -> Virtual Machines -> Full Virtual Machine
* Choose the parameters you want
* Minimum CPU: 1 vCore
* Minimum Memory: 512 Mb
* Minimum Disk Size: 15 Gb
* Select Planetary Network address in `Network`
* In `Node Selection`, click on `Load Nodes`
* Click `Deploy`
* To SSH into the VM once the 3Node is deployed
* Copy the Planetary Network address
* Open `PowerShell`, write the following with the deployment address and write **yes** to confirm
```
ssh root@planetary_network_address
```
You now have an SSH connection on Window with the Planetary Network.
# Questions and Feedback
If you have any questions, let us know by writing a post on the [Threefold Forum](http://forum.threefold.io/).
You now have an SSH connection on Window.

24
collections/system_administrators/getstarted/ssh_guide/ssh_putty.md
View File

@@ -5,7 +5,6 @@
- [Introduction](#introduction)
- [Main Steps and Prerequisites](#main-steps-and-prerequisites)
- [SSH with PuTTY on Windows](#ssh-with-putty-on-windows)
- [Questions and Feedback](#questions-and-feedback)
***
@@ -13,23 +12,22 @@
In this Threefold Guide, we show how easy it is to deploy a full virtual machine (VM) and SSH into a 3Node on Windows with [PuTTY](https://www.putty.org/).
To deploy different workloads, the SSH connection process should be very similar.
To deploy different workloads, the SSH connection process should be very similar.
If you have any questions, feel free to write a post on the [Threefold Forum](http://forum.threefold.io/).
Make sure to read the [Mycelium section](mycelium_toc.md) if you use Mycelium for the network connection.
## Main Steps and Prerequisites
Make sure to [read the introduction](../tfgrid3_getstarted.md#get-started---your-first-deployment) before going further.
Make sure to [read the introduction](tfgrid3_getstarted.md#get-started---your-first-deployment) before going further.
The main steps for the whole process are the following:
* Create an SSH Key pair
* Deploy a 3Node
* Choose IPv4 or the Planetary Network
* Choose IPv4 or Mycelium
* SSH into the 3Node
* For the Planetary Network, set a [Planetary Network connection](planetarynetwork.md)
## SSH with PuTTY on Windows
@@ -54,15 +52,15 @@ Here are the main steps to SSH into a full VM using PuTTY on a Windows machine.
* Minimum CPU: 1 vCore
* Minimum Memory: 512 Mb
* Minimum Disk Size: 15 Gb
* Select IPv4 in `Network`
* Select IPv4 or Mycelium in `Network`
* In `Node Selection`, click on `Load Nodes`
* Click `Deploy`
* To SSH into the VM once the 3Node is deployed
* Take note of the IPv4 address
* Take note of the IP address
* Connect to the full VM with PuTTY
* Open PuTTY
* Go to the section `Session`
* Add the VM IPv4 address under `Host Name (or IP address)`
* Add the VM address under `Host Name (or IP address)`
* Make sure `Connection type` is set to `SSH`
* Go to the section `Connection` -> `SSH` -> `Auth` -> `Credentials`
* Under `Private key file for authentication`, click on `Browse...`
@@ -71,10 +69,4 @@ Here are the main steps to SSH into a full VM using PuTTY on a Windows machine.
* In the PuTTY terminal window, enter `root` as the login parameter
* Enter the passphrase for the private key if you set one
You now have an SSH connection on Windows using PuTTY.
## Questions and Feedback
If you have any questions, let us know by writing a post on the [Threefold Forum](http://forum.threefold.io/).
You now have an SSH connection on Windows using PuTTY.

9
collections/system_administrators/getstarted/ssh_guide/ssh_wsl.md
View File

@@ -6,7 +6,6 @@
- [SSH Key Generation](#ssh-key-generation)
- [Connect to Remote Host with SSH](#connect-to-remote-host-with-ssh)
- [Enable Port 22 in Windows Firewall](#enable-port-22-in-windows-firewall)
- [Questions and Feedback](#questions-and-feedback)
***
@@ -14,11 +13,11 @@
In this Threefold Guide, we show how easy it is to SSH into a 3node on Windows with [Windows Subsystem for Linux (WSL)](https://ubuntu.com/wsl).
If you have any questions, feel free to write a post on the [Threefold Forum](http://forum.threefold.io/).
Make sure to read the [Mycelium section](mycelium_toc.md) if you use Mycelium for the network connection.
## SSH Key Generation
Make sure SSH is installed by entering following command at the command prompt:
Make sure SSH is installed by entering the following command at the command prompt:
```sh
sudo apt install openssh-client
@@ -83,7 +82,3 @@ This is not recommend especially for portable device (Laptop, Tablets) that conn
- under `Name`
- Name: `SSH Server`
- Description: `SSH Server`
## Questions and Feedback
If you have any questions, let us know by writing a post on the [Threefold Forum](http://forum.threefold.io/).

32
collections/system_administrators/getstarted/tfgrid3_getstarted.md
View File

@@ -1,32 +1,26 @@
# TFGrid Manual - Get Started
# Getting Started
## Get Started - Your First Deployment
## Your First Deployment
It's easy to get started on the TFGrid and deploy applications.
It's easy to get started on the TFGrid.
For your first deployment on the grid, we will show you how to deploy a full virtual machine running on a ThreeFold node.
- [Create a TFChain Account](dashboard@@wallet_connector)
- [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.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)
- [Deploy and Connect to a VM](system_administrators@@ssh_openssh)
## Grid Platforms
Once you're acquainted with the basics, you can explore all types of ThreeFold deployments.
- [TF Dashboard](dashboard/dashboard@@)
- [TF Flist Hub](developers@@zos_hub)
## TFGrid Deployments
## TFGrid Services and Resources
From virtual machines to Kubernetes, to one-click apps to infrastructure-as-code workloads, the TFGrid provides syadmins control and flexibility.
- [TFGrid Services](tf_grid_services_readme.md)
- [ThreeFold Deployments](tfgrid_deployments.md)
## Advanced Deployment Techniques
## TFGrid Services
- [Advanced Topics](advanced.md)
Consult the list of TFGrid services to gain an overview of the ThreeFold ecosystem.
***
If you have any question, feel free to ask for help on the [Threefold Forum](https://forum.threefold.io/c/threefold-grid-utilization/support/).
- [TFGrid Services](tf_grid_services_readme.md)

43
collections/system_administrators/getstarted/tfgrid_deployments.md Normal file
View File

@@ -0,0 +1,43 @@
<h1> TFGrid Deployments </h1>
<h2>Table of Contents</h2>
- [Introduction](#introduction)
- [Dashboard UI](#dashboard-ui)
- [Infrastrure-As-Code](#infrastrure-as-code)
- [Command Line Interfaces](#command-line-interfaces)
- [GPU Workloads](#gpu-workloads)
---
## Introduction
There are many ways to interact with the ThreeFold Grid to deploy workloads. We present the main ones.
## Dashboard UI
We provide an easy-to-use user interface via the ThreeFold Dashboard and its many apps.
- [ThreeFold Dashboard](dashboard@@dashboard)
## Infrastrure-As-Code
You can deploy infrastructure-as-code with Pulumi and Terraform/OpenTofu.
- [Pulumi](pulumi_readme.md)
- [Terraform](terraform_toc.md)
## Command Line Interfaces
You can use our Go and Javascript/TypeScript command line interface tools to deploy workloads on the grid.
- [Go Grid Client](developers@@grid3_go_readme)
- [TFCMD](developers@@tfcmd/tfcmd)
- [TFRobot](developers@@tfrobot/tfrobot)
- [TypeScript Grid Client](developers@@grid3_javascript_readme)
## GPU Workloads
There are many ways to deploy GPU workloads on the ThreeFold Grid. Check the GPU section for all the details.
- [GPU Support](gpu_toc.md)

46
collections/system_administrators/getstarted/tfgrid_services/tf_grid_services_readme.md
View File

@@ -7,13 +7,13 @@
- [QAnet](#qanet)
- [Testnet](#testnet)
- [Mainnet](#mainnet)
- [Supported Planetary Network Nodes](#supported-planetary-network-nodes)
- [General](#general)
***
## Introduction
On this article we have aggregated a list of all of the services running on Threefold Grid 3 infrastructure for your convenience
Here is a list of all of the services running on Threefold Grid 3 infrastructure.
> Note: the usage of `dev` indicates a devnet service.
> and usage of `test` indicates a testnet service.
@@ -53,43 +53,7 @@ On this article we have aggregated a list of all of the services running on Thre
- [TFGrid Proxy](https://gridproxy.grid.tf)
- [Grid Dashboard](https://dashboard.grid.tf)
### Supported Planetary Network Nodes
## General
```
Peers:
[
# Threefold Lochrist
tcp://gent01.grid.tf:9943
tcp://gent02.grid.tf:9943
tcp://gent03.grid.tf:9943
tcp://gent04.grid.tf:9943
tcp://gent01.test.grid.tf:9943
tcp://gent02.test.grid.tf:9943
tcp://gent01.dev.grid.tf:9943
tcp://gent02.dev.grid.tf:9943
# GreenEdge
tcp://gw291.vienna1.greenedgecloud.com:9943
tcp://gw293.vienna1.greenedgecloud.com:9943
tcp://gw294.vienna1.greenedgecloud.com:9943
tcp://gw297.vienna1.greenedgecloud.com:9943
tcp://gw298.vienna1.greenedgecloud.com:9943
tcp://gw299.vienna2.greenedgecloud.com:9943
tcp://gw300.vienna2.greenedgecloud.com:9943
tcp://gw304.vienna2.greenedgecloud.com:9943
tcp://gw306.vienna2.greenedgecloud.com:9943
tcp://gw307.vienna2.greenedgecloud.com:9943
tcp://gw309.vienna2.greenedgecloud.com:9943
tcp://gw313.vienna2.greenedgecloud.com:9943
tcp://gw324.salzburg1.greenedgecloud.com:9943
tcp://gw326.salzburg1.greenedgecloud.com:9943
tcp://gw327.salzburg1.greenedgecloud.com:9943
tcp://gw328.salzburg1.greenedgecloud.com:9943
tcp://gw330.salzburg1.greenedgecloud.com:9943
tcp://gw331.salzburg1.greenedgecloud.com:9943
tcp://gw333.salzburg1.greenedgecloud.com:9943
tcp://gw422.vienna2.greenedgecloud.com:9943
tcp://gw423.vienna2.greenedgecloud.com:9943
tcp://gw424.vienna2.greenedgecloud.com:9943
tcp://gw425.vienna2.greenedgecloud.com:9943
]
```
- [TF Flist Hub](developers@@/zos_hub)
- [TF Boot Generator](dashboard@@node_installer)