Merge pull request 'development_manual' (#64) from development_manual into development
Reviewed-on: #64
This commit is contained in:
commit
1ba1e05215
@ -1,7 +1,7 @@
|
||||
- [Introduction](manual/intro.md)
|
||||
- [Documentation](manual/documentation.md)
|
||||
- [Dashboard](dashboard/dashboard.md)
|
||||
- [Wallet (Connector)](dashboard/wallet_connector.md)
|
||||
- [Wallet Connector](dashboard/wallet_connector.md)
|
||||
- [TFGrid](dashboard/tfgrid/tfgrid.md)
|
||||
- [Grid Status](dashboard/tfgrid/grid_status.md)
|
||||
- [Node Statistics](dashboard/tfgrid/node_statistics.md)
|
||||
@ -120,24 +120,24 @@
|
||||
- [RMB Specs](developers/internals/rmb/rmb_specs.md)
|
||||
- [RMB Peer](developers/internals/rmb/uml/peer.md)
|
||||
- [RMB Relay](developers/internals/rmb/uml/relay.md)
|
||||
- [Zero-OS](developers/internals/zos/readme.md)
|
||||
- [Zero-OS](developers/internals/zos/zos_readme.md)
|
||||
- [Manual](developers/internals/zos/manual/manual.md)
|
||||
- [Workload Types](developers/internals/zos/manual/workload_types.md)
|
||||
- [Internal Modules](developers/internals/zos/internals/internals.md)
|
||||
- [Identity](developers/internals/zos/internals/identity/readme.md)
|
||||
- [Identity](developers/internals/zos/internals/identity/identity_readme.md)
|
||||
- [Node ID Generation](developers/internals/zos/internals/identity/identity.md)
|
||||
- [Node Upgrade](developers/internals/zos/internals/identity/upgrade.md)
|
||||
- [Node](developers/internals/zos/internals/node/readme.md)
|
||||
- [Storage](developers/internals/zos/internals/storage/readme.md)
|
||||
- [Network](developers/internals/zos/internals/network/readme.md)
|
||||
- [Node](developers/internals/zos/internals/node/node_readme.md)
|
||||
- [Storage](developers/internals/zos/internals/storage/storage_readme.md)
|
||||
- [Network](developers/internals/zos/internals/network/network_readme.md)
|
||||
- [Introduction](developers/internals/zos/internals/network/introduction.md)
|
||||
- [Definitions](developers/internals/zos/internals/network/definitions.md)
|
||||
- [Mesh](developers/internals/zos/internals/network/mesh.md)
|
||||
- [Setup](developers/internals/zos/internals/network/setup_farm_network.md)
|
||||
- [Flist](developers/internals/zos/internals/flist/readme.md)
|
||||
- [Container](developers/internals/zos/internals/container/readme.md)
|
||||
- [VM](developers/internals/zos/internals/vmd/readme.md)
|
||||
- [Provision](developers/internals/zos/internals/provision/readme.md)
|
||||
- [Flist](developers/internals/zos/internals/flist/flist_readme.md)
|
||||
- [Container](developers/internals/zos/internals/container/container_readme.md)
|
||||
- [VM](developers/internals/zos/internals/vmd/vmd_readme.md)
|
||||
- [Provision](developers/internals/zos/internals/provision/provision_readme.md)
|
||||
- [Capacity](developers/internals/zos/internals/capacity.md)
|
||||
- [Performance Monitor Package](developers/internals/zos/performance/performance.md)
|
||||
- [Public IPs Validation Task](developers/internals/zos/performance/publicips.md)
|
||||
@ -305,38 +305,45 @@
|
||||
- [TFGrid v3.0.0](about/roadmap/releasenotes/tfgrid_release_3_0.md)
|
||||
- [ThreeFold Token](about/token_overview/token_overview.md)
|
||||
- [Special Wallets](about/token_overview/special_wallets/stats_special_wallets.md)
|
||||
- [Technology](technology/technology_toc.md)
|
||||
- [How It Works](technology/grid3_howitworks.md)
|
||||
- [Grid Concepts](technology/concepts/concepts_readme.md)
|
||||
- [TFGrid Primitives](technology/concepts/grid_primitives.md)
|
||||
- [TFGrid Component List](technology/concepts/grid3_components.md)
|
||||
- [Infrastructure as Code](technology/concepts/grid3_iac.md)
|
||||
- [Proof of Utilization](technology/concepts/proof_of_utilization.md)
|
||||
- [Contract Grace Period](technology/concepts/contract_grace_period.md)
|
||||
- [What's New on TFGrid v3.x](technology/concepts/grid3_whatsnew.md)
|
||||
- [TFChain](technology/concepts/tfchain.md)
|
||||
- [TFGrid by Design](technology/concepts/tfgrid_by_design.md)
|
||||
- [Primitives](technology/primitives/primitives_toc.md)
|
||||
- [Compute](technology/primitives/compute/compute_toc.md)
|
||||
- [ZKube](technology/primitives/compute/zkube.md)
|
||||
- [ZMachine](technology/primitives/compute/zmachine.md)
|
||||
- [CoreX](technology/primitives/compute/corex.md)
|
||||
- [Storage](technology/primitives/storage/storage_toc.md)
|
||||
- [ZOS Filesystem](technology/primitives/storage/zos_fs.md)
|
||||
- [ZOS Mount](technology/primitives/storage/zmount.md)
|
||||
- [Quantum Safe File System](technology/primitives/storage/qsfs.md)
|
||||
- [Zero-DB](technology/primitives/storage/zdb.md)
|
||||
- [Zero-Disk](technology/primitives/storage/zdisk.md)
|
||||
- [Network](technology/primitives/network/network_toc.md)
|
||||
- [ZNET](technology/primitives/network/znet.md)
|
||||
- [ZNIC](technology/primitives/network/znic.md)
|
||||
- [WebGateway](technology/primitives/network/webgw3.md)
|
||||
- [Zero-OS Advantages](technology/zos/benefits/zos_advantages.md)
|
||||
- [Quantum Safe Storage](technology/qsss/qsss_home.md)
|
||||
- [Smart Contract IT](technology/smartcontract_it/smartcontract_toc.md)
|
||||
- [Introduction](technology/smartcontract_it/smartcontract_tfgrid3.md)
|
||||
- [Infrastructure As Code - IAC](technology/smartcontract_it/smartcontract_iac.md)
|
||||
- [3Bot Integration](technology/smartcontract_it/smartcontract_3bot.md)
|
||||
- [Technology](tech/technology_toc.md)
|
||||
- [Introduction](tech/technology.md)
|
||||
- [The Internet Today](tech/internet_today.md)
|
||||
- [History of Computers](tech/history/c64.md)
|
||||
- [Too Many Layers](tech/history/layers.md)
|
||||
- [The Internet Re-invented](tech/how_does_it_work.md)
|
||||
- [World Records](tech/world_records.md)
|
||||
- [Key Innovations](tech/key_innovations_overview.md)
|
||||
- [Mycelium Network](tech/mycelium_innovation.md)
|
||||
- [Zero-OS](tech/zos_innovation.md)
|
||||
- [Quantum Safe Storage](tech/zstor_innovation.md)
|
||||
- [Quantum Safe Filesystem](tech/qsfs_innovation.md)
|
||||
- [FList: Better OS Images](tech/flist_innovation.md)
|
||||
- [FungiStor](tech/fungistor_innovation.md)
|
||||
- [Network Wall](tech/network_wall_innovation.md)
|
||||
- [Architecture](tech/architecture.md)
|
||||
- [Energy Efficient](tech/energy_efficient.md)
|
||||
- [Decentralized Cloud Core Capabilities](tech/features.md)
|
||||
- [Storage](tech/qsss_home.md)
|
||||
- [Quantum Safe Storage Algo](tech/qss_algorithm.md)
|
||||
- [Zero Knowledge proof](tech/qss_zero_knowledge_proof.md)
|
||||
- [NFT Storage](tech/nft_storage.md)
|
||||
- [S3 Storage](tech/s3_interface)
|
||||
- [File System](tech/qss_filesystem.md)
|
||||
- [Network](tech/networking.md)
|
||||
- [Mycelium](tech/mycelium.md)
|
||||
- [Web Gateway](tech/webgw.md)
|
||||
- [Partners](partners_utilization/partners.md)
|
||||
- [Sikana](partners_utilization/sikana.md)
|
||||
- [Vindo](partners_utilization/vindo.md)
|
||||
- [Mkondo](partners_utilization/mkondo.md)
|
||||
- [Vverse](partners_utilization/vverse.md)
|
||||
- [Earth Wallet](partners_utilization/earth_wallet.md)
|
||||
- [Elestio](partners_utilization/elestio.md)
|
||||
- [OW Freezone](partners_utilization/freezone.md)
|
||||
- [Helium](partners_utilization/helium.md)
|
||||
- [Holochain](partners_utilization/holochain.md)
|
||||
- [TZG](partners_utilization/tanzania.md)
|
||||
- [Tier-S DC](partners_utilization/tier_s_datacenter.md)
|
||||
- [Farming](farming/farming_toc.md)
|
||||
- [Farming Rewards](farming/farming_reward.md)
|
||||
- [Proof-of-Capacity](farming/proof_of_capacity.md)
|
||||
@ -367,13 +374,13 @@
|
||||
- [How to Test](collaboration/testing/testing_readme.md)
|
||||
- [TestLodge](collaboration/testing/testlodge.md)
|
||||
- [Code of Conduct](collaboration/code_conduct.md)
|
||||
- [Legal](manual_legal/terms_conditions_all3.md)
|
||||
- [Disclaimer](manual_legal/disclaimer.md)
|
||||
- [Definitions](manual_legal/definitions_legal.md)
|
||||
- [Privacy Policy](manual_legal/privacypolicy.md)
|
||||
- [Terms & Conditions](manual_legal/terms_conditions/terms_conditions_toc.md)
|
||||
- [Terms & Conditions ThreeFold Related Websites](manual_legal/terms_conditions/terms_conditions_websites.md)
|
||||
- [Terms & Conditions TFGrid Users TFGrid 3](manual_legal/terms_conditions/terms_conditions_griduser.md)
|
||||
- [TFTA to TFT](manual_legal/terms_conditions/tfta_to_tft.md)
|
||||
- [Terms & Conditions TFGrid Farmers TFGrid 3](manual_legal/terms_conditions/terms_conditions_farmer3.md)
|
||||
- [Terms & Conditions Sales](manual_legal/terms_conditions/terms_conditions_sales.md)
|
||||
- [Legal](legal/legal_home.md)
|
||||
- [Disclaimer](legal/disclaimer.md)
|
||||
- [Definitions](legal/definitions_legal.md)
|
||||
- [Terms & Conditions](legal/terms_conditions/terms_conditions_toc.md)
|
||||
- [Terms and Conditions Websites](legal/terms_conditions_websites.md)
|
||||
- [Terms and Conditions Users](legal/terms_conditions_griduser.md)
|
||||
- [TFTA to TFT](legal/tfta_to_tft.md)
|
||||
- [Terms and Conditions Farmers](legal/terms_conditions_farmer3.md)
|
||||
- [Terms and Conditions Sales](legal/terms_conditions_sales.md)
|
||||
- [Privacy Policy](legal/privacypolicy.md)
|
||||
@ -33,6 +33,6 @@
|
||||
- [Elestio](partners_utilization/elestio.md)
|
||||
- [OW Freezone](partners_utilization/freezone.md)
|
||||
- [Helium](partners_utilization/helium.md)
|
||||
- [Holochain](partners_utilization/helium.md)
|
||||
- [Holochain](partners_utilization/holochain.md)
|
||||
- [TZG](partners_utilization/tanzania.md)
|
||||
- [Tier-S DC](partners_utilization/tier_s_datacenter.md)
|
||||
@ -10,7 +10,7 @@ The ThreeFold Dashboard is a dynamic environment designed for both seasoned deve
|
||||
|
||||
In the context of the Dashboard, a weblet is a compiled JavaScript web component that can be effortlessly embedded within the HTML page of a web application. This modular approach allows for flexible and intuitive interactions, facilitating a user-friendly deployment process.
|
||||
|
||||
The backend for the weblets is introduced with the [Javascript Client](../developers/javascript/grid3_javascript_readme.md) which communicates to TFChain over RMB.
|
||||
The backend for the weblets is introduced with the [Javascript Client](developers@@grid3_javascript_readme) which communicates to TFChain over RMB.
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
|
||||
@ -8,17 +8,17 @@ Easily deploy your favourite applications on the ThreeFold grid with a click of
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Algorand](../solutions/algorand.md)
|
||||
- [CasperLabs](../solutions/casper.md)
|
||||
- [Discourse](../solutions/discourse.md)
|
||||
- [Funkwhale](../solutions/funkwhale.md)
|
||||
- [Mattermost](../solutions/mattermost.md)
|
||||
- [Nextcloud](../solutions/nextcloud.md)
|
||||
- [Node Pilot](../solutions/nodepilot.md)
|
||||
- [ownCloud](../solutions/owncloud.md)
|
||||
- [Peertube](../solutions/peertube.md)
|
||||
- [Presearch](../solutions/presearch.md)
|
||||
- [Subsquid](../solutions/subsquid.md)
|
||||
- [Taiga](../solutions/taiga.md)
|
||||
- [Umbrel](../solutions/umbrel.md)
|
||||
- [WordPress](../solutions/wordpress.md)
|
||||
- [Algorand](algorand.md)
|
||||
- [CasperLabs](casper.md)
|
||||
- [Discourse](discourse.md)
|
||||
- [Funkwhale](funkwhale.md)
|
||||
- [Mattermost](mattermost.md)
|
||||
- [Nextcloud](nextcloud.md)
|
||||
- [Node Pilot](nodepilot.md)
|
||||
- [ownCloud](owncloud.md)
|
||||
- [Peertube](peertube.md)
|
||||
- [Presearch](presearch.md)
|
||||
- [Subsquid](subsquid.md)
|
||||
- [Taiga](taiga.md)
|
||||
- [Umbrel](umbrel.md)
|
||||
- [WordPress](wordpress.md)
|
||||
@ -2,26 +2,26 @@
|
||||
|
||||
Here you will find everything related to deployments on the ThreeFold grid. This includes:
|
||||
|
||||
- Checking the cost of a deployment using [Pricing Calculator](./pricing_calculator.md)
|
||||
- Finding a node to deploy on using the [Node Finder](./node_finder.md)
|
||||
- Deploying your desired workload from [Virtual Machines](../solutions/vm_intro.md), [Orchestrators](./orchestrators.md), or [Applictions](./applications.md)
|
||||
- Renting your own node on the ThreeFold grid from [Dedicated Machines](./dedicated_machines.md)
|
||||
- Consulting [Your Contracts](./your_contracts.md) on the TFGrid
|
||||
- Finding or publishing Flists from [Images](./images.md)
|
||||
- Updating or generating your SSH key from [SSH Keys](./ssh_keys.md)
|
||||
- Checking the cost of a deployment using [Pricing Calculator](pricing_calculator.md)
|
||||
- Finding a node to deploy on using the [Node Finder](node_finder.md)
|
||||
- Deploying your desired workload from [Virtual Machines](vm_intro.md), [Orchestrators](orchestrators.md), or [Applictions](applications.md)
|
||||
- Renting your own node on the ThreeFold grid from [Dedicated Machines](dedicated_machines.md)
|
||||
- Consulting [Your Contracts](your_contracts.md) on the TFGrid
|
||||
- Finding or publishing Flists from [Images](images.md)
|
||||
- Updating or generating your SSH key from [SSH Keys](ssh_keys.md)
|
||||
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
## Table of Content
|
||||
|
||||
- [Pricing Calculator](./pricing_calculator.md)
|
||||
- [Node Finder](./node_finder.md)
|
||||
- [Virtual Machines](../solutions/vm_intro.md)
|
||||
- [Orchestrators](./orchestrators.md)
|
||||
- [Dedicated Machines](./dedicated_machines.md)
|
||||
- [Applications](./applications.md)
|
||||
- [Your Contracts](./your_contracts.md)
|
||||
- [Images](./images.md)
|
||||
- [SSH Keys](./ssh_keys.md)
|
||||
- [Pricing Calculator](pricing_calculator.md)
|
||||
- [Node Finder](node_finder.md)
|
||||
- [Virtual Machines](vm_intro.md)
|
||||
- [Orchestrators](orchestrators.md)
|
||||
- [Dedicated Machines](dedicated_machines.md)
|
||||
- [Applications](applications.md)
|
||||
- [Your Contracts](your_contracts.md)
|
||||
- [Images](images.md)
|
||||
- [SSH Keys](ssh_keys.md)
|
||||
@ -8,7 +8,7 @@ Deploy your favorite orchestrating services and enjoy the seamless coordination
|
||||
|
||||
## Table of Contnet
|
||||
|
||||
- [Kubernetes](../solutions/k8s.md)
|
||||
- [Caprover](../solutions/caprover.md)
|
||||
- [Caprover Admin](../solutions/caprover_admin.md)
|
||||
- [Caprover Worker](../solutions/caprover_worker.md)
|
||||
- [Kubernetes](k8s.md)
|
||||
- [Caprover](caprover.md)
|
||||
- [Caprover Admin](caprover_admin.md)
|
||||
- [Caprover Worker](caprover_worker.md)
|
||||
@ -8,6 +8,6 @@ On the TFGrid, you can deploy both micro and full virtual machines.
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Micro and Full VM Differences ](../solutions/vm_differences.md)
|
||||
- [Full Virtual Machine](../solutions/fullVm.md)
|
||||
- [Micro Virtual Machine](../solutions/vm.md)
|
||||
- [Micro and Full VM Differences ](vm_differences.md)
|
||||
- [Full Virtual Machine](fullVm.md)
|
||||
- [Micro Virtual Machine](vm.md)
|
||||
|
||||
@ -2,89 +2,89 @@
|
||||
|
||||
This section covers all practical tutorials on how to develop and build on the ThreeFold Grid.
|
||||
|
||||
For complementary information on the technology developed by ThreeFold, refer to the [Technology](../../knowledge_base/technology/technology_toc.md) section.
|
||||
For complementary information on the technology developed by ThreeFold, refer to the [Technology](tech@@technology_toc) section.
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Javascript Client](./javascript/grid3_javascript_readme.md)
|
||||
- [Installation](./javascript/grid3_javascript_installation.md)
|
||||
- [Loading Client](./javascript/grid3_javascript_loadclient.md)
|
||||
- [Deploy a VM](./javascript/grid3_javascript_vm.md)
|
||||
- [Capacity Planning](./javascript/grid3_javascript_capacity_planning.md)
|
||||
- [Deploy Multiple VMs](./javascript/grid3_javascript_vms.md)
|
||||
- [Deploy CapRover](./javascript/grid3_javascript_caprover.md)
|
||||
- [Gateways](./javascript/grid3_javascript_vm_gateways.md)
|
||||
- [Deploy a Kubernetes Cluster](./javascript/grid3_javascript_kubernetes.md)
|
||||
- [Deploy a ZDB](./javascript/grid3_javascript_zdb.md)
|
||||
- [Deploy ZDBs for QSFS](./javascript/grid3_javascript_qsfs_zdbs.md)
|
||||
- [QSFS](./javascript/grid3_javascript_qsfs.md)
|
||||
- [Key Value Store](./javascript/grid3_javascript_kvstore.md)
|
||||
- [VM with Wireguard and Gateway](./javascript/grid3_wireguard_gateway.md)
|
||||
- [GPU Support](./javascript/grid3_javascript_gpu_support.md)
|
||||
- [Go Client](./go/grid3_go_readme.md)
|
||||
- [Installation](./go/grid3_go_installation.md)
|
||||
- [Loading Client](./go/grid3_go_load_client.md)
|
||||
- [Deploy a VM](./go/grid3_go_vm.md)
|
||||
- [Deploy Multiple VMs](./go/grid3_go_vms.md)
|
||||
- [Deploy Gateways](./go/grid3_go_gateways.md)
|
||||
- [Deploy Kubernetes](./go/grid3_go_kubernetes.md)
|
||||
- [Deploy a QSFS](./go/grid3_go_qsfs.md)
|
||||
- [GPU Support](./go/grid3_go_gpu.md)
|
||||
- [TFCMD](./tfcmd/tfcmd.md)
|
||||
- [Getting Started](./tfcmd/tfcmd_basics.md)
|
||||
- [Deploy a VM](./tfcmd/tfcmd_vm.md)
|
||||
- [Deploy Kubernetes](./tfcmd/tfcmd_kubernetes.md)
|
||||
- [Deploy ZDB](./tfcmd/tfcmd_zdbs.md)
|
||||
- [Gateway FQDN](./tfcmd/tfcmd_gateway_fqdn.md)
|
||||
- [Gateway Name](./tfcmd/tfcmd_gateway_name.md)
|
||||
- [Contracts](./tfcmd/tfcmd_contracts.md)
|
||||
- [TFROBOT](./tfrobot/tfrobot.md)
|
||||
- [Installation](./tfrobot/tfrobot_installation.md)
|
||||
- [Configuration File](./tfrobot/tfrobot_config.md)
|
||||
- [Deployment](./tfrobot/tfrobot_deploy.md)
|
||||
- [Commands and Flags](./tfrobot/tfrobot_commands_flags.md)
|
||||
- [Supported Configurations](./tfrobot/tfrobot_configurations.md)
|
||||
- [ThreeFold Chain](./tfchain/tfchain.md)
|
||||
- [Introduction](./tfchain/introduction.md)
|
||||
- [Farming Policies](./tfchain/farming_policies.md)
|
||||
- [External Service Contract](./tfchain/tfchain_external_service_contract.md)
|
||||
- [Solution Provider](./tfchain/tfchain_solution_provider.md)
|
||||
- [Grid Proxy](./proxy/proxy_readme.md)
|
||||
- [Introducing Grid Proxy](./proxy/proxy.md)
|
||||
- [Setup](./proxy/setup.md)
|
||||
- [DB Testing](./proxy/db_testing.md)
|
||||
- [Commands](./proxy/commands.md)
|
||||
- [Contributions](./proxy/contributions.md)
|
||||
- [Explorer](./proxy/explorer.md)
|
||||
- [Database](./proxy/database.md)
|
||||
- [Production](./proxy/production.md)
|
||||
- [Release](./proxy/release.md)
|
||||
- [Flist](./flist/flist.md)
|
||||
- [ThreeFold Hub Intro](./flist/flist_hub/zos_hub.md)
|
||||
- [Generate an API Token](./flist/flist_hub/api_token.md)
|
||||
- [Convert Docker Image Into Flist](./flist/flist_hub/convert_docker_image.md)
|
||||
- [Supported Flists](./flist/grid3_supported_flists.md)
|
||||
- [Flist Case Studies](./flist/flist_case_studies/flist_case_studies.md)
|
||||
- [Case Study: Debian 12](./flist/flist_case_studies/flist_debian_case_study.md)
|
||||
- [Case Study: Nextcloud AIO](./flist/flist_case_studies/flist_nextcloud_case_study.md)
|
||||
- [Internals](./internals/internals.md)
|
||||
- [Reliable Message Bus (RMB)](./internals/rmb/rmb_toc.md)
|
||||
- [Introduction to RMB](./internals/rmb/rmb_intro.md)
|
||||
- [RMB Specs](./internals/rmb/rmb_specs.md)
|
||||
- [RMB Peer](./internals/rmb/uml/peer.md)
|
||||
- [RMB Relay](./internals/rmb/uml/relay.md)
|
||||
- [ZOS](./internals/zos/index.md)
|
||||
- [Manual](./internals/zos/manual/manual.md)
|
||||
- [Workload Types](./internals/zos/manual/workload_types.md)
|
||||
- [Internal Modules](./internals/zos/internals/internals.md)
|
||||
- [Capacity](./internals/zos/internals/capacity.md)
|
||||
- [Performance Monitor Package](./internals/zos/performance/performance.md)
|
||||
- [Public IPs Validation Task](./internals/zos/performance/publicips.md)
|
||||
- [CPUBenchmark](./internals/zos/performance/cpubench.md)
|
||||
- [IPerf](./internals/zos/performance/iperf.md)
|
||||
- [Health Check](./internals/zos/performance/healthcheck.md)
|
||||
- [API](./internals/zos/manual/api.md)
|
||||
- [Grid Deployment](./grid_deployment/grid_deployment.md)
|
||||
- [TFGrid Stacks](./grid_deployment/tfgrid_stacks.md)
|
||||
- [Full VM Grid Deployment](./grid_deployment/grid_deployment_full_vm.md)
|
||||
- [Grid Snapshots](./grid_deployment/snapshots.md)
|
||||
- [Javascript Client](grid3_javascript_readme.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)
|
||||
- [Go Client](grid3_go_readme.md)
|
||||
- [Installation](grid3_go_installation.md)
|
||||
- [Loading Client](grid3_go_load_client.md)
|
||||
- [Deploy a VM](grid3_go_vm.md)
|
||||
- [Deploy Multiple VMs](grid3_go_vms.md)
|
||||
- [Deploy Gateways](grid3_go_gateways.md)
|
||||
- [Deploy Kubernetes](grid3_go_kubernetes.md)
|
||||
- [Deploy a QSFS](grid3_go_qsfs.md)
|
||||
- [GPU Support](grid3_go_gpu.md)
|
||||
- [TFCMD](tfcmd.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)
|
||||
- [TFROBOT](tfrobot.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)
|
||||
- [ThreeFold Chain](tfchain.md)
|
||||
- [Introduction](introduction.md)
|
||||
- [Farming Policies](farming_policies.md)
|
||||
- [External Service Contract](tfchain_external_service_contract.md)
|
||||
- [Solution Provider](tfchain_solution_provider.md)
|
||||
- [Grid Proxy](proxy_readme.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)
|
||||
- [Flist](flist.md)
|
||||
- [ThreeFold Hub Intro](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)
|
||||
- [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)
|
||||
- [Internals](internals.md)
|
||||
- [Reliable Message Bus (RMB)](rmb_toc.md)
|
||||
- [Introduction to RMB](rmb_intro.md)
|
||||
- [RMB Specs](rmb_specs.md)
|
||||
- [RMB Peer](peer.md)
|
||||
- [RMB Relay](relay.md)
|
||||
- [ZOS](index.md)
|
||||
- [Manual](manual.md)
|
||||
- [Workload Types](workload_types.md)
|
||||
- [Internal Modules](internals.md)
|
||||
- [Capacity](capacity.md)
|
||||
- [Performance Monitor Package](performance.md)
|
||||
- [Public IPs Validation Task](publicips.md)
|
||||
- [CPUBenchmark](cpubench.md)
|
||||
- [IPerf](iperf.md)
|
||||
- [Health Check](healthcheck.md)
|
||||
- [API](api.md)
|
||||
- [Grid Deployment](grid_deployment.md)
|
||||
- [TFGrid Stacks](tfgrid_stacks.md)
|
||||
- [Full VM Grid Deployment](grid_deployment_full_vm.md)
|
||||
- [Grid Snapshots](snapshots.md)
|
||||
@ -2,10 +2,10 @@
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Zero-OS Hub](manual:zos_hub.md)
|
||||
- [Zero-OS Hub](zos_hub.md)
|
||||
- [Generate an API Token](api_token.md)
|
||||
- [Convert Docker Image Into Flist](./flist_hub/convert_docker_image.md)
|
||||
- [Convert Docker Image Into Flist](convert_docker_image.md)
|
||||
- [Supported Flists](./grid3_supported_flists.md)
|
||||
- [Flist Case Studies](./flist_case_studies/flist_case_studies.md)
|
||||
- [Case Study: Debian 12](./flist_case_studies/flist_debian_case_study.md)
|
||||
- [Case Study: Nextcloud AIO](./flist_case_studies/flist_nextcloud_case_study.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)
|
||||
@ -49,7 +49,7 @@ As a general advice, before creating an flist for a ThreeFold deployment, you sh
|
||||
|
||||
Before we go any further, let us recall what is an flist. In short, an flist is a technology for storing and efficiently sharing sets of files. While it has many great features, it's purpose in this case is simply to deliver the image contents to Zero-OS for execution as a micro VM. It thus acts as a bundle of files like a normal archive.
|
||||
|
||||
One convenient thing about the flist technology is that it is possible to convert any Docker image into an flist, thanks to the [ThreeFold Docker Hub Converter tool](https://hub.grid.tf/docker-convert). It is very easy to do and we will show you how to proceed in this case study. For a quick guide on converting Docker images into flists, read [this section](../flist_hub/convert_docker_image.md) of the ThreeFold Manual.
|
||||
One convenient thing about the flist technology is that it is possible to convert any Docker image into an flist, thanks to the [ThreeFold Docker Hub Converter tool](https://hub.grid.tf/docker-convert). It is very easy to do and we will show you how to proceed in this case study. For a quick guide on converting Docker images into flists, read [this section](convert_docker_image.md) of the ThreeFold Manual.
|
||||
|
||||
## Case Study Objective
|
||||
|
||||
@ -70,7 +70,7 @@ One important thing to have in mind is that, when we create an flist, what we ar
|
||||
|
||||
Once we've successfully created an flist, we thus have a very quick way to deploy a specific workload while always obtaining the same result. This is why it is highly recommended to test a given deployment on a full or micro VM before building an flist.
|
||||
|
||||
For example, in the case of building a Nextcloud All-in-One flist, the prerequisites would be to successfully deploy a Nextcloud AIO instance on a full VM by executing each step sequentially. This specific example is documented in the Terraform section [Nextcloud All-in-One Guide](../../../system_administrators/terraform/advanced/terraform_nextcloud_aio.md) of the System Administrators book.
|
||||
For example, in the case of building a Nextcloud All-in-One flist, the prerequisites would be to successfully deploy a Nextcloud AIO instance on a full VM by executing each step sequentially. This specific example is documented in the Terraform section [Nextcloud All-in-One Guide](system_administrators@@terraform_nextcloud_aio) of the System Administrators book.
|
||||
|
||||
In our case, the flist we will be using has some specific configurations depending on the way we deploy Nextcloud (e.g. using or not the gateway and a custom domain). The Terraform **main.tf** we will be sharing later on will thus take all this into account for a smooth deployment.
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@
|
||||
|
||||
Grid Go Client is a Go client created to interact and develop on Threefold Grid using Go language.
|
||||
|
||||
Please make sure to check the [basics](../../system_administrators/getstarted/tfgrid3_getstarted.md) before continuing.
|
||||
Please make sure to check the [basics](system_administrators@@tfgrid3_getstarted) before continuing.
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Installation](../go/grid3_go_installation.md)
|
||||
- [Loading Client](../go/grid3_go_load_client.md)
|
||||
- [Deploy a VM](../go/grid3_go_vm.md)
|
||||
- [Deploy a VM with GPU](../go/grid3_go_vm_with_gpu.md)
|
||||
- [Deploy Multiple VMs](../go/grid3_go_vms.md)
|
||||
- [Deploy Gateways](../go/grid3_go_gateways.md)
|
||||
- [Deploy Kubernetes](../go/grid3_go_kubernetes.md)
|
||||
- [Deploy a QSFS](../go/grid3_go_qsfs.md)
|
||||
- [GPU Support](../go/grid3_go_gpu_support.md)
|
||||
- [Installation](grid3_go_installation.md)
|
||||
- [Loading Client](grid3_go_load_client.md)
|
||||
- [Deploy a VM](grid3_go_vm.md)
|
||||
- [Deploy a VM with GPU](grid3_go_vm_with_gpu.md)
|
||||
- [Deploy Multiple VMs](grid3_go_vms.md)
|
||||
- [Deploy Gateways](grid3_go_gateways.md)
|
||||
- [Deploy Kubernetes](grid3_go_kubernetes.md)
|
||||
- [Deploy a QSFS](grid3_go_qsfs.md)
|
||||
- [GPU Support](grid3_go_gpu_support.md)
|
||||
|
||||
@ -53,7 +53,7 @@ ThreeFold hosts all available snapshots at: [https://bknd.snapshot.grid.tf/](htt
|
||||
|
||||
## Deploy the Services with Scripts
|
||||
|
||||
You can deploy the 3 individual services using known methods such as [Docker](../../system_administrators/computer_it_basics/docker_basics.md). To facilitate the process, scripts are provided that run the necessary docker commands.
|
||||
You can deploy the 3 individual services using known methods such as [Docker](system_administrators@@docker_basics). To facilitate the process, scripts are provided that run the necessary docker commands.
|
||||
|
||||
The first script creates the snapshots, while the second and third scripts serve to start and stop all services.
|
||||
|
||||
|
||||
@ -23,8 +23,8 @@ To facilitate deploying grid backend services, we provide snapshots to significa
|
||||
|
||||
There are a few prerequisites to properly run the ThreeFold services.
|
||||
|
||||
- [Docker engine](../computer_it_basics/docker_basics.md#install-docker-desktop-and-docker-engine)
|
||||
- [Rsync](../computer_it_basics/file_transfer.md#rsync)
|
||||
- [Docker engine](system_administrators@@docker_basics.md#install-docker-desktop-and-docker-engine)
|
||||
- [Rsync](system_administrators@@file_transfer.md#rsync)
|
||||
|
||||
## Services
|
||||
|
||||
@ -61,7 +61,7 @@ Let's now see how to use those snapshots to run the services via scripts.
|
||||
|
||||
## Deploy the Services with Scripts
|
||||
|
||||
You can deploy the 3 individual services using known methods such as [Docker](https://manual.grid.tf/computer_it_basics/docker_basics.html). To facilitate the process, scripts are provided that run the necessary docker commands.
|
||||
You can deploy the 3 individual services using known methods such as [Docker](docker_basics.md). To facilitate the process, scripts are provided that run the necessary docker commands.
|
||||
|
||||
The first script creates the snapshots, while the second and third scripts serve to start and stop all services.
|
||||
|
||||
@ -202,5 +202,3 @@ systemctl start rsync
|
||||
systemctl enable rsync
|
||||
systemctl status rsync
|
||||
```
|
||||
|
||||
If you're interested about hosting your own instance of the grid to strenghten the ThreeFold ecosystem, make sure to read the next section, [Guardians of the Grid](./tfgrid_guardians.md).
|
||||
@ -4,16 +4,16 @@ We present in this section of the developers book a partial list of system compo
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Reliable Message Bus (RMB)](rmb/rmb_toc.md)
|
||||
- [Introduction to RMB](rmb/rmb_intro.md)
|
||||
- [RMB Specs](rmb/rmb_specs.md)
|
||||
- [RMB Peer](rmb/uml/peer.md)
|
||||
- [RMB Relay](rmb/uml/relay.md)
|
||||
- [Reliable Message Bus (RMB)](rmb_toc.md)
|
||||
- [Introduction to RMB](rmb_intro.md)
|
||||
- [RMB Specs](rmb_specs.md)
|
||||
- [RMB Peer](peer.md)
|
||||
- [RMB Relay](relay.md)
|
||||
|
||||
- [ZOS](zos/index.md)
|
||||
- [Manual](./zos/manual/manual.md)
|
||||
- [Workload Types](./zos/manual/workload_types.md)
|
||||
- [Internal Modules](./zos/internals/internals.md)
|
||||
- [Capacity](./zos/internals/capacity.md)
|
||||
- [Performance Monitor Package](./zos/performance/performance.md)
|
||||
- [API](./zos/manual/api.md)
|
||||
- [ZOS](zos_readme.md)
|
||||
- [Manual](manual.md)
|
||||
- [Workload Types](workload_types.md)
|
||||
- [Internal Modules](internals.md)
|
||||
- [Capacity](capacity.md)
|
||||
- [Performance Monitor Package](performance.md)
|
||||
- [API](api.md)
|
||||
@ -14,5 +14,5 @@ Out of the box RMB provides the following:
|
||||
|
||||
- [Introduction to RMB](rmb_intro.md)
|
||||
- [RMB Specs](rmb_specs.md)
|
||||
- [RMB Peer](uml/peer.md)
|
||||
- [RMB Relay](uml/relay.md)
|
||||
- [RMB Peer](peer.md)
|
||||
- [RMB Relay](relay.md)
|
||||
@ -8,7 +8,7 @@
|
||||
## Starting a local zos node
|
||||
|
||||
* Make sure `qemu` and `dnsmasq` are installed
|
||||
* [Create a farm](../manual/manual.md#creating-a-farm)
|
||||
* [Create a farm](dashboard@@your_farms)
|
||||
* [Download a zos image](https://bootstrap.grid.tf/kernel/zero-os-development-zos-v3-generic-7e587e499a.efi)
|
||||
* Make sure `zos0` bridge is allowed by qemu, you can add `allow zos0` in `/etc/qemu/bridge.conf` (create the file if it's not there)
|
||||
* Setup the network using this script [this script](./net.sh)
|
||||
|
||||
@ -16,7 +16,7 @@ Flist module is available on zbus over the following channel:
|
||||
|
||||
| module | object | version |
|
||||
|--------|--------|---------|
|
||||
|flist |[flist](#public-interface)| 0.0.1
|
||||
|flist |[flist](#public-interface)| 0.0.1 |
|
||||
|
||||
## Home Directory
|
||||
flist keeps some data in the following locations:
|
||||
@ -74,14 +74,14 @@ Modules of zos are completely internal. There is no way for an external user to
|
||||
|
||||
Here is a list of the major ZOS modules.
|
||||
|
||||
- [Identity](identity/index.md)
|
||||
- [Node](node/index.md)
|
||||
- [Storage](storage/index.md)
|
||||
- [Network](network/index.md)
|
||||
- [Flist](flist/index.md)
|
||||
- [Container](container/index.md)
|
||||
- [VM](vmd/index.md)
|
||||
- [Provision](provision/index.md)
|
||||
- [Identity](identity_readme.md)
|
||||
- [Node](node_readme.md)
|
||||
- [Storage](storage_readme.md)
|
||||
- [Network](network_readme.md)
|
||||
- [Flist](flist_readme.md)
|
||||
- [Container](container_readme.md)
|
||||
- [VM](vmd_readme.md)
|
||||
- [Provision](provision_readme.md)
|
||||
|
||||
## Capacity
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ Once initialized, with the network daemon running (a process that will handle al
|
||||
|
||||
## Networkd functionality
|
||||
|
||||
The network daemon is in itself responsible for a few tasks, and working together with the [provision daemon](../provision) it mainly sets up the local infrastructure to get the user network resources, together with the wireguard configurations for the user's mesh network.
|
||||
The network daemon is in itself responsible for a few tasks, and working together with the [provision daemon](provision_readme.md) it mainly sets up the local infrastructure to get the user network resources, together with the wireguard configurations for the user's mesh network.
|
||||
|
||||
The Wireguard mesh is an overlay network. That means that traffic of that network is encrypted and encapsulated in a new traffic frame that the gets transferred over the underlay network, here in essence the network that has been set up during boot of the node.
|
||||
|
||||
|
||||
@ -20,9 +20,9 @@ Node module is available on [zbus](https://github.com/threefoldtech/zbus) over t
|
||||
|
||||
| module | object | version |
|
||||
|--------|--------|---------|
|
||||
|host |host| 0.0.1
|
||||
|system |system| 0.0.1
|
||||
|events |events| 0.0.1
|
||||
|host |host| 0.0.1 |
|
||||
|system |system| 0.0.1 |
|
||||
|events |events| 0.0.1 |
|
||||
|
||||
## Example
|
||||
|
||||
@ -55,7 +55,7 @@ To be able to contact the node directly you need to run
|
||||
- `yggdrasil`
|
||||
- `rmb` (correctly configured)
|
||||
|
||||
Once you have those running you can now contact the node over `rmb`. For a reference implementation (function names and parameters) please refer to [RMB documentation](../../rmb/rmb_toc.md)
|
||||
Once you have those running you can now contact the node over `rmb`. For a reference implementation (function names and parameters) please refer to [RMB documentation](rmb_toc.md)
|
||||
|
||||
Here is a rough example of how low level creation of a deployment is done.
|
||||
|
||||
|
||||
@ -2,27 +2,27 @@
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
- [Manual](./manual/manual.md)
|
||||
- [Workload Types](./manual/workload_types.md)
|
||||
- [Internal Modules](./internals/internals.md)
|
||||
- [Identity](./internals/identity/index.md)
|
||||
- [Node ID Generation](./internals/identity/identity.md)
|
||||
- [Node Upgrade](./internals/identity/upgrade.md)
|
||||
- [Node](./internals/node/index.md)
|
||||
- [Storage](./internals/storage/index.md)
|
||||
- [Network](./internals/network/index.md)
|
||||
- [Introduction](./internals/network/introduction.md)
|
||||
- [Definitions](./internals/network/definitions.md)
|
||||
- [Mesh](./internals/network/mesh.md)
|
||||
- [Setup](./internals/network/setup_farm_network.md)
|
||||
- [Flist](./internals/flist/index.md)
|
||||
- [Container](./internals/container/index.md)
|
||||
- [VM](./internals/vmd/index.md)
|
||||
- [Provision](./internals/provision/index.md)
|
||||
- [Capacity](./internals/capacity.md)
|
||||
- [Performance Monitor Package](./performance/performance.md)
|
||||
- [Public IPs Validation Task](./performance/publicips.md)
|
||||
- [CPUBenchmark](./performance/cpubench.md)
|
||||
- [IPerf](./performance/iperf.md)
|
||||
- [Health Check](./performance/healthcheck.md)
|
||||
- [API](./manual/api.md)
|
||||
- [Manual](manual.md)
|
||||
- [Workload Types](workload_types.md)
|
||||
- [Internal Modules](internals.md)
|
||||
- [Identity](identity_readme.md)
|
||||
- [Node ID Generation](identity.md)
|
||||
- [Node Upgrade](upgrade.md)
|
||||
- [Node](node_readme.md)
|
||||
- [Storage](storage_readme.md)
|
||||
- [Network](network_readme.md)
|
||||
- [Introduction](introduction.md)
|
||||
- [Definitions](definitions.md)
|
||||
- [Mesh](mesh.md)
|
||||
- [Setup](setup_farm_network.md)
|
||||
- [Flist](flist_readme.md)
|
||||
- [Container](container_readme.md)
|
||||
- [VM](vmd_readme.md)
|
||||
- [Provision](provision_readme.md)
|
||||
- [Capacity](capacity.md)
|
||||
- [Performance Monitor Package](performance.md)
|
||||
- [Public IPs Validation Task](publicips.md)
|
||||
- [CPUBenchmark](cpubench.md)
|
||||
- [IPerf](iperf.md)
|
||||
- [Health Check](healthcheck.md)
|
||||
- [API](api.md)
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
|
||||
## Introduction
|
||||
|
||||
It's almost the same as in [deploying a single VM](../javascript/grid3_javascript_vm.md) the only difference is you can automate the choice of the node to deploy on using code. We now support `FilterOptions` to filter nodes based on specific criteria e.g the node resources (CRU, SRU, HRU, MRU) or being part of a specific farm or located in some country, or being a gateway or not
|
||||
It's almost the same as in [deploying a single VM](grid3_javascript_vm.md) the only difference is you can automate the choice of the node to deploy on using code. We now support `FilterOptions` to filter nodes based on specific criteria e.g the node resources (CRU, SRU, HRU, MRU) or being part of a specific farm or located in some country, or being a gateway or not
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ To use the Grid Client, you will need the following on the TFGrid:
|
||||
- A TFChain account
|
||||
- TFT in your wallet
|
||||
|
||||
If it is not the case, please visit the [Get started section](../../system_administrators/getstarted/tfgrid3_getstarted.md).
|
||||
If it is not the case, please visit the [Get started section](system_administrators@@tfgrid3_getstarted).
|
||||
|
||||
## Installation
|
||||
|
||||
@ -81,7 +81,7 @@ Make sure to set the client configuration properly before using the Grid Client.
|
||||
- **network**: The network environment (**dev**, **qa**, **test** or **main**).
|
||||
|
||||
- **mnemonic**: The 12 words mnemonics for your account.
|
||||
- Learn how to create one [here](../../dashboard/wallet_connector.md).
|
||||
- Learn how to create one [here](dashboard@@wallet_connector).
|
||||
|
||||
- **storeSecret**: This is any word that will be used for encrypting/decrypting the keys on ThreeFold key-value store.
|
||||
|
||||
|
||||
@ -62,7 +62,7 @@ using e2e. That's similar to home servers by matrix
|
||||
|
||||
for more details, check [client options](https://github.com/threefoldtech/tfgrid-sdk-ts/blob/development/packages/grid_client/docs/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/deploy/node_finder.md) to know which nodes fits your deployment criteria.
|
||||
> 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.
|
||||
|
||||
Check the document for [capacity planning using code](../javascript/grid3_javascript_capacity_planning.md) if you want to automate it
|
||||
Check the document for [capacity planning using code](grid3_javascript_capacity_planning.md) if you want to automate it
|
||||
> Note: this feature is still experimental
|
||||
|
||||
@ -4,7 +4,7 @@ This section covers developing projects on top of Threefold Grid using Javascrip
|
||||
|
||||
Javascript has a huge ecosystem, and first class citizen when it comes to blockchain technologies like substrate and that was one of the reasons for it to become one the very first supported languages on the grid.
|
||||
|
||||
Please make sure to check the [basics](../../system_administrators/getstarted/tfgrid3_getstarted.md) before continuing.
|
||||
Please make sure to check the [basics](system_administrators@@tfgrid3_getstarted) before continuing.
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
|
||||
@ -145,7 +145,7 @@ We need to specify its
|
||||
- disks: disks model collection
|
||||
- memory
|
||||
- root filesystem size
|
||||
- flist: the image it is going to start from. Check the [supported flists](../flist/grid3_supported_flists.md)
|
||||
- flist: the image it is going to start from. Check the [supported flists](grid3_supported_flists.md)
|
||||
- entry point: entrypoint command / script to execute
|
||||
- env: has the environment variables needed e.g sshkeys used
|
||||
- public ip: if we want to have a public ip attached to the VM
|
||||
|
||||
@ -105,4 +105,4 @@ async function main() {
|
||||
main();
|
||||
```
|
||||
|
||||
It's similiar to the previous section of [deploying a single VM](../javascript/grid3_javascript_vm.md), but just adds more vm objects to vms collection.
|
||||
It's similiar to the previous section of [deploying a single VM](grid3_javascript_vm.md), but just adds more vm objects to vms collection.
|
||||
|
||||
@ -186,7 +186,7 @@ log(vmResult);
|
||||
- `CreateNetWorkModel` :
|
||||
we are creating a network and set the node id to be `gwNode`, the name `monNetwork` and inside the function we set `addAccess: true` to add __wireguard__ access.
|
||||
|
||||
- `createMachineModel` and `createMachinesModel` is similar to the previous section of [deploying a single VM](../javascript/grid3_javascript_vm.md), but we are passing the created `NetworkModel` to the machines model and the entry point here runs a simple python server.
|
||||
- `createMachineModel` and `createMachinesModel` is similar to the previous section of [deploying a single VM](grid3_javascript_vm.md), but we are passing the created `NetworkModel` to the machines model and the entry point here runs a simple python server.
|
||||
|
||||
### Deploy the Gateway
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ The TFGrid client Proxy acts as an interface to access information about the gri
|
||||
|
||||
The proxy is used as the backend of several threefold projects like:
|
||||
|
||||
- [Dashboard](../../dashboard/dashboard.md)
|
||||
- [Dashboard](dashboard@@dashboard)
|
||||
|
||||
<!-- Usage -->
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ To install Golang, you can follow the official [guide](https://go.dev/doc/instal
|
||||
|
||||
## Docker
|
||||
|
||||
Docker is useful for running the TFGridDb in container environment. Read this to [install Docker engine](../../system_administrators/computer_it_basics/docker_basics.md#install-docker-desktop-and-docker-engine).
|
||||
Docker is useful for running the TFGridDb in container environment. Read this to [install Docker engine](system_administrators@@docker_basics).
|
||||
|
||||
Note: it will be necessary to follow step #2 in the previous article to run docker without sudo. if you want to avoid that. edit the docker commands in the `Makefile` and add sudo.
|
||||
|
||||
|
||||
@ -68,7 +68,7 @@ Every contract is billed every 1 hour on the chain, the amount that is due is de
|
||||
- 50% goes to certified sales channel
|
||||
- 35% TFT gets burned
|
||||
|
||||
See [pricing](../../../knowledge_base/cloud/pricing/pricing.md) for more information on how the cost for a contract is calculated.
|
||||
See [pricing](cloud@@pricing) for more information on how the cost for a contract is calculated.
|
||||
|
||||
## Contract locking
|
||||
|
||||
@ -80,7 +80,7 @@ When the owner of a contract runs out funds on his wallet to pay for his deploym
|
||||
|
||||
## DAO
|
||||
|
||||
See [DAO](../../dashboard/tfchain/tf_dao.md) for more information on the DAO on TF Chain.
|
||||
See [DAO](dashboard@@tf_dao) for more information on the DAO on TF Chain.
|
||||
|
||||
## Farming Policies
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@ It is the backbone of [ZOS](https://github.com/threefoldtech/zos) and other comp
|
||||
A twin is a unique identifier linked to a specific account on a given TFChain network.
|
||||
Actually there are 2 ways to create a twin:
|
||||
|
||||
- With the [Dashboard](../../dashboard/wallet_connector.md)
|
||||
- With the [Dashboard](dashboard@@wallet_connector)
|
||||
- a twin is automatically generated while creating a TFChain account
|
||||
- With the TFConnect app
|
||||
- a twin is automatically generated while creating a farm (in this case the twin will be created on mainnet)
|
||||
|
||||
@ -2,10 +2,19 @@
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Step 1: Create the contract and get its unique ID](#step-1-create-contract--get-unique-id)
|
||||
- [Step 1: Create contract / Get unique ID](#step-1-create-contract--get-unique-id)
|
||||
- [Create service contract](#create-service-contract)
|
||||
- [Last service contract ID](#last-service-contract-id)
|
||||
- [Parse service contract](#parse-service-contract)
|
||||
- [Wrong contract ID ?](#wrong-contract-id-)
|
||||
- [Step 2: Fill contract](#step-2-fill-contract)
|
||||
- [Step 3: Both parties approve contract](#step-3-both-parties-approve-contract)
|
||||
- [Step 4: Bill for the service](#step-4-bill-for-the-service)
|
||||
- [Send bill to consumer](#send-bill-to-consumer)
|
||||
- [Billing frequency](#billing-frequency)
|
||||
- [Amount due calculation](#amount-due-calculation)
|
||||
- [Protection against draining](#protection-against-draining)
|
||||
- [Billing considerations](#billing-considerations)
|
||||
- [Step 5: Cancel the contract](#step-5-cancel-the-contract)
|
||||
|
||||
***
|
||||
@ -19,12 +28,12 @@ The initial scenario is when two parties, a service provider and a consumer of t
|
||||
This is actually a more direct and generic feature if we compare to the initial rewarding model where a service provider (or solution provider) is receiving TFT from a rewards distribution process, linked to a node contract and based on a cloud capacity consumption, which follows specific billing rules.
|
||||
|
||||
The initial requirements are:
|
||||
- Both service and consumer need to have their respective twin created on TFChain (if not, see [here](tfchain.md#create-a-tfchain-twin) how to do it)
|
||||
- Both service and consumer need to have their respective twin created on TFChain (if not, see [here](dev_tfchain.md#create-a-tfchain-twin) how to do it)
|
||||
- Consumer account needs to be funded (lack of funds will simply result in the contract cancelation while billed)
|
||||
|
||||
In the following steps we detail the sequence of extrinsics that need to be called in TFChain Polkadot portal for setting up and executing such contract.
|
||||
<!-- We also show how to check if everything is going the right way via the TFChain GraphQL interface. -->
|
||||
Make sure to use right [links](tfchain.md#deployed-instances) depending on the targeted network.
|
||||
Make sure to use right [links](dev_tfchain.md#deployed-instances) depending on the targeted network.
|
||||
|
||||
|
||||
# Step 1: Create contract / Get unique ID
|
||||
@ -55,7 +64,7 @@ Check if the contract fields are correct, especially the twin ID of both service
|
||||
|
||||
## Wrong contract ID ?
|
||||
|
||||
If twin IDs are wrong ([how to get my twin ID?](tfchain.md#get-your-twin-id)) on service contract fields it means the contract does not correspond to the last created contract.
|
||||
If twin IDs are wrong ([how to get my twin ID?](dev_tfchain.md#get-your-twin-id)) on service contract fields it means the contract does not correspond to the last created contract.
|
||||
In this case parse the last contracts on stack by decreasing `serviceContractId` and try to identify the right one; or the contract was simply not created so you should repeat the creation process and evaluate the error log.
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
TFROBOT (`tfrobot`) is a command line interface tool that offers simultaneous mass deployment of groups of VMs on the ThreeFold Grid, with support of multiple retries for failed deployments, and customizable configurations, where you can define node groups, VMs groups and other configurations through a YAML or a JSON file.
|
||||
|
||||
Consult the [ThreeFoldTech TFROBOT repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/tfrobot) for the latest updates and read the [basics](../../system_administrators/getstarted/tfgrid3_getstarted.md) to get up to speed if needed.
|
||||
Consult the [ThreeFoldTech TFROBOT repository](https://github.com/threefoldtech/tfgrid-sdk-go/tree/development/tfrobot) for the latest updates and read the [basics](system_administrators@@tfgrid3_getstarted) to get up to speed if needed.
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
|
||||
@ -56,4 +56,4 @@ The TFCMD tool works well with TFROBOT, as it can be used to query the TFGrid, f
|
||||
tfcmd get contracts
|
||||
```
|
||||
|
||||
For more information on TFCMD, [read the documentation](../tfcmd/tfcmd.md).
|
||||
For more information on TFCMD, [read the documentation](tfcmd.md).
|
||||
@ -44,7 +44,7 @@ Click on **Create Farm**, choose a farm name and then click **Create**.
|
||||
|
||||
## Create a ThreeFold Connect Wallet
|
||||
|
||||
Your farming rewards should be sent to a Stellar wallet with a TFT trustline enabled. The simplest way to proceed is to create a TF Connect app wallet as the TFT trustline is enabled by default on this wallet. For more information on TF Connect, read [this section](../../threefold_token/storing_tft/tf_connect_app.md).
|
||||
Your farming rewards should be sent to a Stellar wallet with a TFT trustline enabled. The simplest way to proceed is to create a TF Connect app wallet as the TFT trustline is enabled by default on this wallet. For more information on TF Connect, read [this section](threefold_token@@tf_connect_app).
|
||||
|
||||
Let's create a TFConnect Wallet and take note of the wallet address. First, download the app.
|
||||
|
||||
|
||||
@ -39,7 +39,7 @@ Note that you can run Zero-OS on a Virtual Machine (VM), but you won't farm any
|
||||
|
||||
Also, note that ThreeFold runs its own OS, which is Zero-OS. You thus need to start with completely wiped disks. You cannot farm TFT with Windows, Linux or MAC OS installed on your disks. If you need to use such OS temporarily, boot it in Try mode with a removable media (USB key).
|
||||
|
||||
Note: Once you have the necessary hardware, you need to [create a farm](./1_create_farm.md), [create a Zero-OS bootstrap image](./2_bootstrap_image.md), [wipe your disks](./4_wipe_all_disks.md) and [set the BIOS/UEFI](./5_set_bios_uefi.md) . Then you can [boot your 3Node](./6_boot_3node.md). If you are planning in building a farm in data center, [read this section](../advanced_networking/advanced_networking_toc.md).
|
||||
Note: Once you have the necessary hardware, you need to [create a farm](./1_create_farm.md), [create a Zero-OS bootstrap image](./2_bootstrap_image.md), [wipe your disks](./4_wipe_all_disks.md) and [set the BIOS/UEFI](./5_set_bios_uefi.md) . Then you can [boot your 3Node](./6_boot_3node.md). If you are planning in building a farm in data center, [read this section](advanced_networking_toc.md).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
This section of the ThreeFold Farmers book presents the necessary and basic steps to build a DIY 3Node.
|
||||
|
||||
For advanced farming information, such as GPU farming and room parameters, refer to the section [Farming Optimization](../farming_optimization/farming_optimization.md).
|
||||
For advanced farming information, such as GPU farming and room parameters, refer to the section [Farming Optimization](farming_optimization.md).
|
||||
|
||||
<h2> Table of Contents </h2>
|
||||
|
||||
|
||||
@ -101,6 +101,6 @@ If you're having issues wiping the disks, you might need to use **--force** or *
|
||||
|
||||
If you're having trouble getting your disks recognized by Zero-OS, some farmers have had success enabling AHCI mode for SATA in their BIOS.
|
||||
|
||||
If you are using a server with onboard storage, you might need to [re-flash the RAID card](../../faq/faq.md#is-there-a-way-to-bypass-raid-in-order-for-zero-os-to-have-bare-metals-on-the-system-no-raid-controller-in-between-storage-and-the-grid).
|
||||
If you are using a server with onboard storage, you might need to [re-flash the RAID card](faq@@faq.md#is-there-a-way-to-bypass-raid-in-order-for-zero-os-to-have-bare-metals-on-the-system-no-raid-controller-in-between-storage-and-the-grid).
|
||||
|
||||
|
||||
|
||||
9
collections/legal/terms_conditions_toc.md
Normal file
9
collections/legal/terms_conditions_toc.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Terms & Conditions
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Terms & Conditions ThreeFold Related Websites](./terms_conditions_websites.md)
|
||||
- [Terms & Conditions TFGrid Users TFGrid 3](./terms_conditions_griduser.md)
|
||||
- [TFTA to TFT](./tfta_to_tft.md)
|
||||
- [Terms & Conditions TFGrid Farmers TFGrid 3](./terms_conditions_farmer3.md)
|
||||
- [Terms & Conditions Sales](./terms_conditions_sales.md)
|
||||
9
collections/legal/tfta_to_tft.md
Normal file
9
collections/legal/tfta_to_tft.md
Normal file
@ -0,0 +1,9 @@
|
||||
## Convert TFTA to TFT
|
||||
|
||||
TFTA is a voluntary staking pool for people to show that they have no intent to sell in near time.
|
||||
|
||||
If you would like migrate TFTA to TFT, it's super easy, just send your TFTA to the following address:
|
||||
|
||||
> GBUT4GP5GJ6B3XW5PXENHQA7TXJI5GOPW3NF4W3ZIW6OOO4ISY6WNLN2
|
||||
|
||||
and it will return as TFT. We suggest that you try with 1 TFT first!
|
||||
@ -2,13 +2,13 @@
|
||||
|
||||
The section contains all the practical information for farmers, developers and system administrators of the ThreeFold Grid.
|
||||
|
||||
For complementary information on ThreeFold, refer to the [ThreeFold Knowledge Base](./knowledge_base.md).
|
||||
For complementary information on ThreeFold, refer to the [ThreeFold Knowledge Base](manual@@knowledge_base).
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Dashboard](dashboard/dashboard.md)
|
||||
- [Developers](developers/developers.md)
|
||||
- [Farmers](farmers/farmers.md)
|
||||
- [System Administrators](system_administrators/system_administrators.md)
|
||||
- [ThreeFold Token](threefold_token/threefold_token.md)
|
||||
- [FAQ](faq/faq.md)
|
||||
- [Dashboard](dashboard@@dashboard)
|
||||
- [Developers](developers@@developers)
|
||||
- [Farmers](farmers@@farmers)
|
||||
- [System Administrators](system_administrators@@system_administrators)
|
||||
- [ThreeFold Token](threefold_token@@threefold_token)
|
||||
- [FAQ](faq@@faq)
|
||||
@ -4,12 +4,12 @@
|
||||
|
||||
This manual is organized in two main sections:
|
||||
|
||||
- [ThreeFold Knowledge Base](manual/knowledge_base.md)
|
||||
- [ThreeFold Documentation](manual/documentation.md)
|
||||
- [ThreeFold Knowledge Base](manual@@knowledge_base)
|
||||
- [ThreeFold Documentation](manual@@documentation)
|
||||
|
||||
The *ThreeFold Knowledge Base* section contains all information needed to understand how the whole ThreeFold ecosystem works.
|
||||
|
||||
The *ThreeFold Documentation* section contains all the practical information of the ThreeFold Grid, from general information covering the multi-functional [Dashboard](dashboard:dashboard.md), [TFT](threefold_token:threefold_token.md) and our community-based [FAQ](faq:faq.md), to specific tutorials for [developers](developers:developers.md), [farmers](farmers:farmers.md) and [system administrators](system_administrators:system_administrators.md).
|
||||
The *ThreeFold Documentation* section contains all the practical information of the ThreeFold Grid, from general information covering the multi-functional [Dashboard](dashboard@@dashboard), [TFT](threefold_token@@threefold_token) and our community-based [FAQ](faq@@faq), to specific tutorials for [developers](developers@@developers), [farmers](farmers@@farmers) and [system administrators](system_administrators@@system_administrators).
|
||||
|
||||
> Explore the TFGrid status page for live updates on Threefold services!
|
||||
>
|
||||
@ -20,8 +20,8 @@ The *ThreeFold Documentation* section contains all the practical information of
|
||||
The ThreeFold community is very active and its members will be more than happy to discuss and help you get started.
|
||||
|
||||
* [ThreeFold Forum](https://forum.threefold.io/)
|
||||
* [ThreeFold (General Telegram Channel)](https://t.me/threefold)
|
||||
* [ThreeFold (Farmer Telegram Channel)](https://t.me/threefoldfarmers)
|
||||
* [ThreeFold General Telegram Channel](https://t.me/threefold)
|
||||
* [ThreeFold Farmer Telegram Channel](https://t.me/threefoldfarmers)
|
||||
* [TFGrid Tester Telegram Channel](https://t.me/threefoldtesting)
|
||||
|
||||
## Questions and Feedback
|
||||
|
||||
@ -2,13 +2,13 @@
|
||||
|
||||
The section contains information about the ThreeFold ecosystem, its technology and its history.
|
||||
|
||||
For practical information for farmers, developers and system administrators, refer to the [ThreeFold Documentation](documentation.md).
|
||||
For practical information for farmers, developers and system administrators, refer to the [ThreeFold Documentation](manual@@documentation).
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [About](about:about.md)
|
||||
- [Technology](technology:technology_toc.md)
|
||||
- [Farming](farming:farming_toc.md)
|
||||
- [Cloud](cloud:cloud_toc.md)
|
||||
- [Collaboration](collaboration:collaboration_toc.md)
|
||||
- [Legal](legal:terms_conditions_all3.md)
|
||||
- [About](about@@about)
|
||||
- [Technology](tech@@technology_toc)
|
||||
- [Farming](farming@@farming_toc)
|
||||
- [Cloud](cloud@@cloud_toc)
|
||||
- [Collaboration](collaboration@@collaboration_toc)
|
||||
- [Legal](legal@@legal_home)
|
||||
46
collections/tech/technology_toc.md
Normal file
46
collections/tech/technology_toc.md
Normal file
@ -0,0 +1,46 @@
|
||||
<h1>Technology</h1>
|
||||
|
||||
This section covers the technology behind the ThreeFold Grid. ThreeFold has created an amazing technology system to allow anyone to host their applications and data close to them.
|
||||
|
||||
To build on the ThreeFold Grid, refer to the [Developers](developers@@developers) section.
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
- [Introduction](tech/technology.md)
|
||||
- [The Internet Today](tech/internet_today.md)
|
||||
- [History of Computers](tech/history/c64.md)
|
||||
- [Too Many Layers](tech/history/layers.md)
|
||||
- [The Internet Re-invented](tech/how_does_it_work.md)
|
||||
- [World Records](tech/world_records.md)
|
||||
- [Key Innovations](tech/key_innovations_overview.md)
|
||||
- [Mycelium Network](tech/mycelium_innovation.md)
|
||||
- [Zero-OS](tech/zos_innovation.md)
|
||||
- [Quantum Safe Storage](tech/zstor_innovation.md)
|
||||
- [Quantum Safe Filesystem](tech/qsfs_innovation.md)
|
||||
- [FList: Better OS Images](tech/flist_innovation.md)
|
||||
- [FungiStor](tech/fungistor_innovation.md)
|
||||
- [Network Wall](tech/network_wall_innovation.md)
|
||||
- [Architecture](tech/architecture.md)
|
||||
- [Energy Efficient](tech/energy_efficient.md)
|
||||
- [Decentralized Cloud Core Capabilities](tech/features.md)
|
||||
- [Storage](tech/qsss_home.md)
|
||||
- [Quantum Safe Storage Algo](tech/qss_algorithm.md)
|
||||
- [Zero Knowledge proof](tech/qss_zero_knowledge_proof.md)
|
||||
- [NFT Storage](tech/nft_storage.md)
|
||||
- [S3 Storage](tech/s3_interface)
|
||||
- [File System](tech/qss_filesystem.md)
|
||||
- [Network](tech/networking.md)
|
||||
- [Mycelium](tech/mycelium.md)
|
||||
- [Web Gateway](tech/webgw.md)
|
||||
- [Partners Utilization](partners_utilization@@partners)
|
||||
- [Sikana](partners_utilization@@sikana)
|
||||
- [Vindo](partners_utilization@@vindo)
|
||||
- [Mkondo](partners_utilization@@mkondo)
|
||||
- [Vverse](partners_utilization@@vverse)
|
||||
- [Earth Wallet](partners_utilization@@earth_wallet)
|
||||
- [Elestio](partners_utilization@@elestio)
|
||||
- [OW Freezone](partners_utilization@@freezone)
|
||||
- [Helium](partners_utilization@@helium)
|
||||
- [Holochain](partners_utilization@@holochain)
|
||||
- [TZG](partners_utilization@@tanzania)
|
||||
- [Tier-S DC](partners_utilization@@tier_s_datacenter)
|
||||
@ -22,15 +22,23 @@
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/about'
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/technology'
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/tech'
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/manual_legal'
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/legal'
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/farming'
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/cloud'
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/collaboration'
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/partners_utilization'
|
||||
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/vindo'
|
||||
|
||||
!!doctree.add
|
||||
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/mkondo'
|
||||
|
||||
```
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user