manual, set internal collections to filename.md template

This commit is contained in:
Mik-TF
2024-05-13 19:28:23 -04:00
parent 280652166f
commit 1836179a75
169 changed files with 709 additions and 709 deletions

View File

@@ -5,7 +5,7 @@
- [Zero-OS Hub](zos_hub.md)
- [Generate an API Token](api_token.md)
- [Convert Docker Image Into Flist](convert_docker_image.md)
- [Supported Flists](./grid3_supported_flists.md)
- [Supported Flists](grid3_supported_flists.md)
- [Flist Case Studies](flist_case_studies.md)
- [Case Study: Debian 12](flist_debian_case_study.md)
- [Case Study: Nextcloud AIO](flist_nextcloud_case_study.md)

View File

@@ -2,5 +2,5 @@
<h2> Table of Contents </h2>
- [Case Study: Debian 12](./flist_debian_case_study.md)
- [Case Study: Nextcloud AIO](./flist_nextcloud_case_study.md)
- [Case Study: Debian 12](flist_debian_case_study.md)
- [Case Study: Nextcloud AIO](flist_nextcloud_case_study.md)

View File

@@ -39,7 +39,7 @@
# Introduction
In this case study, we explain how to create a new flist on the ThreeFold ecosystem. We will show the process of creating a Nextcloud All-in-One flist and we will deploy a micro VM on the ThreeFold Playground to access our Nextcloud instance. As a reference, the official Nextcloud flist is available [here](https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist.md).
In this case study, we explain how to create a new flist on the ThreeFold ecosystem. We will show the process of creating a Nextcloud All-in-One flist and we will deploy a micro VM on the ThreeFold Playground to access our Nextcloud instance. As a reference, the official Nextcloud flist is available [here](threefoldtech-nextcloudaio-latest.flist.md).
To achieve all this, we will need to create a Docker Hub account, create a Dockerfile and its associated files, a docker image and a docker container, then convert the docker image to a Zero-OS flist. After all this, we will be deploying our Nextcloud instance on the ThreeFold Playground.
@@ -242,9 +242,9 @@ Finally, we set an entrypoint in our Dockerfile. As per the [Docker documentatio
The **README.md** file has the main goal of explaining clearly to the user the functioning of the Nextcloud directory and its associated flist. In this file, we can explain what our code is doing and offer steps to properly configure the whole deployment.
We also give the necessary steps to create the Docker image and convert it into an flist starting directly with the Nextcloud directory. This can be useful for users that want to create their own flist, instead of using the [official ThreeFold Nextcloud flist](https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist.md).
We also give the necessary steps to create the Docker image and convert it into an flist starting directly with the Nextcloud directory. This can be useful for users that want to create their own flist, instead of using the [official ThreeFold Nextcloud flist](threefoldtech-nextcloudaio-latest.flist.md).
To read the complete README.md file, go to [this link](https://github.com/threefoldtech/tf-images/blob/development/tfgrid3/nextcloud/README.md).
To read the complete README.md file, go to [this link](README.md).
## scripts Folder
@@ -661,7 +661,7 @@ We will now convert the Docker image into a Zero-OS flist.
```
* Example:
* ```
https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist
threefoldtech-nextcloudaio-latest.flist
```
# Deploy Nextcloud AIO on the TFGrid with Terraform
@@ -693,7 +693,7 @@ gateway_id = "50"
vm1_id = "5453"
deployment_name = "nextcloudgateway"
nextcloud_flist = "https://hub.grid.tf/tf-official-apps/threefoldtech-nextcloudaio-latest.flist"
nextcloud_flist = "threefoldtech-nextcloudaio-latest.flist"
```
Make sure to add your own seed phrase and SSH public key. Simply replace the three dots by the content. Note that you can deploy on a different node than node 5453 for the **vm1** node. If you want to deploy on another node than node 5453 for the **gateway** node, make sure that you choose a gateway node. To find a gateway node, go on the [ThreeFold Dashboard](https://dashboard.grid.tf/) Nodes section of the Explorer and select **Gateways (Only)**.

View File

@@ -40,7 +40,7 @@ You don't need to take care about the base system yourself, just merge it with t
The ZOS Hub allows you to convert Docker Hub images and Tar files into flists thanks to the Docker Hub Converter.
You can convert a docker image (eg: `busybox`, `ubuntu`, `fedora`, `couchdb`, ...) to an flist directly from the backend, this allows you to use your existing docker image in our infrastructure out-of-the-box. Go to the [Docker Hub Converter](https://hub.grid.tf/docker-convert) to use this feature. For more information on the process, read the section [Convert Docker Image to flist](./convert_docker_image.md) of the TF Manual.
You can convert a docker image (eg: `busybox`, `ubuntu`, `fedora`, `couchdb`, ...) to an flist directly from the backend, this allows you to use your existing docker image in our infrastructure out-of-the-box. Go to the [Docker Hub Converter](https://hub.grid.tf/docker-convert) to use this feature. For more information on the process, read the section [Convert Docker Image to flist](convert_docker_image.md) of the TF Manual.
You can also easily convert a Tar file into an flist via the [Upload section](https://hub.grid.tf/upload) of the ZOS Hub.
@@ -59,7 +59,7 @@ and gives you the full control of the chain. The only restriction is that the co
on the flist needs to exists on the backend, otherwise your flist will be rejected.
## Authenticate via 3Bot
All the operations on the ZOS Hub needs to be done via a `3Bot` (default) authentication. Only downloading a flist can be done anonymously. To authenticate request via the API, you need to generate an API Token as shown in the section [ZOS Hub API Token](./api_token.md).
All the operations on the ZOS Hub needs to be done via a `3Bot` (default) authentication. Only downloading a flist can be done anonymously. To authenticate request via the API, you need to generate an API Token as shown in the section [ZOS Hub API Token](api_token.md).
## Get and Update Information Through the API
The hub host a basic REST API which can gives you some informations about flists, renaming them, remove them, etc.

View File

@@ -16,10 +16,10 @@ We provide basic information on the currently supported Flists.
|flist|entrypoint|env vars|
|:--:|:--:|--|
|[Alpine](https://hub.grid.tf/tf-official-apps/threefoldtech-alpine-3.flist.md)|`/entrypoint.sh`|`SSH_KEY`|
|[Ubuntu](https://hub.grid.tf/tf-official-apps/threefoldtech-ubuntu-22.04.flist.md)|`/init.sh`|`SSH_KEY`|
|[CentOS](https://hub.grid.tf/tf-official-apps/threefoldtech-centos-8.flist.md)|`/entrypoint.sh`|`SSH_KEY`|
|[K3s](https://hub.grid.tf/tf-official-apps/threefoldtech-k3s-latest.flist.md)|`/sbin/zinit init`|- `SSH_KEY` <br/>- `K3S_TOKEN` <br/>- `K3S_DATA_DIR`<br/>- `K3S_FLANNEL_IFACE`<br/>- `K3S_NODE_NAME`<br/> - `K3S_URL` `https://${masterIp}:6443`|
|[Alpine](threefoldtech-alpine-3.flist.md)|`/entrypoint.sh`|`SSH_KEY`|
|[Ubuntu](threefoldtech-ubuntu-22.04.flist.md)|`/init.sh`|`SSH_KEY`|
|[CentOS](threefoldtech-centos-8.flist.md)|`/entrypoint.sh`|`SSH_KEY`|
|[K3s](threefoldtech-k3s-latest.flist.md)|`/sbin/zinit init`|- `SSH_KEY` <br/>- `K3S_TOKEN` <br/>- `K3S_DATA_DIR`<br/>- `K3S_FLANNEL_IFACE`<br/>- `K3S_NODE_NAME`<br/> - `K3S_URL` `https://${masterIp}:6443`|
## More Flists

View File

@@ -12,7 +12,7 @@
## Introduction
After [deploying a VM](./grid3_go_vm.md) you can deploy Gateways to further expose your VM.
After [deploying a VM](grid3_go_vm.md) you can deploy Gateways to further expose your VM.
## Gateway Name

View File

@@ -4,6 +4,6 @@ The TFGrid whole source code is open-source and instances of the grid can be dep
## Table of Contents
- [TFGrid Stacks](./tfgrid_stacks.md)
- [Full VM Grid Deployment](./grid_deployment_full_vm.md)
- [Grid Snapshots](./snapshots.md)
- [TFGrid Stacks](tfgrid_stacks.md)
- [Full VM Grid Deployment](grid_deployment_full_vm.md)
- [Grid Snapshots](snapshots.md)

View File

@@ -18,7 +18,7 @@
To facilitate deploying grid backend services, we provide snapshots to significantly reduce sync time. This can be setup anywhere from scratch. Once all services are synced, one can use the scripts to create snapshots automatically.
To learn how to deploy your own grid stack, read [this section](./grid_deployment_full_vm.md).
To learn how to deploy your own grid stack, read [this section](grid_deployment_full_vm.md).
## Services

View File

@@ -29,4 +29,4 @@ The overall ThreeFold ecosystem becomes more resilient to failures of individual
To set your own instance of the TFGrid, you can download a snapshot of the grid and deploy the TFGrid services with Docker. We even provide scripts to quicken the whole process!
Read more about snapshots in the [next section](./grid_deployment_full_vm.md).
Read more about snapshots in the [next section](grid_deployment_full_vm.md).

View File

@@ -48,7 +48,7 @@ Starting from this we came up with a more detailed requirements:
***
## Specifications
For details about protocol itself please check the [specs](./rmb_specs.md).
For details about protocol itself please check the [specs](rmb_specs.md).
***
## How to Use RMB
@@ -83,7 +83,7 @@ think of `rmb-peer` as a gateway that stands between you and the `relay`. `rmb-p
Then it provide a simple (plain-text) api over `redis`. means to send messages (or handle requests) you just need to be able to push and pop messages from some redis queues. Messages are simple plain text json.
> More details can be found [here](./rmb_specs.md)
> More details can be found [here](rmb_specs.md)
***
## Download

View File

@@ -1,6 +1,6 @@
Development
===========
* [Quick start](./quickstart.md)
* [Testing](./testing.md)
* [Binary packages](./packages.md)
* [Quick start](quickstart.md)
* [Testing](testing.md)
* [Binary packages](packages.md)

View File

@@ -85,4 +85,4 @@ Here is a list of the major ZOS modules.
## Capacity
In [this document](./capacity.md), you can find detail description of how ZOS does capacity planning.
In [this document](capacity.md), you can find detail description of how ZOS does capacity planning.

View File

@@ -2,7 +2,7 @@
<h2> Table of Contents </h2>
- [Introduction to networkd](./introduction.md)
- [Vocabulary Definitions](./definitions.md)
- [Wireguard Mesh Details](./mesh.md)
- [Farm Network Setup](./setup_farm_network.md)
- [Introduction to networkd](introduction.md)
- [Vocabulary Definitions](definitions.md)
- [Wireguard Mesh Details](mesh.md)
- [Farm Network Setup](setup_farm_network.md)

View File

@@ -180,7 +180,7 @@ type Workload struct {
### API
Node is always connected to the RMB network with the node `twin`. Means the node is always reachable over RMB with the node `twin-id` as an address.
The [node client](https://github.com/threefoldtech/zos/blob/main/client/node.go) should have a complete list of all available functions. documentations of the API can be found [here](./api.md)
The [node client](https://github.com/threefoldtech/zos/blob/main/client/node.go) should have a complete list of all available functions. documentations of the API can be found [here](api.md)
## Raid Controller Configuration

View File

@@ -66,7 +66,7 @@ For more details on all parameters needed to run a `zmachine` please refer to [`
#### Building your `flist`
Please refer to [this document](./manual.md) here about how to build an compatible `zmachine flist`
Please refer to [this document](manual.md) here about how to build an compatible `zmachine flist`
### `zlogs` type

View File

@@ -10,4 +10,4 @@
For more details on all parameters needed to run a `zmachine` please refer to [`zmachine` data](https://github.com/threefoldtech/zos/blob/main/pkg/gridtypes/zos/zmachine.go)
# Building your `flist`.
Please refer to [this document](../manual.md) here about how to build an compatible `zmachine flist`
Please refer to [this document](manual.md) here about how to build an compatible `zmachine flist`

View File

@@ -80,10 +80,10 @@ Notes:
## Registered Tests
- [Public IP Validation](./publicips.md)
- [CPUBenchmark](./cpubench.md)
- [IPerf](./iperf.md)
- [Health Check](./healthcheck.md)
- [Public IP Validation](publicips.md)
- [CPUBenchmark](cpubench.md)
- [IPerf](iperf.md)
- [Health Check](healthcheck.md)
## Test Suite

View File

@@ -3,7 +3,7 @@
We use a simple pipeline release workflow. Building and file distribution are made using GitHub Actions.
Usable files are available on the [Zero-OS Hub](https://hub.grid.tf/tf-zos).
This pipeline is made to match the 3 different type of running mode of 0-OS. For more information head to the [upgrade documentation](../identity/upgrade.md).
This pipeline is made to match the 3 different type of running mode of 0-OS. For more information head to the [upgrade documentation](upgrade.md).
## Development build

View File

@@ -17,7 +17,7 @@
In this section, we show how to deploy CapRover with the Javascript client.
This deployment is very similar to what we have in the section [Deploy a VM](./grid3_javascript_vm.md), but the environment variables are different.
This deployment is very similar to what we have in the section [Deploy a VM](grid3_javascript_vm.md), but the environment variables are different.
## Leader Node

View File

@@ -21,7 +21,7 @@ We show how to deploy a Kubernetes cluster on the TFGrid with the Javascript cli
## Prerequisites
- Make sure you have your [client](./grid3_javascript_loadclient.md) prepared
- Make sure you have your [client](grid3_javascript_loadclient.md) prepared
## Example code

View File

@@ -18,7 +18,7 @@ As part of the tfchain, we support a keyvalue store module that can be used for
## Prerequisites
- Make sure you have your [client](./grid3_javascript_loadclient.md) prepared
- Make sure you have your [client](grid3_javascript_loadclient.md) prepared
## Example code

View File

@@ -60,7 +60,7 @@ using e2e. That's similar to home servers by matrix
- BackendStorage : can be `auto` which willl automatically adapt if running in node environment to use `filesystem backend` or the browser enviornment to use `localstorage backend`. Also you can set it to `kvstore` to use the tfchain keyvalue store module.
- keypairType: is defaulted to `sr25519`, most likely you will never need to change it. `ed25519` is supported too.
for more details, check [client options](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/docs/client_configuration.md)
for more details, check [client options](client_configuration.md)
> Note: The choice of the node is completely up to the user at this point. They need to do the capacity planning. Check [Node Finder](dashboard@@node_finder) to know which nodes fits your deployment criteria.

View File

@@ -15,7 +15,7 @@
## Prerequisites
First, make sure that you have your [client](./grid3_javascript_loadclient.md) prepared.
First, make sure that you have your [client](grid3_javascript_loadclient.md) prepared.
## Code Example
@@ -257,7 +257,7 @@ log(">>>>>>>>>>>>>>>vm has been created<<<<<<<<<<<<<<<");
log(vm_res);
```
So this deployment is almost similiar to what we have in the [vm deployment section](./grid3_javascript_vm.md). We only have a new section `qsfs_disks`
So this deployment is almost similiar to what we have in the [vm deployment section](grid3_javascript_vm.md). We only have a new section `qsfs_disks`
```ts
qsfs_disks: [{

View File

@@ -21,7 +21,7 @@ We show how to deploy ZDBs for QSFS on the TFGrid with the Javascript client.
## Prerequisites
- Make sure you have your [client](./grid3_javascript_loadclient.md) prepared
- Make sure you have your [client](grid3_javascript_loadclient.md) prepared
## Example code

View File

@@ -8,17 +8,17 @@ Please make sure to check the [basics](system_administrators@@tfgrid3_getstarted
<h2> Table of Contents </h2>
- [Installation](./grid3_javascript_installation.md)
- [Loading Client](./grid3_javascript_loadclient.md)
- [Deploy a VM](./grid3_javascript_vm.md)
- [Capacity Planning](./grid3_javascript_capacity_planning.md)
- [Deploy Multiple VMs](./grid3_javascript_vms.md)
- [Deploy CapRover](./grid3_javascript_caprover.md)
- [Gateways](./grid3_javascript_vm_gateways.md)
- [Deploy a Kubernetes Cluster](./grid3_javascript_kubernetes.md)
- [Deploy a ZDB](./grid3_javascript_zdb.md)
- [Deploy ZDBs for QSFS](./grid3_javascript_qsfs_zdbs.md)
- [QSFS](./grid3_javascript_qsfs.md)
- [Key Value Store](./grid3_javascript_kvstore.md)
- [VM with Wireguard and Gateway](./grid3_wireguard_gateway.md)
- [GPU Support](./grid3_javascript_gpu_support.md)
- [Installation](grid3_javascript_installation.md)
- [Loading Client](grid3_javascript_loadclient.md)
- [Deploy a VM](grid3_javascript_vm.md)
- [Capacity Planning](grid3_javascript_capacity_planning.md)
- [Deploy Multiple VMs](grid3_javascript_vms.md)
- [Deploy CapRover](grid3_javascript_caprover.md)
- [Gateways](grid3_javascript_vm_gateways.md)
- [Deploy a Kubernetes Cluster](grid3_javascript_kubernetes.md)
- [Deploy a ZDB](grid3_javascript_zdb.md)
- [Deploy ZDBs for QSFS](grid3_javascript_qsfs_zdbs.md)
- [QSFS](grid3_javascript_qsfs.md)
- [Key Value Store](grid3_javascript_kvstore.md)
- [VM with Wireguard and Gateway](grid3_wireguard_gateway.md)
- [GPU Support](grid3_javascript_gpu_support.md)

View File

@@ -19,7 +19,7 @@
## Introduction
After the [deployment of a VM](./grid3_javascript_vm.md), now it's time to expose it to the world
After the [deployment of a VM](grid3_javascript_vm.md), now it's time to expose it to the world
## Example code
@@ -104,7 +104,7 @@ log(d);
## Deploying a VM and exposing it over a Gateway using a Full domain
After the [deployment of a VM](./grid3_javascript_vm.md), now it's time to expose it to the world
After the [deployment of a VM](grid3_javascript_vm.md), now it's time to expose it to the world
## Example code

View File

@@ -21,7 +21,7 @@ We show how to deploy ZDB on the TFGrid with the Javascript client.
## Prerequisites
- Make sure you have your [client](./grid3_javascript_loadclient.md) prepared
- Make sure you have your [client](grid3_javascript_loadclient.md) prepared
## Example code

View File

@@ -26,7 +26,7 @@ We present here the relevant information when it comes to deploying a virtual ma
## Client Configurations
To configure the client, have a look at [this section](./grid3_javascript_loadclient.md).
To configure the client, have a look at [this section](grid3_javascript_loadclient.md).

View File

@@ -45,11 +45,11 @@ The main structure of the code base is as follows:
Adding a new endpoint should be accompanied with a corresponding test. Ideally every change or bug fix should include a test to ensure the new behavior/fix is working as intended.
Since these are integration tests, you need to first make sure that your local db is already seeded with the ncessary data. See tools [doc](./db_testing.md) for more information about how to prepare your db.
Since these are integration tests, you need to first make sure that your local db is already seeded with the ncessary data. See tools [doc](db_testing.md) for more information about how to prepare your db.
Testing tools offer two clients that are the basic of most tests:
- `local`: this client connects to the local db
- `proxy client`: this client connects to the running local instance
You need to start an instance of the server before running the tests. Check [here](./commands.md) for how to start.
You need to start an instance of the server before running the tests. Check [here](commands.md) for how to start.

View File

@@ -50,7 +50,7 @@ By default, the instance runs against devnet. to configure that you will need to
3. **Docker**: Containerize the running services such as Postgres and Redis.
4. **Mnemonics**: Secret seeds for adummy identity to use for the relay client.
For more about the prerequisites and how to set up and configure them. follow the [Setup guide](./setup.md)
For more about the prerequisites and how to set up and configure them. follow the [Setup guide](setup.md)
<!-- Development -->
@@ -90,7 +90,7 @@ To start the services for development or testing make sure first you have all th
make docs
```
To run in development environment see [here](./db_testing.md) how to generate test db or load a db dump then use:
To run in development environment see [here](db_testing.md) how to generate test db or load a db dump then use:
```sh
go run cmds/proxy_server/main.go --address :8080 --log-level debug -no-cert --postgres-host 127.0.0.1 --postgres-db tfgrid-graphql --postgres-password postgres --postgres-user postgres --mnemonics <insert user mnemonics>
@@ -98,7 +98,7 @@ go run cmds/proxy_server/main.go --address :8080 --log-level debug -no-cert --po
Then visit `http://localhost:8080/<endpoint>`
For more illustrations about the commands needed to work on the project, see the section [Commands](./commands.md). For more info about the project structure and contributions guidelines check the section [Contributions](./contributions.md).
For more illustrations about the commands needed to work on the project, see the section [Commands](commands.md). For more info about the project structure and contributions guidelines check the section [Contributions](contributions.md).
<!-- Production-->

View File

@@ -14,12 +14,12 @@ To assist you on your journey, we have organized the content into distinct chapt
<h2>Table of Contents</h2>
- [Introducing Grid Proxy](./proxy.md)
- [Setup](./setup.md)
- [DB Testing](./db_testing.md)
- [Commands](./commands.md)
- [Contributions](./contributions.md)
- [Explorer](./explorer.md)
- [Database](./database.md)
- [Production](./production.md)
- [Release](./release.md)
- [Introducing Grid Proxy](proxy.md)
- [Setup](setup.md)
- [DB Testing](db_testing.md)
- [Commands](commands.md)
- [Contributions](contributions.md)
- [Explorer](explorer.md)
- [Database](database.md)
- [Production](production.md)
- [Release](release.md)

View File

@@ -6,10 +6,10 @@ Consult the [ThreeFoldTech TFCMD repository](https://github.com/threefoldtech/tf
<h2>Table of Contents</h2>
- [Getting Started](./tfcmd_basics.md)
- [Deploy a VM](./tfcmd_vm.md)
- [Deploy Kubernetes](./tfcmd_kubernetes.md)
- [Deploy ZDB](./tfcmd_zdbs.md)
- [Gateway FQDN](./tfcmd_gateway_fqdn.md)
- [Gateway Name](./tfcmd_gateway_name.md)
- [Contracts](./tfcmd_contracts.md)
- [Getting Started](tfcmd_basics.md)
- [Deploy a VM](tfcmd_vm.md)
- [Deploy Kubernetes](tfcmd_kubernetes.md)
- [Deploy ZDB](tfcmd_zdbs.md)
- [Gateway FQDN](tfcmd_gateway_fqdn.md)
- [Gateway Name](tfcmd_gateway_name.md)
- [Contracts](tfcmd_contracts.md)

View File

@@ -6,8 +6,8 @@ Consult the [ThreeFoldTech TFROBOT repository](https://github.com/threefoldtech/
<h2>Table of Contents</h2>
- [Installation](./tfrobot_installation.md)
- [Configuration File](./tfrobot_config.md)
- [Deployment](./tfrobot_deploy.md)
- [Commands and Flags](./tfrobot_commands_flags.md)
- [Supported Configurations](./tfrobot_configurations.md)
- [Installation](tfrobot_installation.md)
- [Configuration File](tfrobot_config.md)
- [Deployment](tfrobot_deploy.md)
- [Commands and Flags](tfrobot_commands_flags.md)
- [Supported Configurations](tfrobot_configurations.md)

View File

@@ -20,7 +20,7 @@ We present how to deploy workloads on the ThreeFold Grid using TFROBOT.
## Prerequisites
To deploy workloads on the TFGrid with TFROBOT, you first need to [install TFROBOT](./tfrobot_installation.md) on your machine and create a [configuration file](./tfrobot_config.md).
To deploy workloads on the TFGrid with TFROBOT, you first need to [install TFROBOT](tfrobot_installation.md) on your machine and create a [configuration file](tfrobot_config.md).
## Deploy Workloads