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

9
collections/system_administrators/pulumi/pulumi_complete_guides/pulumi_complete_guides_toc.md Normal file
View File

@@ -0,0 +1,9 @@
<h1> Complete Guides </h1>
This section covers complete guides to deploy workloads on the ThreeFold Grid with Pulumi.
<h2>Table of Contents</h2>
- [Pulumi and YAML](./pulumi_yaml.md)
- [Pulumi and Python](./pulumi_python.md)
- [Pulumi and Go](./pulumi_go.md)

90
collections/system_administrators/pulumi/pulumi_complete_guides/pulumi_go.md Normal file
View File

@@ -0,0 +1,90 @@
<h1> Pulumi Complete Go Guide</h1>
<h2>Table of Contents</h2>
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Alternative to Make Commands](#alternative-to-make-commands)
---
## Introduction
In this guide, we cover the complete steps to deploy a virtual machine on the grid with Pulumi via Go.
To provide a uniform deployment method, we use Docker for this guide. It is optional but will greatly facilitate the deployment as the steps will be similar for Linux, MacOS and Windows.
This guide is useful to get you started quickly with Pulumi on the TFGrid.
Once you've successfully deployed a VM, you can try all the different Go examples within the [pulumi-threefold repository](https://github.com/threefoldtech/pulumi-threefold). The examples are available in the subdirectory `/examples/go/`.
## Prerequisites
- [A TFChain account](dashboard@@wallet_connector)
- TFT in your TFChain account
- [Buy TFT](threefold_token@@buy_sell_tft)
- [Send TFT to TFChain](threefold_token@@tfchain_stellar_bridge)
- [Get Docker](https://docs.docker.com/get-docker/)
## Steps
- Deploy a Docker Ubuntu container in interactive mode:
```
sudo docker run -it --net=host ubuntu:jammy /bin/bash
```
- In Docker Ubuntu, deploy a VM with Pulumi. Make sure to add your `MNEMONIC` and `SSH_KEY` below before running the script. For this deployment we use `main` as the `NETWORK`. Change this if needed.
```
# Install the prerequisites
apt update && apt install -y curl git wget make
# Install Pulumi
curl -fsSL https://get.pulumi.com | sh
export PATH=$PATH=:/root/.pulumi/bin
# Clone the ThreeFold Pulumi repo
git clone https://github.com/threefoldtech/pulumi-threefold.git
cd pulumi-threefold/examples/go/virtual_machine
# Prepare the Pulumi Go environment
# Install Go
wget https://go.dev/dl/go1.23.0.linux-amd64.tar.gz
rm -rf /usr/local/go && tar -C /usr/local -xzf go1.23.0.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin
# Export the variables
export NETWORK="main"
export SSH_KEY="<ADD_YOUR_SSH_PUBLIC_KEY>"
export MNEMONIC="<ADD_YOUR_MNEMONIC>"
# Start Pulumi
make run
```
- You can now SSH into the deployment from your local machine terminal
```
ssh root@VM_IP
```
- To destroy the deployment, run the following line within the Docker Ubuntu terminal.
```
make destroy
```
## Alternative to Make Commands
You can use direct Pulumi commands instead of the Make commands above.
- You can replace `make run` with:
```
pulumi login --local
pulumi up
```
- You can replace `make destroy` with:
```
pulumi down
pulumi stack rm <stack_name>
```
That being said, the Make commands run additional features. Feel free to explore the possibilities and consult the files within the repo for more information.

89
collections/system_administrators/pulumi/pulumi_complete_guides/pulumi_python.md Normal file
View File

@@ -0,0 +1,89 @@
<h1> Pulumi Complete Python Guide</h1>
<h2>Table of Contents</h2>
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Alternative to Make Commands](#alternative-to-make-commands)
---
## Introduction
In this guide, we cover the complete steps to deploy a virtual machine on the grid with Pulumi via Python.
To provide a uniform deployment method, we use Docker for this guide. It is optional but will greatly facilitate the deployment as the steps will be similar for Linux, MacOS and Windows.
This guide is useful to get you started quickly with Pulumi on the TFGrid.
Once you've successfully deployed a VM, you can try all the different Python examples within the [pulumi-threefold repository](https://github.com/threefoldtech/pulumi-threefold). The examples are available in the subdirectory `/examples/python/`.
## Prerequisites
- [A TFChain account](dashboard@@wallet_connector)
- TFT in your TFChain account
- [Buy TFT](threefold_token@@buy_sell_tft)
- [Send TFT to TFChain](threefold_token@@tfchain_stellar_bridge)
- [Get Docker](https://docs.docker.com/get-docker/)
## Steps
- Deploy a Docker Ubuntu container in interactive mode:
```
sudo docker run -it --net=host ubuntu:jammy /bin/bash
```
- In Docker Ubuntu, deploy a VM with Pulumi. Make sure to add your `MNEMONIC` and `SSH_KEY` below before running the script. For this deployment we use `main` as the `NETWORK`. Change this if needed.
```
# Install the prerequisites
apt update && apt install -y curl git python3 python-is-python3 python3-venv python3-pip
# Install Pulumi
curl -fsSL https://get.pulumi.com | sh
export PATH=$PATH=:/root/.pulumi/bin
# Clone the ThreeFold Pulumi repo
git clone https://github.com/threefoldtech/pulumi-threefold.git
cd pulumi-threefold
# Prepare the Pulumi Python environment
cd examples/python
python -m venv venv
source venv/bin/activate
cd virtual_machine
pip install -r requirements.txt
# Export the variables
export NETWORK="main"
export SSH_KEY="<ADD_YOUR_SSH_PUBLIC_KEY>"
export MNEMONIC="<ADD_YOUR_MNEMONIC>"
# Start Pulumi
make run
```
- You can now SSH into the deployment from your local machine terminal
```
ssh root@VM_IP
```
- To destroy the deployment, run the following line within the Docker Ubuntu terminal.
```
make destroy
```
## Alternative to Make Commands
You can use direct Pulumi commands instead of the Make commands above.
- You can replace `make run` with:
```
pulumi login --local
pulumi up
```
- You can replace `make destroy` with:
```
pulumi down
pulumi stack rm <stack_name>
```
That being said, the Make commands run additional features. Feel free to explore the possibilities and consult the files within the repo for more information.

77
collections/system_administrators/pulumi/pulumi_complete_guides/pulumi_yaml.md Normal file
View File

@@ -0,0 +1,77 @@
<h1> Pulumi Complete YAML Guide</h1>
<h2>Table of Contents</h2>
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Alternative to Make Commands](#alternative-to-make-commands)
---
## Introduction
In this guide, we cover the complete steps to deploy a virtual machine on the grid with Pulumi via a YAML file.
To provide a uniform deployment method, we use Docker for this guide. It is optional but will greatly facilitate the deployment as the steps will be similar for Linux, MacOS and Windows.
This guide is useful to get you started quickly with Pulumi on the TFGrid.
Once you've successfully deployed a VM, you can try all the different YAML examples within the [pulumi-threefold repository](https://github.com/threefoldtech/pulumi-threefold). The examples are available in the subdirectory `/examples/yaml/`.
## Prerequisites
- [A TFChain account](dashboard@@wallet_connector)
- TFT in your TFChain account
- [Buy TFT](threefold_token@@buy_sell_tft)
- [Send TFT to TFChain](threefold_token@@tfchain_stellar_bridge)
- [Get Docker](https://docs.docker.com/get-docker/)
## Steps
- Deploy a Docker Ubuntu container in interactive mode:
```
sudo docker run -it --net=host ubuntu:jammy /bin/bash
```
- In Docker Ubuntu, deploy a VM with Pulumi. Make sure to add your `MNEMONIC` and `SSH_KEY` below before running the script. For this deployment we use `main` as the `NETWORK`. Change this if needed.
```
# Install the prerequisites
apt update && apt install -y curl git make
curl -fsSL https://get.pulumi.com | sh
export PATH=$PATH=:/root/.pulumi/bin
git clone https://github.com/threefoldtech/pulumi-threefold.git
cd pulumi-threefold/examples/yaml/virtual_machine
# Export the variables
export NETWORK="main"
export SSH_KEY="<ADD_YOUR_SSH_PUBLIC_KEY>"
export MNEMONIC="<ADD_YOUR_MNEMONIC>"
# Start Pulumi
make run
```
- You can now SSH into the deployment from your local machine terminal
```
ssh root@VM_IP
```
- To destroy the deployment, run the following line within the Docker Ubuntu terminal.
```
make destroy
```
## Alternative to Make Commands
You can use direct Pulumi commands instead of the Make commands above.
- You can replace `make run` with:
```
pulumi login --local
pulumi up
```
- You can replace `make destroy` with:
```
pulumi down
pulumi stack rm <stack_name>
```
That being said, the Make commands provide additional commands. Feel free to explore the possibilities and consult the files within the repo for more information.