From 8fafe79adf1f575b966b36540273bd32bb0f34ae Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Wed, 26 Feb 2025 15:39:10 +0100 Subject: [PATCH 01/10] moved the docs to the section. Edited the sequence.ts file --- src/content/Docs/_sequence.ts | 14 +++++++------- .../provider-console/provider-console/index.md | 0 .../provider-console/root-sign-in/index.md | 0 3 files changed, 7 insertions(+), 7 deletions(-) rename src/content/Docs/{ => providers}/provider-console/provider-console/index.md (100%) rename src/content/Docs/{ => providers}/provider-console/root-sign-in/index.md (100%) diff --git a/src/content/Docs/_sequence.ts b/src/content/Docs/_sequence.ts index 4502d5fd..1e18ba3f 100644 --- a/src/content/Docs/_sequence.ts +++ b/src/content/Docs/_sequence.ts @@ -63,13 +63,6 @@ export const docsSequence = [ }, ], }, - { - label: "Provider Console", - subItems: [ - { label: "How to Enable Root Sign-in"}, - { label: "Provider Console"}, - ], - }, { label: "Sandbox", subItems: [{ label: "Sandbox Introduction" }] }, { label: "Stable Payment Deployments" }, ], @@ -284,6 +277,13 @@ export const docsSequence = [ }, ], }, + { + label: "Provider Console", + subItems: [ + { label: "How to Enable Root Sign-in"}, + { label: "Provider Console"}, + ], + }, { label: "Akash Provider FAQ and Guide" }, { label: "Community Solutions" }, { label: "Custom Kubernetes Cluster Settings" }, diff --git a/src/content/Docs/provider-console/provider-console/index.md b/src/content/Docs/providers/provider-console/provider-console/index.md similarity index 100% rename from src/content/Docs/provider-console/provider-console/index.md rename to src/content/Docs/providers/provider-console/provider-console/index.md diff --git a/src/content/Docs/provider-console/root-sign-in/index.md b/src/content/Docs/providers/provider-console/root-sign-in/index.md similarity index 100% rename from src/content/Docs/provider-console/root-sign-in/index.md rename to src/content/Docs/providers/provider-console/root-sign-in/index.md From 8341091e8523a8556dc89cf562784281f229d13e Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Wed, 26 Feb 2025 18:20:01 +0100 Subject: [PATCH 02/10] provider docs housecleaning --- src/content/Docs/_sequence.ts | 94 +++++++++++-------- .../Docs/guides/science/octvae/index.md | 0 .../index.md | 0 .../akash-provider-attribute-updates/index.md | 0 .../index.md | 0 .../akash-provider-checkup/index.md | 0 .../gpu-resource-enablement/index.md | 0 .../index.md | 0 .../index.md | 0 .../ip-leases-provider-enablement/index.md | 0 .../additional-k8s-resources/index.md | 0 .../index.md | 0 .../shared-memory-enablement/index.md | 0 .../time-synchronization/index.md | 0 .../tls-certs-for-akash-provider/index.md | 0 .../provider-console/index.md | 0 .../provider-console/root-sgin-in}/index.md | 0 .../provider-console/what-is/index.md | 23 +++++ 18 files changed, 76 insertions(+), 41 deletions(-) create mode 100644 src/content/Docs/guides/science/octvae/index.md rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/akash-cloud-provider-build-with-helm-charts/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/akash-provider-attribute-updates/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/akash-provider-bid-pricing-calculation/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/akash-provider-checkup/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/gpu-resource-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/gvisor-issue-no-system-cgroup-v2-support/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/helm-based-provider-persistent-storage-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/ip-leases-provider-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/shared-memory-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/time-synchronization/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{ => akash-cli}/tls-certs-for-akash-provider/index.md (100%) rename src/content/Docs/providers/{ => build-a-cloud-provider/provider-console}/provider-console/provider-console/index.md (100%) rename src/content/Docs/providers/{provider-console/root-sign-in => build-a-cloud-provider/provider-console/provider-console/root-sgin-in}/index.md (100%) create mode 100644 src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md diff --git a/src/content/Docs/_sequence.ts b/src/content/Docs/_sequence.ts index 1e18ba3f..6ca0ed82 100644 --- a/src/content/Docs/_sequence.ts +++ b/src/content/Docs/_sequence.ts @@ -238,51 +238,63 @@ export const docsSequence = [ { label: "Build A Cloud Provider", subItems: [ - { - label: "Kubernetes Cluster For Akash Providers", - subItems: [{ label: "Kubernetes Cluster for Akash Providers" }], - }, - { - label: "Akash Cloud Provider Build With Helm Charts", - }, - { - label: "Akash Provider Checkup", - }, - { - label: "Time Synchronization", - }, - { - label: "GPU Resource Enablement (Optional Step)", - }, - { - label: "TLS Certs for Akash Provider (Optional Step)", - }, - { - label: "IP Leases - Provider Enablement (Optional Step)", - }, - { - label: "Helm Based Provider Persistent Storage Enablement", - }, - { - label: "Akash Provider Bid Pricing Calculation", - }, - { - label: "Akash Provider Attribute Updates", - }, - { - label: "gVisor Issue - No system-cgroup v2 Support", - }, - { - label: "Shared Memory Enablement", + { label: "Using the Akash CLI", + subItems: [ + { + label: "Kubernetes Cluster For Akash Providers", + subItems: [{ label: "Kubernetes Cluster for Akash Providers" }], + }, + { + label: "Akash Cloud Provider Build With Helm Charts", + }, + { + label: "Akash Provider Checkup", + }, + { + label: "Time Synchronization", + }, + { + label: "GPU Resource Enablement (Optional Step)", + }, + { + label: "TLS Certs for Akash Provider (Optional Step)", + }, + { + label: "IP Leases - Provider Enablement (Optional Step)", + }, + { + label: "Helm Based Provider Persistent Storage Enablement", + }, + { + label: "Akash Provider Bid Pricing Calculation", + }, + { + label: "Akash Provider Attribute Updates", + }, + { + label: "gVisor Issue - No system-cgroup v2 Support", + }, + { + label: "Shared Memory Enablement", + }, + + ], }, + { label: "Provider Console", + subItems: [ + { label: "What is Provider Console"}, + { label: "Provider Console", + subItems: [ + { label: "How to Enable Root Sign-in"}, + { label: "Provider Console"}, + ] + } , + ], + }, ], }, { - label: "Provider Console", - subItems: [ - { label: "How to Enable Root Sign-in"}, - { label: "Provider Console"}, - ], + }, { label: "Akash Provider FAQ and Guide" }, { label: "Community Solutions" }, diff --git a/src/content/Docs/guides/science/octvae/index.md b/src/content/Docs/guides/science/octvae/index.md new file mode 100644 index 00000000..e69de29b diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cloud-provider-build-with-helm-charts/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-cloud-provider-build-with-helm-charts/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cloud-provider-build-with-helm-charts/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-cloud-provider-build-with-helm-charts/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-provider-attribute-updates/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-attribute-updates/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-provider-attribute-updates/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-attribute-updates/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-provider-bid-pricing-calculation/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-bid-pricing-calculation/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-provider-bid-pricing-calculation/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-bid-pricing-calculation/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-provider-checkup/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-checkup/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-provider-checkup/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-checkup/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/gpu-resource-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/gpu-resource-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/gpu-resource-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/gpu-resource-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/gvisor-issue-no-system-cgroup-v2-support/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/gvisor-issue-no-system-cgroup-v2-support/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/helm-based-provider-persistent-storage-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/helm-based-provider-persistent-storage-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/helm-based-provider-persistent-storage-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/helm-based-provider-persistent-storage-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/ip-leases-provider-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/ip-leases-provider-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/ip-leases-provider-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/ip-leases-provider-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/shared-memory-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/shared-memory-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/shared-memory-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/shared-memory-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/time-synchronization/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/time-synchronization/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/time-synchronization/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/time-synchronization/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/tls-certs-for-akash-provider/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/tls-certs-for-akash-provider/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/tls-certs-for-akash-provider/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/tls-certs-for-akash-provider/index.md diff --git a/src/content/Docs/providers/provider-console/provider-console/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md similarity index 100% rename from src/content/Docs/providers/provider-console/provider-console/index.md rename to src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md diff --git a/src/content/Docs/providers/provider-console/root-sign-in/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sgin-in/index.md similarity index 100% rename from src/content/Docs/providers/provider-console/root-sign-in/index.md rename to src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sgin-in/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md new file mode 100644 index 00000000..813f2bd7 --- /dev/null +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md @@ -0,0 +1,23 @@ +--- +categories: ["Providers"] +tags: ["Praetor Console"] +weight: 5 +title: "What is Provider Console?" +linkTitle: "What is Provider Console?" +--- + +# Provider Console + +The **Provider Console** simplifies the process of becoming a cloud provider on the Akash Network. Instead of using a Command-line Interface, you can manage everything through our intuitive graphical interface. Once set up as a provider, deployers who select your services will compensate you in **AKT**. + +## Features + +### Multi-Server Support +With **Provider Console**, you can offer a single server or multiple servers, supporting a variety of operating systems, including **Ubuntu, Debian, and CentOS**. + +### Kubernetes Integration +Do you have underutilized Kubernetes resources? You can seamlessly integrate them with the Akash Network using **Provider Console**. The tool assists in configuring your existing Kubernetes setup for Akash Network compatibility and initiates the **Provider Service**, enabling you to accept bids and manifests. + +--- + +For more information on how to get started, visit the official **Provider Console** documentation. From 30e8ea1565db071ca91ee2b82030403e93d8d7fd Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Wed, 26 Feb 2025 18:22:31 +0100 Subject: [PATCH 03/10] removed redundant dir --- src/content/Docs/guides/science/octvae/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 src/content/Docs/guides/science/octvae/index.md diff --git a/src/content/Docs/guides/science/octvae/index.md b/src/content/Docs/guides/science/octvae/index.md deleted file mode 100644 index e69de29b..00000000 From d1bc5ffaec0b21be5e04667f05412da673b90190 Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Thu, 27 Feb 2025 00:06:41 +0100 Subject: [PATCH 04/10] provider console directory formating --- .../provider-console/index.md | 32 +++++++++---------- .../{root-sgin-in => root-sign-in}/index.md | 2 +- .../provider-console/what-is/index.md | 6 ++-- 3 files changed, 20 insertions(+), 20 deletions(-) rename src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/{root-sgin-in => root-sign-in}/index.md (99%) diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md index abf9a009..1c725148 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md @@ -22,29 +22,29 @@ This guide will walk you through the process of setting up an **Akash Provider** - Go to the [Akash Provider Console](https://provider-console.akash.network/) in your browser. -![](../../assets/provider_lp.png) +![](../../../../../assets/provider_lp.png) - Click on `connect wallet`. -![](../../assets/connect_wallet.png) +![](../../../../../assets/connect_wallet.png) - Select `Keplr`, sign into your wallet, and approve the network collection request. -![](../../assets/select_keplr.png) +![](../../../../../assets/select_keplr.png) -![](../../assets/wallet_login.png) +![](../../../../../assets/wallet_login.png) -![](../../assets/approved.png) +![](../../../../../assets/approved.png) - Once you sign in successfully, you be on the `Create Provider` page. -![](../../assets/provider_landing.png) +![](../../../../../assets/provider_landing.png) --- @@ -55,7 +55,7 @@ This guide will walk you through the process of setting up an **Akash Provider** 1. Click on the `Create Provider` button. - ![](../../assets/server_access.png) + ![](../../../../../assets/server_access.png) @@ -65,11 +65,11 @@ This guide will walk you through the process of setting up an **Akash Provider** 2. In `Server Access`, enter the number of servers you want to provide. If you intend to have both `control plane` and `worker` nodes, you should provide at least 2 servers. - ![](../../assets/server_access.png) + ![](../../../../../assets/server_access.png) - ![](../../assets/server_count.png) + ![](../../../../../assets/server_count.png) 3. Fill in the requested information for your `Control Plane Node`. Make sure you choose how you would like to provide your credentials: select either one `ssh` or `password`. Repeat the process for all of your nodes. @@ -101,20 +101,20 @@ This guide will walk you through the process of setting up an **Akash Provider** `172.31.13.12` - ![](../../assets/control_plane.png) + ![](../../../../../assets/control_plane.png) 4. If you selected created 2 or more servers, you would have at least one worker node. For every node Pairing, the `Control Nodes` use the public IP addresses, while the `Worker Nodes` use the private IP addresses. - ![](../../assets/worker_nodes.png) + ![](../../../../../assets/worker_nodes.png) 5. Fill in your provider configurations for you `Control Nodes`. - ![](../../assets/provider_info.png) + ![](../../../../../assets/provider_info.png) @@ -123,14 +123,14 @@ This guide will walk you through the process of setting up an **Akash Provider** 6. Review the attributes you provided: - ![](../../assets/review_pov.png) + ![](../../../../../assets/review_pov.png) 7. Adjust the pricing of the various services you would be providing. The prices you set here determine the price your provider bids with and total revenue it earns for you. - ![](../../assets/pricing.png) + ![](../../../../../assets/pricing.png) 8. Import your wallet. This would be the wallet you ould be paid by leasées for using your machine. You'll have the option of either importing it automatically or manually doing so. @@ -144,13 +144,13 @@ This guide will walk you through the process of setting up an **Akash Provider** - ![](../../assets/beginning.png) + ![](../../../../../assets/beginning.png) If your settings and configurations are done correctly, you should be done in a couple of minutes. - ![](../../assets/complete.png) + ![](../../../../../assets/complete.png) 10. Make DNS Changes: For your domain to work, you would need to point your machines' public IPs to the `provider.example.com` domain name and the `*.ingress.example.com` domain name. This would need to be configured from your domain registrar's control panel. As the methods vary widely per domain registrar, please check the specific registrar docs for instructions. diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sgin-in/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sign-in/index.md similarity index 99% rename from src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sgin-in/index.md rename to src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sign-in/index.md index 7e049599..09b2a448 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sgin-in/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sign-in/index.md @@ -1,7 +1,7 @@ --- categories: ["Provider Console"] tags: [] -weight: 2 +weight: 5 title: "How to Enable Root Sign-in to Provider Console" linkTitle: "How to Enable Root Sign-in" --- diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md index 813f2bd7..d858acfc 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md @@ -1,7 +1,7 @@ --- -categories: ["Providers"] -tags: ["Praetor Console"] -weight: 5 +categories: ["Provider Console"] +tags: ["Provider Console"] +weight: 3 title: "What is Provider Console?" linkTitle: "What is Provider Console?" --- From 4eb9a40c02b4250eb624406391e50bc45a7a5e94 Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Thu, 27 Feb 2025 00:18:08 +0100 Subject: [PATCH 05/10] further directory tree edits --- src/content/Docs/_sequence.ts | 144 ++++++++---------- .../build-a-cloud-provider/intro/index.md | 22 +++ .../{provider-console => }/index.md | 32 ++-- .../root-sign-in/index.md | 0 .../index.md | 2 +- .../akash-provider-attribute-updates/index.md | 0 .../index.md | 0 .../akash-provider-checkup/index.md | 0 .../gpu-resource-enablement/index.md | 0 .../index.md | 0 .../index.md | 0 .../ip-leases-provider-enablement/index.md | 0 .../additional-k8s-resources/index.md | 0 .../index.md | 0 .../shared-memory-enablement/index.md | 0 .../time-synchronization/index.md | 0 .../tls-certs-for-akash-provider/index.md | 0 17 files changed, 101 insertions(+), 99 deletions(-) create mode 100644 src/content/Docs/providers/build-a-cloud-provider/intro/index.md rename src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/{provider-console => }/index.md (87%) rename src/content/Docs/providers/build-a-cloud-provider/provider-console/{provider-console => }/root-sign-in/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/akash-cloud-provider-build-with-helm-charts/index.md (99%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/akash-provider-attribute-updates/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/akash-provider-bid-pricing-calculation/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/akash-provider-checkup/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/gpu-resource-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/gvisor-issue-no-system-cgroup-v2-support/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/helm-based-provider-persistent-storage-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/ip-leases-provider-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/shared-memory-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/time-synchronization/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{akash-cli => using-the-akash-cli}/tls-certs-for-akash-provider/index.md (100%) diff --git a/src/content/Docs/_sequence.ts b/src/content/Docs/_sequence.ts index 6ca0ed82..37cd11cd 100644 --- a/src/content/Docs/_sequence.ts +++ b/src/content/Docs/_sequence.ts @@ -45,26 +45,74 @@ export const docsSequence = [ { label: "Akash Console", }, + { label: "Sandbox", subItems: [{ label: "Sandbox Introduction" }] }, + { label: "Stable Payment Deployments" }, + ], + }, + { + label: "Providers", + subItems: [ { - label: "Praetor App", + label: "Build A Cloud Provider", subItems: [ - { label: "What is Praetor App?" }, - { - label: "Akash Provider", + { label: "Provider Overview"}, + { label: "Using the Akash CLI", subItems: [ - { label: "Build a Cloud Provider" }, - { label: "Existing Kubernetes Cluster" }, - { label: "Single Server Provider" }, - { label: "Build a Cloud Provider (Windows Machine)" }, - { label: "Sudo User Requirements" }, - { label: "Decommission a Provider" }, - + { + label: "Kubernetes Cluster For Akash Providers", + subItems: [{ label: "Kubernetes Cluster for Akash Providers" }], + }, + { + label: "Akash Cloud Provider Build With Helm Charts", + }, + { + label: "Akash Provider Checkup", + }, + { + label: "Time Synchronization", + }, + { + label: "GPU Resource Enablement (Optional Step)", + }, + { + label: "TLS Certs for Akash Provider (Optional Step)", + }, + { + label: "IP Leases - Provider Enablement (Optional Step)", + }, + { + label: "Helm Based Provider Persistent Storage Enablement", + }, + { + label: "Akash Provider Bid Pricing Calculation", + }, + { + label: "Akash Provider Attribute Updates", + }, + { + label: "gVisor Issue - No system-cgroup v2 Support", + }, + { + label: "Shared Memory Enablement", + }, + + ], + }, + { label: "Provider Console", + subItems: [ + { label: "What is Provider Console"}, + { label: "Provider Console"}, + { label: "How to Enable Root Sign-in"}, ], }, ], }, - { label: "Sandbox", subItems: [{ label: "Sandbox Introduction" }] }, - { label: "Stable Payment Deployments" }, + { + + }, + { label: "Akash Provider FAQ and Guide" }, + { label: "Community Solutions" }, + { label: "Custom Kubernetes Cluster Settings" }, ], }, { @@ -232,75 +280,7 @@ export const docsSequence = [ } ], }, - { - label: "Providers", - subItems: [ - { - label: "Build A Cloud Provider", - subItems: [ - { label: "Using the Akash CLI", - subItems: [ - { - label: "Kubernetes Cluster For Akash Providers", - subItems: [{ label: "Kubernetes Cluster for Akash Providers" }], - }, - { - label: "Akash Cloud Provider Build With Helm Charts", - }, - { - label: "Akash Provider Checkup", - }, - { - label: "Time Synchronization", - }, - { - label: "GPU Resource Enablement (Optional Step)", - }, - { - label: "TLS Certs for Akash Provider (Optional Step)", - }, - { - label: "IP Leases - Provider Enablement (Optional Step)", - }, - { - label: "Helm Based Provider Persistent Storage Enablement", - }, - { - label: "Akash Provider Bid Pricing Calculation", - }, - { - label: "Akash Provider Attribute Updates", - }, - { - label: "gVisor Issue - No system-cgroup v2 Support", - }, - { - label: "Shared Memory Enablement", - }, - - ], - }, - { label: "Provider Console", - subItems: [ - { label: "What is Provider Console"}, - { label: "Provider Console", - subItems: [ - { label: "How to Enable Root Sign-in"}, - { label: "Provider Console"}, - ] - } , - ], - }, - ], - }, - { - - }, - { label: "Akash Provider FAQ and Guide" }, - { label: "Community Solutions" }, - { label: "Custom Kubernetes Cluster Settings" }, - ], - }, + { label: "Akash Nodes", diff --git a/src/content/Docs/providers/build-a-cloud-provider/intro/index.md b/src/content/Docs/providers/build-a-cloud-provider/intro/index.md new file mode 100644 index 00000000..c97e1419 --- /dev/null +++ b/src/content/Docs/providers/build-a-cloud-provider/intro/index.md @@ -0,0 +1,22 @@ +--- +categories: ["Akash Provider"] +tags: ["Akash Provider"] +weight: 1 +title: "Provider Overview" +linkTitle: "Provider Overview" +--- + +Akash Network offers a decentralized cloud marketplace where users can lease compute resources in a permissionless and open environment. As an Akash provider, you can contribute your compute resources to the network and earn revenue by hosting workloads for tenants. + +## Getting Started + +There are two primary ways to become an Akash provider: + +1. **Using the Akash CLI:** This method provides full control over your provider setup and operations, allowing for advanced configurations and automation. +2. **Using the Akash Web App:** This is a more user-friendly approach, enabling providers to onboard quickly without requiring extensive command-line knowledge. + +Both methods allow you to register your resources, set pricing, and accept deployment requests from tenants looking for cloud compute power. + +Becoming an Akash provider helps decentralize cloud computing while allowing you to monetize unused compute capacity. Whether you choose the CLI or the web app, the process is designed to be straightforward and accessible to a wide range of users. + + diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md similarity index 87% rename from src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md rename to src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md index 1c725148..03989ab0 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/provider-console/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md @@ -22,29 +22,29 @@ This guide will walk you through the process of setting up an **Akash Provider** - Go to the [Akash Provider Console](https://provider-console.akash.network/) in your browser. -![](../../../../../assets/provider_lp.png) +![](../../../../assets/provider_lp.png) - Click on `connect wallet`. -![](../../../../../assets/connect_wallet.png) +![](../../../../assets/connect_wallet.png) - Select `Keplr`, sign into your wallet, and approve the network collection request. -![](../../../../../assets/select_keplr.png) +![](../../../../assets/select_keplr.png) -![](../../../../../assets/wallet_login.png) +![](../../../../assets/wallet_login.png) -![](../../../../../assets/approved.png) +![](../../../../assets/approved.png) - Once you sign in successfully, you be on the `Create Provider` page. -![](../../../../../assets/provider_landing.png) +![](../../../../assets/provider_landing.png) --- @@ -55,7 +55,7 @@ This guide will walk you through the process of setting up an **Akash Provider** 1. Click on the `Create Provider` button. - ![](../../../../../assets/server_access.png) + ![](../../../../assets/server_access.png) @@ -65,11 +65,11 @@ This guide will walk you through the process of setting up an **Akash Provider** 2. In `Server Access`, enter the number of servers you want to provide. If you intend to have both `control plane` and `worker` nodes, you should provide at least 2 servers. - ![](../../../../../assets/server_access.png) + ![](../../../../assets/server_access.png) - ![](../../../../../assets/server_count.png) + ![](../../../../assets/server_count.png) 3. Fill in the requested information for your `Control Plane Node`. Make sure you choose how you would like to provide your credentials: select either one `ssh` or `password`. Repeat the process for all of your nodes. @@ -101,20 +101,20 @@ This guide will walk you through the process of setting up an **Akash Provider** `172.31.13.12` - ![](../../../../../assets/control_plane.png) + ![](../../../../assets/control_plane.png) 4. If you selected created 2 or more servers, you would have at least one worker node. For every node Pairing, the `Control Nodes` use the public IP addresses, while the `Worker Nodes` use the private IP addresses. - ![](../../../../../assets/worker_nodes.png) + ![](../../../../assets/worker_nodes.png) 5. Fill in your provider configurations for you `Control Nodes`. - ![](../../../../../assets/provider_info.png) + ![](../../../../assets/provider_info.png) @@ -123,14 +123,14 @@ This guide will walk you through the process of setting up an **Akash Provider** 6. Review the attributes you provided: - ![](../../../../../assets/review_pov.png) + ![](../../../../assets/review_pov.png) 7. Adjust the pricing of the various services you would be providing. The prices you set here determine the price your provider bids with and total revenue it earns for you. - ![](../../../../../assets/pricing.png) + ![](../../../../assets/pricing.png) 8. Import your wallet. This would be the wallet you ould be paid by leasées for using your machine. You'll have the option of either importing it automatically or manually doing so. @@ -144,13 +144,13 @@ This guide will walk you through the process of setting up an **Akash Provider** - ![](../../../../../assets/beginning.png) + ![](../../../../assets/beginning.png) If your settings and configurations are done correctly, you should be done in a couple of minutes. - ![](../../../../../assets/complete.png) + ![](../../../../assets/complete.png) 10. Make DNS Changes: For your domain to work, you would need to point your machines' public IPs to the `provider.example.com` domain name and the `*.ingress.example.com` domain name. This would need to be configured from your domain registrar's control panel. As the methods vary widely per domain registrar, please check the specific registrar docs for instructions. diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sign-in/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/root-sign-in/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/root-sign-in/index.md rename to src/content/Docs/providers/build-a-cloud-provider/provider-console/root-sign-in/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-cloud-provider-build-with-helm-charts/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-cloud-provider-build-with-helm-charts/index.md similarity index 99% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-cloud-provider-build-with-helm-charts/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-cloud-provider-build-with-helm-charts/index.md index 43086a43..17e51024 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-cloud-provider-build-with-helm-charts/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-cloud-provider-build-with-helm-charts/index.md @@ -322,7 +322,7 @@ provider.yourdomain.com #### Example DNS Configuration -![](../../../assets/namecheapCapture.png) +![](../../../../assets/namecheapCapture.png) ## Step 6 - Hostname Operator Build diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-attribute-updates/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-attribute-updates/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-attribute-updates/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-attribute-updates/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-bid-pricing-calculation/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-bid-pricing-calculation/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-bid-pricing-calculation/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-bid-pricing-calculation/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-checkup/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-checkup/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-checkup/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-checkup/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/gpu-resource-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/gpu-resource-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/gpu-resource-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/gpu-resource-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/helm-based-provider-persistent-storage-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/helm-based-provider-persistent-storage-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/helm-based-provider-persistent-storage-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/helm-based-provider-persistent-storage-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/ip-leases-provider-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/ip-leases-provider-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/ip-leases-provider-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/ip-leases-provider-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/shared-memory-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/shared-memory-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/shared-memory-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/shared-memory-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/time-synchronization/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/time-synchronization/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/time-synchronization/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/time-synchronization/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/akash-cli/tls-certs-for-akash-provider/index.md b/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/tls-certs-for-akash-provider/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/akash-cli/tls-certs-for-akash-provider/index.md rename to src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/tls-certs-for-akash-provider/index.md From 932314b1a02384639a58b539080b965c4ce92291 Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Thu, 27 Feb 2025 08:53:40 +0100 Subject: [PATCH 06/10] provider docs edits --- src/content/Docs/_sequence.ts | 8 ++-- src/content/Docs/guides/introduction/index.md | 38 +++++++++++++++++ .../index.md | 0 .../akash-provider-attribute-updates/index.md | 0 .../index.md | 0 .../akash-provider-checkup/index.md | 0 .../gpu-resource-enablement/index.md | 0 .../index.md | 0 .../index.md | 0 .../ip-leases-provider-enablement/index.md | 0 .../additional-k8s-resources/index.md | 0 .../index.md | 0 .../shared-memory-enablement/index.md | 0 .../time-synchronization/index.md | 0 .../tls-certs-for-akash-provider/index.md | 0 .../build-a-cloud-provider/intro/index.md | 41 ++++++++++++++++--- .../provider-console/index.md | 6 +-- .../provider-console/root-sign-in/index.md | 2 +- .../provider-console/what-is/index.md | 2 + 19 files changed, 84 insertions(+), 13 deletions(-) create mode 100644 src/content/Docs/guides/introduction/index.md rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/akash-cloud-provider-build-with-helm-charts/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/akash-provider-attribute-updates/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/akash-provider-bid-pricing-calculation/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/akash-provider-checkup/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/gpu-resource-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/gvisor-issue-no-system-cgroup-v2-support/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/helm-based-provider-persistent-storage-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/ip-leases-provider-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/shared-memory-enablement/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/time-synchronization/index.md (100%) rename src/content/Docs/providers/build-a-cloud-provider/{using-the-akash-cli => akash-cli}/tls-certs-for-akash-provider/index.md (100%) diff --git a/src/content/Docs/_sequence.ts b/src/content/Docs/_sequence.ts index 37cd11cd..20e54f26 100644 --- a/src/content/Docs/_sequence.ts +++ b/src/content/Docs/_sequence.ts @@ -56,7 +56,7 @@ export const docsSequence = [ label: "Build A Cloud Provider", subItems: [ { label: "Provider Overview"}, - { label: "Using the Akash CLI", + { label: "Akash CLI", subItems: [ { label: "Kubernetes Cluster For Akash Providers", @@ -100,8 +100,8 @@ export const docsSequence = [ }, { label: "Provider Console", subItems: [ - { label: "What is Provider Console"}, - { label: "Provider Console"}, + { label: "What is Provider Console?"}, + { label: "Building with Provider Console"}, { label: "How to Enable Root Sign-in"}, ], }, @@ -119,10 +119,10 @@ export const docsSequence = [ label: "Guides", subItems: [ + { label: "Guides Overview"}, { label: "Machine Learning", subItems: [ - { label: "OneClickLLM" }, { label: "DeTrain" }, { label: "Ray" }, { label: "FLock.io" }, diff --git a/src/content/Docs/guides/introduction/index.md b/src/content/Docs/guides/introduction/index.md new file mode 100644 index 00000000..46c2b6ba --- /dev/null +++ b/src/content/Docs/guides/introduction/index.md @@ -0,0 +1,38 @@ +--- +categories: ["Guides"] +tags: ["Guides"] +weight: 3 +title: "Guides" +linkTitle: "Guides Overview" +--- + +# Akash Deployment Guides + +## Introduction + +Welcome to the Akash Deployment Guides! This collection of guides is designed to help developers, businesses, and enthusiasts deploy a variety of applications and services on Akash, the decentralized cloud computing platform. + +Akash offers a powerful, cost-effective, and permissionless infrastructure for hosting and running workloads, ranging from traditional web applications to blockchain services, machine learning models, and beyond. With these guides, you'll find step-by-step instructions and best practices for deploying various technologies efficiently on Akash. + +## Table of Contents + +- **Machine Learning** +- **Deployments** +- **Networks** +- **Tooling** +- **Blockchain** +- **Apps** +- **Databases** +- **Hosting** +- **Data Analysis** +- **Web Frameworks** +- **Games** +- **Science** +- **Benchmarking** +- **Networking** +- **DevOps** +- **DeFi** +- **Search Engines** +- **Project Management** + +Each section contains detailed deployment steps, best practices, and troubleshooting tips to ensure seamless integration with Akash. Whether you're looking to deploy AI models, run a full-stack web application, or set up a decentralized finance (DeFi) service, these guides will provide you with the necessary knowledge to get started. \ No newline at end of file diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-cloud-provider-build-with-helm-charts/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-cloud-provider-build-with-helm-charts/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-cloud-provider-build-with-helm-charts/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-cloud-provider-build-with-helm-charts/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-attribute-updates/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-attribute-updates/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-attribute-updates/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-attribute-updates/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-bid-pricing-calculation/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-bid-pricing-calculation/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-bid-pricing-calculation/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-bid-pricing-calculation/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-checkup/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-checkup/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/akash-provider-checkup/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/akash-provider-checkup/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/gpu-resource-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/gpu-resource-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/gpu-resource-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/gpu-resource-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/gvisor-issue-no-system-cgroup-v2-support/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/helm-based-provider-persistent-storage-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/helm-based-provider-persistent-storage-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/helm-based-provider-persistent-storage-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/helm-based-provider-persistent-storage-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/ip-leases-provider-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/ip-leases-provider-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/ip-leases-provider-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/ip-leases-provider-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/additional-k8s-resources/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/shared-memory-enablement/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/shared-memory-enablement/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/shared-memory-enablement/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/shared-memory-enablement/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/time-synchronization/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/time-synchronization/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/time-synchronization/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/time-synchronization/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/tls-certs-for-akash-provider/index.md b/src/content/Docs/providers/build-a-cloud-provider/akash-cli/tls-certs-for-akash-provider/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/using-the-akash-cli/tls-certs-for-akash-provider/index.md rename to src/content/Docs/providers/build-a-cloud-provider/akash-cli/tls-certs-for-akash-provider/index.md diff --git a/src/content/Docs/providers/build-a-cloud-provider/intro/index.md b/src/content/Docs/providers/build-a-cloud-provider/intro/index.md index c97e1419..ddb0ea92 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/intro/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/intro/index.md @@ -6,17 +6,48 @@ title: "Provider Overview" linkTitle: "Provider Overview" --- -Akash Network offers a decentralized cloud marketplace where users can lease compute resources in a permissionless and open environment. As an Akash provider, you can contribute your compute resources to the network and earn revenue by hosting workloads for tenants. +Akash Network provides a decentralized cloud marketplace where users can lease compute resources in a permissionless and open environment. As an Akash provider, you can contribute your compute resources to the network and earn revenue by hosting workloads for tenants. ## Getting Started There are two primary ways to become an Akash provider: -1. **Using the Akash CLI:** This method provides full control over your provider setup and operations, allowing for advanced configurations and automation. -2. **Using the Akash Web App:** This is a more user-friendly approach, enabling providers to onboard quickly without requiring extensive command-line knowledge. +1. **Using the Akash CLI:** This method gives you full control over your provider setup and operations, allowing for advanced configurations and automation. +2. **Using the Akash Web App:** This more user-friendly approach enables providers to onboard quickly without needing extensive command-line knowledge. -Both methods allow you to register your resources, set pricing, and accept deployment requests from tenants looking for cloud compute power. +Both methods allow you to register your resources, set pricing, and accept deployment requests from tenants seeking cloud compute power. -Becoming an Akash provider helps decentralize cloud computing while allowing you to monetize unused compute capacity. Whether you choose the CLI or the web app, the process is designed to be straightforward and accessible to a wide range of users. +Becoming an Akash provider helps to decentralize cloud computing while allowing you to monetize unused compute capacity. Whether you choose the CLI or the web app, the process is designed to be straightforward and accessible to a wide range of users. +## Prerequisites for Building an Akash Provider +### Wallet Funding - Minimum of 5 AKT + +A deposit of 5 AKT is required to place a bid on an order. This deposit is fully refundable regardless of whether your bid is successful or not. + +For detailed steps on creating an Akash account, please refer to our [documentation](/docs/deployments/akash-cli/installation/). + +### Kubernetes Cluster Hardware Requirements and Recommendations + +**Kubernetes Master Node Requirements** + +- **Minimum Specifications:** + - 8 CPUs + - 16 GB RAM + - 50 GB Disk + +- **Recommended Specifications:** + - 16 CPUs + - 32 GB RAM + - 100 GB Disk + +**Kubernetes Worker Node Requirements** + +- **Minimum Specifications:** + - 4 CPUs + - 8 GB RAM + - 100 GB Disk + +- **Recommendations:** + - The more resources available, the better the performance, especially for handling more concurrent deployments. + - It is crucial to maximize CPU capacity. For instance, if you have 8 CPUs, 100 GB RAM, and 2 TB of storage, the CPU is likely to be the bottleneck. Since people tend to deploy at least 1 CPU per deployment, the server could only host a maximum of 8 deployments, and likely only around 6 deployments, as approximately 2 CPUs will be reserved for Kubernetes system components. \ No newline at end of file diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md index 03989ab0..a945a241 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md @@ -1,9 +1,9 @@ --- categories: ["Provider Console"] -tags: [] -weight: 2 +tags: ["Provider Console"] +weight: 1 title: "Creating an Akash Provider Using the Akash Console" -linkTitle: "Provider Console" +linkTitle: " Building with Provider Console" --- The Akash Provider Console is an easy way to become an Akash Provider. Being a provider allows individuals and organizations to rent out their unused computing resources. diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/root-sign-in/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/root-sign-in/index.md index 09b2a448..a3c22922 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/root-sign-in/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/root-sign-in/index.md @@ -1,7 +1,7 @@ --- categories: ["Provider Console"] tags: [] -weight: 5 +weight: 1 title: "How to Enable Root Sign-in to Provider Console" linkTitle: "How to Enable Root Sign-in" --- diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md index d858acfc..a2028b3b 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md @@ -20,4 +20,6 @@ Do you have underutilized Kubernetes resources? You can seamlessly integrate the --- + + For more information on how to get started, visit the official **Provider Console** documentation. From ced8550784c336dff6fa02bce594b2b9375d9dc6 Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:25:56 +0100 Subject: [PATCH 07/10] provider docs restructuring --- src/content/Docs/_sequence.ts | 2 +- .../build-cloud-provider/index.mdx | 49 ---- .../build-windows-provider/index.mdx | 110 -------- .../decomission-provider/index.mdx | 20 -- .../akash-provider/existing-cluster/index.mdx | 254 ------------------ .../single-server-provider/index.mdx | 180 ------------- .../akash-provider/sudo-user-reqs/index.mdx | 43 --- .../deployments/praetor-app/what-is/index.mdx | 17 -- .../providers/community-solutions/index.md | 11 - .../intro/index.md | 0 10 files changed, 1 insertion(+), 685 deletions(-) delete mode 100644 src/content/Docs/deployments/praetor-app/akash-provider/build-cloud-provider/index.mdx delete mode 100644 src/content/Docs/deployments/praetor-app/akash-provider/build-windows-provider/index.mdx delete mode 100644 src/content/Docs/deployments/praetor-app/akash-provider/decomission-provider/index.mdx delete mode 100644 src/content/Docs/deployments/praetor-app/akash-provider/existing-cluster/index.mdx delete mode 100644 src/content/Docs/deployments/praetor-app/akash-provider/single-server-provider/index.mdx delete mode 100644 src/content/Docs/deployments/praetor-app/akash-provider/sudo-user-reqs/index.mdx delete mode 100644 src/content/Docs/deployments/praetor-app/what-is/index.mdx rename src/content/Docs/providers/{build-a-cloud-provider => }/intro/index.md (100%) diff --git a/src/content/Docs/_sequence.ts b/src/content/Docs/_sequence.ts index 20e54f26..1ee33ffe 100644 --- a/src/content/Docs/_sequence.ts +++ b/src/content/Docs/_sequence.ts @@ -52,10 +52,10 @@ export const docsSequence = [ { label: "Providers", subItems: [ + { label: "Provider Overview"}, { label: "Build A Cloud Provider", subItems: [ - { label: "Provider Overview"}, { label: "Akash CLI", subItems: [ { diff --git a/src/content/Docs/deployments/praetor-app/akash-provider/build-cloud-provider/index.mdx b/src/content/Docs/deployments/praetor-app/akash-provider/build-cloud-provider/index.mdx deleted file mode 100644 index 67cd2b39..00000000 --- a/src/content/Docs/deployments/praetor-app/akash-provider/build-cloud-provider/index.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -categories: ["Praetor App"] -tags: ["Praetor App"] -weight: 6 -title: "Build a Cloud Provider" -linkTitle: "Build a Cloud Provider" ---- - -## Prerequisites of an Akash Provider - -### Wallet Funding - Minimum of 5 AKT - -To place a bid on an order, a deposit of 5 AKT is required. This deposit is fully refunded regardless of whether the bid is won or lost. - -For detailed steps on creating an Akash account, please refer to our [documentation](/docs/deployments/akash-cli/installation/). - -### Kubernetes Cluster Hardware Requirements and Recommendations - -Kubernetes Master Node Requirements - -* Minimum Specifications: - - * 8 CPUs - * 16 GB RAM - * 50 GB Disk - - -* Recommended Specifications: - - * 16 CPUs - * 32 GB RAM - * 100 GB Disk - - -Kubernetes Worker Node Requirements - -* Minimum Specifications: - - * 4 CPUs - * 8 GB RAM - * 100 GB Disk - -* Recommendations: - - * The more resources available, the better the performance, especially for handling a higher number of concurrent deployments. - * It is crucial to maximize CPU capacity. For instance, with 8 CPUs, 100 GB RAM, and 2 TB storage, the CPU would likely be the bottleneck. Since people tend to deploy at least 1 CPU per deployment, the server could only host 8 deployments maximum and likely about 6 deployments as other ~2 CPUs will be reserved by the Kubernetes system components. - -Ready to become an Akash Cloud Provider and start earning? Visit the [Praetor Application](https://akash.praetorapp.com/) now. - diff --git a/src/content/Docs/deployments/praetor-app/akash-provider/build-windows-provider/index.mdx b/src/content/Docs/deployments/praetor-app/akash-provider/build-windows-provider/index.mdx deleted file mode 100644 index 163e87f8..00000000 --- a/src/content/Docs/deployments/praetor-app/akash-provider/build-windows-provider/index.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -categories: ["Praetor App"] -tags: ["Praetor App"] -weight: 6 -title: "Build a Cloud Provider (Windows)" -linkTitle: "Build a Cloud Provider (Windows)" ---- - - -If you have a Windows machine and want to become a Provider, follow these steps: - -## Step 1: Download and Install Oracle VirtualBox - -1. Download VirtualBox by [here](https://www.virtualbox.org/wiki/Downloads). Select "Windows host" to download the Windows version. - -2. Install VirtualBox by double-clicking the downloaded file. - -## Step 2a: Create a New VM and Install an OS - -1. Open VirtualBox and click on Machine > New. - - - -2. Provide a name and path for the VM. Select the operating system type "Linux" and the version "Ubuntu" based on your computer's architecture. - -![](../../../../assets/virutalbox.png) - -3. Click Next and set the memory size (minimum required is 4096 MB). - -![](../../../../assets/memorySize.png) - -4. Click Next and select the "Create a virtual hard disk now" radio button. - -5. Click Create and choose the "VDI (VirtualBox Disk Image)" radio button. - -6. Click Next and select the "Dynamically allocated" radio button. - -7. Click Next and set the virtual hard disk size (minimum required is 30 GB). - -![](../../../../assets/harddiskSize.png) - -8. Click Create to finalize the new VM setup. - -![](../../../../assets/createVM.png) - -## Step 2b: Configure the VM - -1. Select the newly created VM and click Settings. - -2. In the System section, go to the Processor tab and set the Processor(s) to at least 2 CPUs. - -![](../../../../assets/processorNumber.png) - -3. In the Network section, go to the Adapter 1 tab and select "Bridged Adapter" under the "Attached to" label. - -4. Under Advanced settings: - * Set "Promiscuous Mode" to "Allow All". - - *Click the Refresh icon to refresh your MAC Address. - - *Ensure the "Cable Connected" checkbox is checked. - - -5. Click OK to save your settings. - -![](../../../../assets/networkSettings.png) - -## Step 2c: Start the VM and Install the OS - -1. Click Start to launch your VM. - -2. Provide an image of the OS you want to install in the VM. - -![](../../../../assets/loadImage.png) - -3. Follow the prompts to complete the OS installation (this typically takes 10-15 minutes). - -4. After installation, restart the VM. - -## Step 2d: Configure the OS - -1. If the user is a sudo user, refer to the [sudo user requirements](../sudo-user-reqs/). - -2. Open the terminal and type `ip a` to get your private IPv4 address. - -![](../../../../assets/privateIP.png) - -## Step 3: Port Forwarding - -1. Access your router's configuration page and set up port forwarding to the IPv4 address obtained earlier. - * Port 8443, 8444: For running Akash Provider service. - - * Port 80, 443: For applications deployed under your provider. - - * Port 22: For SSH connections. - - * Ports 30000-32767: For other TCP/UDP connections. - -![](../../../../assets/basicSettings.png) - -> Note: The configuration settings in the above screenshot are just for reference, and may vary depending on your ISP. - -You are now ready to become an Akash cloud provider. First, you will need to know your public IP address. - -## Support - -If you have any issues or trouble getting the provider machine up and running, you may reach out to the [Praetor](https://praetorapp.com) team on [Discord](https://discord.com/invite/uzUCHTF93D) or [Twitter/X](https://x.com/praetor_app). - - - diff --git a/src/content/Docs/deployments/praetor-app/akash-provider/decomission-provider/index.mdx b/src/content/Docs/deployments/praetor-app/akash-provider/decomission-provider/index.mdx deleted file mode 100644 index 68240bfd..00000000 --- a/src/content/Docs/deployments/praetor-app/akash-provider/decomission-provider/index.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -categories: ["Praetor App"] -tags: ["Praetor App"] -weight: 6 -title: "Decomission a Provider" -linkTitle: "Decomission a Provider" ---- - - -## Single Server Provider - - -To execute the following commands, first SSH into your machine using the credentials you used for Praetor. - - -`/usr/local/bin/k3s-uninstall.sh` - -and: - -`rm -rf ~/.akash/ ~/bin/ ~/.kube/ ~/.praetor/ ~/ingress-nginx-custom.yaml` \ No newline at end of file diff --git a/src/content/Docs/deployments/praetor-app/akash-provider/existing-cluster/index.mdx b/src/content/Docs/deployments/praetor-app/akash-provider/existing-cluster/index.mdx deleted file mode 100644 index 439ef95e..00000000 --- a/src/content/Docs/deployments/praetor-app/akash-provider/existing-cluster/index.mdx +++ /dev/null @@ -1,254 +0,0 @@ ---- -categories: ["Praetor App"] -tags: ["Praetor App"] -weight: 6 -title: "Existing Kubernetes Cluster" -linkTitle: "Existing Kubernetes Cluster" ---- - - -If you answered "yes," follow the guide below to become an Akash Cloud Provider. If "no," please refer to the [Single Server Provider](docs/deployments/praetor-app/akash-provider/single-server-provider/index.mdx) documentation for assistance. - - - -> NOTICE! It is now recommended that you use `chrony` instead of `systemd`. You can see instructions on how to install `chrony` on the [Time Sybnchronization Documentation page](docs/providers/build-a-cloud-provider/time-synchronization/index.md) - - -## Prerequisites: - -1. A complete Kubernetes cluster. -2. Open the SSH port (usually 22) for the IP Address "68.250.12.64" (Praetor App's IP). -3. An existing Akash wallet with a minimum balance of 5 AKT. -4. The Kubernetes config file of the cluster you wish to provide. -5. A valid domain name to perform DNS changes, pointing specific domains to your cluster's machines/IP addresses. - - -## Step 1: Check the Kubernetes Cluster - -Ensure your cluster is ready by executing the following command: - -``` -debian@node1:~$ kubectl get nodes -o wide - -NAME STATUS ROLES AGE VERSION INTERNAL-IP EXTERNAL-IP OS-IMAGE KERNEL-VERSION CONTAINER-RUNTIME -node1 Ready control-plane,master 13d v1.23.6 10.0.10.114 Debian GNU/Linux 10 (buster) 4.19.0-20-amd64 containerd://1.6.3 - -node2 Ready control-plane,master 13d v1.23.6 10.0.10.115 Debian GNU/Linux 10 (buster) 4.19.0-20-amd64 containerd://1.6.3 - -node3 Ready 13d v1.23.6 10.0.10.116 Debian GNU/Linux 10 (buster) 4.19.0-20-amd64 containerd://1.6.3 -``` - -Notice the CONTAINER-RUNTIME column's value must be "containerd". - -Ensure that the Kubernetes cluster's runtime class is "gVisor." You can verify this by running the following command. - -``` -debian@node1:~$ kubectl get runtimeclass - -NAME HANDLER AGE -gvisor runsc 13d - -``` - -## Step 2: Praetor App Login - -Go to the [Praetor Application](https://akash.praetorapp.com/) to become an Akash Cloud Provider - - -![](../../../../assets/praetor-app-login-home.jpg) - -Click on the "Connect" button. It will ask you to connect your Akash wallet using the Keplr browser extension. - -> NOTICE! This address will be used to become a cloud provider on the network. - -![](../../../../assets/connect-keplr-wallet.jpg) - -Keplr will request your permission to connect the wallet with Praetor App. Click "Approve" to continue. - -![](../../../../assets/sign-message.jpg) - - -Kelpr wallet would ask you to approve the transaction by approving your signature. -This signature would be used to make secure communication between the services. - -![](../../../../assets/kubernetesBuild.png) - -You would be redirected to a page where you select the number of servers you want to provide to Akash. As you already have you already have an existing Kubernetes cluster, click on the "Skip this step if you have Kubernetes" button. - -## Step 3: Control Machine Access - - -![](../../../../assets/controlAccess.png) - -> NOTE! If you have GPUs, select "Yes" and you will see two options for your GPU selection. Please choose the appropriate answer and click the "Verify" button. - - -To install the Akash software and connect with your Kubernetes cluster, Praetor requires access to your server. This process needs a user with sudo access or root user privileges. - -### Prerequisites: - -**Open SSH Port:** Open the SSH port (usually 22) for the IP addresses "185.209.177.59, 185.209.177.46, 185.209.176.35" (Praetor App's IP). - -### Inputs Required: - -**Hostname:** Your server's hostname (either IP or web address without HTTP or HTTPS). If you use an IP address, it must be your public IPv4 address. - -**Username:** The server username to log in (e.g., root, admin, ubuntu, debian, etc.). - -### Password or File: - -**Password:** Enter the login password for the user. -**File:** Upload the SSH private key file. If your key file is encrypted, you can also provide a passphrase. -**Kube Config File:** Upload a valid Kubernetes configuration file. - -Upon clicking "verify," the following pop-up screen will open. - -![](../../../../assets/kubernetesReady.png) - -This alert message asks if you have the necessary dependencies for the Akash Network already installed. The required dependencies for Akash Network are Akash Software, hostname operator, network policy, and Ingress NGINX. - -* Clicking "No" will install the Akash Network dependencies on the server. -* Clicking "Yes" indicates that all dependencies are already installed on the server and skips the Akash installation process. - -## Step 4: Import Akash Wallet - -You need to import a wallet to be able to run your provider as well as to receive lease payouts in AKT. - -![](../../../../assets/importWallet.png) - -There are two ways to import your Akash wallet, namely: - -1. Praetor Mode(Recommended) - -![](../../../../assets/praetorMode.png) - -Praetor will verify a seed phrase for an existing account and create a Keystore file in your server. - -**Input** -* Seed Phrase: Wallet Seed phrase (e.g. apple create carpet grain juice) -* Password: 8 letter password of your choice. The app will use the password to encrypt the Keystore file. - -> IMPORTANT! Praetor uses end-to-end encryption on both your password and seed phrase, so you can rest assured that they are safe. That said, if you don’t want to provide your seed phrase here, you can switch to manual mode by clicking on the “Switch to Manual Mode” button. - -2. Manual Mode - -![](../../../../assets/manualMode.png) - -Run the following steps on your server: - -(i) Login to the control machine using the username you used in the **Step 2** - -(ii) Create a Keyring file using the command - -`~/bin/akash — keyring-backend file keys add wallet_name — recover` - -(iii) Enter your mnemonic seed phrase and password - -(iv) Run the following command and enter the same passphrase you have used in (ii) - -`echo {passphrase} > ~/.praetor/wallet_phrase_password.txt` - -## Step 5a: Provider Configuration - -![](../../../../assets/providerConfig.png) - -You one step are closer to becoming a provider on the Akash Network. - -On the `Provider Configuration` page, provide your Domain name and Organization Name, after which you then click "Next." - - -**Input** - -* Domain Name: Please enter your domain name. Please make sure you have access to the domain name as you'll need the DNS details later on. - -* Organization Name: Choose a unique name for your machine on the Akash Network (e.g. Praetor App). - -## Step 5b: Provider Pricing - - -![](../../../../assets/providerPricing.png) - -On the "Provider Pricing" page, you would be required to enter your system configuration. Praetor will use the information provided to generate a server certificate, aand turn on your provider service on Akash. - -Under advanced settings, you can set the pricing you wish to lease out your machine. It would also allow you to see the estimated earnings you would receive from your provider. - -**Input** - -* CPU Scale Bid Price: CPU scale pricing in USD per thread per month. -* Memory Scale Bid Price: Memory scale pricing in USD per GB per month. -* Storage Scale Bid Price: Storage scale pricing in USD per GB per month. -* Persistent Storage Scale Bid Price: Persistent Storage scale pricing in USD per GB per month. - -**Advanced Settings** - -* IP Scale Price: IP Scale price in USD per IP per month. -* Endpoint Scale Bid Price: Endpoint pricing in USD per porth per month. -* Bid Deposit: Bid deposit in uakt (e.g. 5000000 uakts = 5 AKTs). - -## Step 5c: Provider Attributes - -![](../../../../assets/providerAttributes.png) - -On the "Provider Attributes" page, you can add custom attributes to your provider. To do so, you would need to enter the attributes as a key-value pair, and then click on the "Next" button. - -> NOTE! Adding extra attributes may incur additional charges. - -Once you have filled in all the necessary information, click on "Next". The process of becoming provider on chain will then begin. - -![](../../../../assets/creatingScript.png) - -Wait a few minutes as the progress screen keeps you updated as Praetor runs a script to make you an Akash provider. - -![](../../../../assets/congratsScreen.png) - -Once the process is completed you'll be redirected to a page congratulating you on became a provider on Akash Network. - -## Step 6: Port & DNS Configuration - -All the ports listed in the port table have to open for 0.0.0.0(Anywhere IPv4). - -Ensure your provider domain and ingress domain point to the correct IP Address shown in the image below. - -![](../../../../assets/portDNS.png) - -## Step 7: Akash Audit - -Akash is audited by security professionals trusted by the Akash community. They are responsible for auditing providers' technical proficiency so as to provide ansurance to consumers about the minimum quality of service you can provide. - -![](../../../../assets/akashAudit.png) - -To begin the auditing process, click on the "Apply for Audit" button as shown in the image above. -You would then be required to provide basic information about your provider. - -![](../../../../assets/applyAudit.png) - -Complete the form and submit. You may also decide to skip the audit process if you want to, but that means you would not be considered a reliable provider by most potential customers. - - -## Step 8: Dashboard - -![](../../../../assets/dashboard.png) - -Congratulations! You are now a provider, and should be able to receive leases on your machine. The Dashboard will provide information about your machine's server statistics, as well as show hactive, available, and pending resources. - -![](../../../../assets/providerSettings.png) - -Click on "Provider Settings" if you want to modify various settings for your provider. These include attributes, pricing, domain name, provider url and provider node. You can also restart or upgrade your provider,as well as send a message to your deployers. - -![](../../../../assets/providerDeployments.png) - -Click on "Provider Deployments" to see active and inactive deployments in your provider. - -## Support - -If you have any issues or trouble getting the provider machine up and running, you may reach out to the [Praetor](https://praetorapp.com) team on [Discord](https://discord.com/invite/uzUCHTF93D) or [Twitter/X](https://x.com/praetor_app). - - - - - - - - - - diff --git a/src/content/Docs/deployments/praetor-app/akash-provider/single-server-provider/index.mdx b/src/content/Docs/deployments/praetor-app/akash-provider/single-server-provider/index.mdx deleted file mode 100644 index c12f95bf..00000000 --- a/src/content/Docs/deployments/praetor-app/akash-provider/single-server-provider/index.mdx +++ /dev/null @@ -1,180 +0,0 @@ ---- -categories: ["Praetor App"] -tags: ["Praetor App"] -weight: 6 -title: "Single Server Provider" -linkTitle: "Single Server Provider" ---- - - -If you have a single server and wish to become a cloud provider on the Akash Network, this guide will help you set up Kubernetes and become an Akash provider using the Praetor App. - -**Prerequisites** - -* Keplr Wallet: Ensure the Keplr wallet extension is enabled in your web browser. - -* Akash Wallet: You need at least 5 AKT in your Akash wallet to become a provider. -* Domain Name: A valid domain name is required to make DNS changes and point it to your server's IP address. - -**GPU Testnet** - -If you're joining the Testnet, select "Testnet" from the dropdown. Note that only the latest Nvidia GPUs are currently supported by the Akash Network. - - -## Step 1: Praetor App Login - -1. Access Praetor App: - -![](../../../../assets/praetor-app-login.jpg) - - -* Go to the [Praetor Application](https://akash.praetorapp.com/) to begin the setup. - - - -2. Connect Wallet: - -![](../../../../assets/connect-keplr-wallet.jpg) - -* Click "Connect" and connect your Akash wallet using the Keplr extension. - -* Select "Testnet" if applicable. - - -3. Authorize Connection: - -![](../../../../assets/sign-message.jpg) - -* Approve the connection request from Keplr to connect your wallet to Praetor App. - -* Sign the message in Keplr to secure communication with the backend. - - -4. Server Provisioning: - -![](../../../../assets/kubernetesBuild.png) - -* Select the number of servers to provide to Akash. For a single server, select "1 Server". - - -## Step 2: Server Access - -1. Server Details: - -![](../../../../assets/serverAccess.png) - -> NOTE!: If you have a GPU then select "Yes" and you will see two new options for your GPU selection. Please choose the appropriate answer and click "Next". - -* Provide your server's hostname (IP or web address without HTTP/HTTPS). - -* Enter the username (e.g., root, admin) and either the login password or upload the SSH private key file. - -2. Install Dependencies: - -![](../../../../assets/installDependencies.png) - -* The application will access your server to install Kubernetes, Akash software, and necessary dependencies. Ensure SSH port 22 is open. - -## Step 3: Import Akash Wallet - -You need to import a wallet to be able to run your provider as well as to receive lease payouts in AKT. - -![](../../../../assets/importWallet.png) - -There are two ways to import your Akash wallet, namely: - - -1. Praetor Mode (Recommended): - -![](../../../../assets/praetorMode.png) - -* Input your wallet seed phrase and password. The app will verify the seed phrase and create a keystore file on your server. - - -> IMPORTANT! Praetor uses end-to-end encryption on both your password and seed phrase, so you can rest assured that they are safe. That said, if you don’t want to provide your seed phrase here, you can switch to manual mode by clicking on the “Switch to Manual Mode” button. - - -2. Manual Mode: - -![](../../../../assets/manualMode.png) - -* Log in to your server. - -* Use the command `~/bin/akash — keyring-backend file keys add wallet_name — recover` to create a keyring file. - -* Enter your seed phrase and password, run ```echo {passphrase} > ~/.praetor/wallet_phrase_password.txt```. - - -## Step 4a: Provider Configuration - - -![](../../../../assets/providerConfig.png) - - -* Domain Name: Enter your domain name. - -* Organization Name: Provide a unique name representing your machine on Akash Network. - -## Step 4b Provider Pricing - -![](../../../../assets/providerPricing.png) - -* CPU, Memory, Storage Pricing: Set your pricing in USD per month for each resource. - -* Advanced Settings: Configure additional pricing for IPs, endpoints, and bid deposits in uakt (e.g. 5000000 uakts = 5 AKTs). - -## Step 4c Provider Attributes - -![](../../../../assets/providerAttributes.png) - -* Custom Attributes: Add any custom attributes in key-value pairs. - -> NOTE! Adding extra attributes may incur additional charges. - -![](../../../../assets/creatingScript.png) - -Wait a few minutes as the progress screen keeps you updated as Praetor runs a script to make you an Akash provider. - -![](../../../../assets/congratsScreen.png) - -Once the process is completed you'll be redirected to a page congratulating you on became a provider on Akash Network. - - -## Step 5: Port & DNS Configuration - -![](../../../../assets/portDNS.png) - -* Ensure all required ports are open for IPv4 (0.0.0.0). - -* Update your DNS settings to point your domain to the correct IP address shown in the image above. - - -## Step 6: Akash Audit - - -![](../../../../assets/akashAudit.png) - -* Apply for Audit: Provide basic information to apply for an Akash audit. - -![](../../../../assets/applyAudit.png) - -* Skip Audit: You can choose to skip the audit and proceed to the dashboard. - -## Step 7: Dashboard - -![](../../../../assets/dashboard.png) - -* Dashboard Overview: Monitor your server's statistics, including active, available, and pending resources. - -![](../../../../assets/providerSettings.png) - -* Provider Settings: Modify settings, restart, or upgrade your provider. - -![](../../../../assets/providerDeployments.png) - -* Provider Deployments: View and manage active and inactive deployments. - -## Support - -If you have any issues or trouble getting the provider machine up and running, you may reach out to the [Praetor](https://praetorapp.com) team on [Discord](https://discord.com/invite/uzUCHTF93D) or [Twitter/X](https://x.com/praetor_app). - diff --git a/src/content/Docs/deployments/praetor-app/akash-provider/sudo-user-reqs/index.mdx b/src/content/Docs/deployments/praetor-app/akash-provider/sudo-user-reqs/index.mdx deleted file mode 100644 index be5cfa89..00000000 --- a/src/content/Docs/deployments/praetor-app/akash-provider/sudo-user-reqs/index.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -categories: ["Praetor App"] -tags: ["Praetor App"] -weight: 6 -title: "Sudo User Requirements" -linkTitle: "Sudo User Requirements" ---- - -This document explains how to grant sudo rights to a user before using the Praetor App. - -## Steps to Grant Sudo Rights - -1. Connect to Your Server - -First, connect to your server using SSH. - -2. Edit the Sudoers File - -After logging in to the server, type the following command: - -`sudo visudo` - -This command opens the sudoers file for editing. - -3. Update the Sudoers File - -Locate the following lines in the sudoers file and update them as shown to enable sudo access for the current user: - -``` -%admin ALL=(ALL) NOPASSWD: ALL -%sudo ALL=(ALL:ALL) NOPASSWD: ALL - ALL=(ALL) NOPASSWD: ALL - -``` - -Replace `` with the username you wish to grant sudo rights to, if it is not already an admin or root user. For example, if the user is `praetor`, the line should read: - -``` -praetor ALL=(ALL) NOPASSWD: ALL - -``` - -![](../../../../assets/praetorRoot.png) diff --git a/src/content/Docs/deployments/praetor-app/what-is/index.mdx b/src/content/Docs/deployments/praetor-app/what-is/index.mdx deleted file mode 100644 index 2d7675ca..00000000 --- a/src/content/Docs/deployments/praetor-app/what-is/index.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -categories: ["Praetor App"] -tags: ["Praetor App"] -weight: 5 -title: "What is Praetor App?" -linkTitle: "What is Praetor App?" ---- - - -Praetor App simplifies the process of becoming a cloud provider for the Akash Network. Instead of using a Command-line Interface, you can manage everything through our user-friendly interface. Once you set up as a provider, deployers who choose your services will pay you in AKT. - -With Praetor App, you can offer a single server or multiple servers, supporting operating systems like Ubuntu, Debian, and CentOS. - -Got underutilized Kubernetes? You can also integrate it with the Akash Network through Praetor App. Our app helps you configure your existing Kubernetes setup for Akash Network compatibility and initiates the Provider Service necessary to accept bids and manifests. - -Have questions or need assistance? You may reach out to us on [Discord](http://discord.gg/uzUCHTF93D). - diff --git a/src/content/Docs/providers/community-solutions/index.md b/src/content/Docs/providers/community-solutions/index.md index 953928a7..5087135a 100644 --- a/src/content/Docs/providers/community-solutions/index.md +++ b/src/content/Docs/providers/community-solutions/index.md @@ -8,19 +8,8 @@ linkTitle: "Community Solutions" The Akash community drives innovation in Provider tooling. Our highlighted community contributions include: -- [Praetor](#praetor) - allows users with limited Kubernetes experience to fully build a provider in a curated series of steps within a user friendly web app - [AkashDash](#akashdash---provider-earnings-portal) - offers Akash providers an instantaneous view of profitability metrics both on a per lease basis and in summation across all current/active leases. -## Praetor - -The Praetor application offers a streamlined mechanism to deploy an Akash Provider. The web app allows the creation of the necessary Kubernetes cluster and the Provider instance all from within an extremely user friendly series of guided steps. - -In addition to the Praetor Provider build app, the team has created great tools for viewing current Akash Providers and a Provider revenue calculator. - -- [Praetor Documentation](https://docs.praetorapp.com/) or [here](/docs/deployments/praetor-app/what-is/) -- [Praetor Provider Build App](https://akash.praetorapp.com/auth/login) -- [Praetor Provider Revenue Calculator](https://akash.praetorapp.com/calculator) -- [Praetor Current Akash Provider Report](https://akash.praetorapp.com/provider-status) ## AkashDash - Provider Earnings Portal diff --git a/src/content/Docs/providers/build-a-cloud-provider/intro/index.md b/src/content/Docs/providers/intro/index.md similarity index 100% rename from src/content/Docs/providers/build-a-cloud-provider/intro/index.md rename to src/content/Docs/providers/intro/index.md From ab2a1b471bf58165258219d4bfe8c316e4df43db Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:41:53 +0100 Subject: [PATCH 08/10] replacing praetor references with those of provider console --- src/content/Docs/index.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/content/Docs/index.mdx b/src/content/Docs/index.mdx index f8bcba9c..b65c8fb8 100644 --- a/src/content/Docs/index.mdx +++ b/src/content/Docs/index.mdx @@ -95,10 +95,10 @@ import rocket from "./assets/providers/rocket.svg"; link="/docs/providers/build-a-cloud-provider/kubernetes-cluster-for-akash-providers/kubernetes-cluster-for-akash-providers/" /> Date: Thu, 27 Feb 2025 10:28:13 +0100 Subject: [PATCH 09/10] archived the praetor app docs --- src/content/Docs/index.mdx | 2 +- .../akash-mainnet8-upgrade/index.md | 4 +- .../build-cloud-provider/index.mdx | 49 ++++ .../build-windows-provider/index.mdx | 110 ++++++++ .../decomission-provider/index.mdx | 20 ++ .../akash-provider/existing-cluster/index.mdx | 254 ++++++++++++++++++ .../single-server-provider/index.mdx | 180 +++++++++++++ .../akash-provider/sudo-user-reqs/index.mdx | 43 +++ .../praetor-app/what-is/index.mdx | 17 ++ .../index.md | 2 +- 10 files changed, 677 insertions(+), 4 deletions(-) create mode 100644 src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/build-cloud-provider/index.mdx create mode 100644 src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/build-windows-provider/index.mdx create mode 100644 src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/decomission-provider/index.mdx create mode 100644 src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/existing-cluster/index.mdx create mode 100644 src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/single-server-provider/index.mdx create mode 100644 src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/sudo-user-reqs/index.mdx create mode 100644 src/content/Docs/other-resources/archived-resources/praetor-app/what-is/index.mdx diff --git a/src/content/Docs/index.mdx b/src/content/Docs/index.mdx index b65c8fb8..68d31c75 100644 --- a/src/content/Docs/index.mdx +++ b/src/content/Docs/index.mdx @@ -96,7 +96,7 @@ import rocket from "./assets/providers/rocket.svg"; /> diff --git a/src/content/Docs/other-resources/akash-mainnet8-upgrade/index.md b/src/content/Docs/other-resources/akash-mainnet8-upgrade/index.md index 2f6cc928..e3394636 100644 --- a/src/content/Docs/other-resources/akash-mainnet8-upgrade/index.md +++ b/src/content/Docs/other-resources/akash-mainnet8-upgrade/index.md @@ -211,9 +211,9 @@ This is a comprehensive guide that covers the steps necessary to upgrade from Ma ### IMPORTANT -#### This procedure does not apply to Praetor providers! +#### This procedure does not apply to providers using the Provider Console! -Praetor providers should wait for further upgrade instructions from Praetor team! +Providers using the Provider Console (previously know as Praetor App) should wait for further upgrade instructions from the Akash team! ### Provider Components to be Upgraded diff --git a/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/build-cloud-provider/index.mdx b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/build-cloud-provider/index.mdx new file mode 100644 index 00000000..67cd2b39 --- /dev/null +++ b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/build-cloud-provider/index.mdx @@ -0,0 +1,49 @@ +--- +categories: ["Praetor App"] +tags: ["Praetor App"] +weight: 6 +title: "Build a Cloud Provider" +linkTitle: "Build a Cloud Provider" +--- + +## Prerequisites of an Akash Provider + +### Wallet Funding - Minimum of 5 AKT + +To place a bid on an order, a deposit of 5 AKT is required. This deposit is fully refunded regardless of whether the bid is won or lost. + +For detailed steps on creating an Akash account, please refer to our [documentation](/docs/deployments/akash-cli/installation/). + +### Kubernetes Cluster Hardware Requirements and Recommendations + +Kubernetes Master Node Requirements + +* Minimum Specifications: + + * 8 CPUs + * 16 GB RAM + * 50 GB Disk + + +* Recommended Specifications: + + * 16 CPUs + * 32 GB RAM + * 100 GB Disk + + +Kubernetes Worker Node Requirements + +* Minimum Specifications: + + * 4 CPUs + * 8 GB RAM + * 100 GB Disk + +* Recommendations: + + * The more resources available, the better the performance, especially for handling a higher number of concurrent deployments. + * It is crucial to maximize CPU capacity. For instance, with 8 CPUs, 100 GB RAM, and 2 TB storage, the CPU would likely be the bottleneck. Since people tend to deploy at least 1 CPU per deployment, the server could only host 8 deployments maximum and likely about 6 deployments as other ~2 CPUs will be reserved by the Kubernetes system components. + +Ready to become an Akash Cloud Provider and start earning? Visit the [Praetor Application](https://akash.praetorapp.com/) now. + diff --git a/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/build-windows-provider/index.mdx b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/build-windows-provider/index.mdx new file mode 100644 index 00000000..163e87f8 --- /dev/null +++ b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/build-windows-provider/index.mdx @@ -0,0 +1,110 @@ +--- +categories: ["Praetor App"] +tags: ["Praetor App"] +weight: 6 +title: "Build a Cloud Provider (Windows)" +linkTitle: "Build a Cloud Provider (Windows)" +--- + + +If you have a Windows machine and want to become a Provider, follow these steps: + +## Step 1: Download and Install Oracle VirtualBox + +1. Download VirtualBox by [here](https://www.virtualbox.org/wiki/Downloads). Select "Windows host" to download the Windows version. + +2. Install VirtualBox by double-clicking the downloaded file. + +## Step 2a: Create a New VM and Install an OS + +1. Open VirtualBox and click on Machine > New. + + + +2. Provide a name and path for the VM. Select the operating system type "Linux" and the version "Ubuntu" based on your computer's architecture. + +![](../../../../assets/virutalbox.png) + +3. Click Next and set the memory size (minimum required is 4096 MB). + +![](../../../../assets/memorySize.png) + +4. Click Next and select the "Create a virtual hard disk now" radio button. + +5. Click Create and choose the "VDI (VirtualBox Disk Image)" radio button. + +6. Click Next and select the "Dynamically allocated" radio button. + +7. Click Next and set the virtual hard disk size (minimum required is 30 GB). + +![](../../../../assets/harddiskSize.png) + +8. Click Create to finalize the new VM setup. + +![](../../../../assets/createVM.png) + +## Step 2b: Configure the VM + +1. Select the newly created VM and click Settings. + +2. In the System section, go to the Processor tab and set the Processor(s) to at least 2 CPUs. + +![](../../../../assets/processorNumber.png) + +3. In the Network section, go to the Adapter 1 tab and select "Bridged Adapter" under the "Attached to" label. + +4. Under Advanced settings: + * Set "Promiscuous Mode" to "Allow All". + + *Click the Refresh icon to refresh your MAC Address. + + *Ensure the "Cable Connected" checkbox is checked. + + +5. Click OK to save your settings. + +![](../../../../assets/networkSettings.png) + +## Step 2c: Start the VM and Install the OS + +1. Click Start to launch your VM. + +2. Provide an image of the OS you want to install in the VM. + +![](../../../../assets/loadImage.png) + +3. Follow the prompts to complete the OS installation (this typically takes 10-15 minutes). + +4. After installation, restart the VM. + +## Step 2d: Configure the OS + +1. If the user is a sudo user, refer to the [sudo user requirements](../sudo-user-reqs/). + +2. Open the terminal and type `ip a` to get your private IPv4 address. + +![](../../../../assets/privateIP.png) + +## Step 3: Port Forwarding + +1. Access your router's configuration page and set up port forwarding to the IPv4 address obtained earlier. + * Port 8443, 8444: For running Akash Provider service. + + * Port 80, 443: For applications deployed under your provider. + + * Port 22: For SSH connections. + + * Ports 30000-32767: For other TCP/UDP connections. + +![](../../../../assets/basicSettings.png) + +> Note: The configuration settings in the above screenshot are just for reference, and may vary depending on your ISP. + +You are now ready to become an Akash cloud provider. First, you will need to know your public IP address. + +## Support + +If you have any issues or trouble getting the provider machine up and running, you may reach out to the [Praetor](https://praetorapp.com) team on [Discord](https://discord.com/invite/uzUCHTF93D) or [Twitter/X](https://x.com/praetor_app). + + + diff --git a/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/decomission-provider/index.mdx b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/decomission-provider/index.mdx new file mode 100644 index 00000000..68240bfd --- /dev/null +++ b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/decomission-provider/index.mdx @@ -0,0 +1,20 @@ +--- +categories: ["Praetor App"] +tags: ["Praetor App"] +weight: 6 +title: "Decomission a Provider" +linkTitle: "Decomission a Provider" +--- + + +## Single Server Provider + + +To execute the following commands, first SSH into your machine using the credentials you used for Praetor. + + +`/usr/local/bin/k3s-uninstall.sh` + +and: + +`rm -rf ~/.akash/ ~/bin/ ~/.kube/ ~/.praetor/ ~/ingress-nginx-custom.yaml` \ No newline at end of file diff --git a/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/existing-cluster/index.mdx b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/existing-cluster/index.mdx new file mode 100644 index 00000000..439ef95e --- /dev/null +++ b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/existing-cluster/index.mdx @@ -0,0 +1,254 @@ +--- +categories: ["Praetor App"] +tags: ["Praetor App"] +weight: 6 +title: "Existing Kubernetes Cluster" +linkTitle: "Existing Kubernetes Cluster" +--- + + +If you answered "yes," follow the guide below to become an Akash Cloud Provider. If "no," please refer to the [Single Server Provider](docs/deployments/praetor-app/akash-provider/single-server-provider/index.mdx) documentation for assistance. + + + +> NOTICE! It is now recommended that you use `chrony` instead of `systemd`. You can see instructions on how to install `chrony` on the [Time Sybnchronization Documentation page](docs/providers/build-a-cloud-provider/time-synchronization/index.md) + + +## Prerequisites: + +1. A complete Kubernetes cluster. +2. Open the SSH port (usually 22) for the IP Address "68.250.12.64" (Praetor App's IP). +3. An existing Akash wallet with a minimum balance of 5 AKT. +4. The Kubernetes config file of the cluster you wish to provide. +5. A valid domain name to perform DNS changes, pointing specific domains to your cluster's machines/IP addresses. + + +## Step 1: Check the Kubernetes Cluster + +Ensure your cluster is ready by executing the following command: + +``` +debian@node1:~$ kubectl get nodes -o wide + +NAME STATUS ROLES AGE VERSION INTERNAL-IP EXTERNAL-IP OS-IMAGE KERNEL-VERSION CONTAINER-RUNTIME +node1 Ready control-plane,master 13d v1.23.6 10.0.10.114 Debian GNU/Linux 10 (buster) 4.19.0-20-amd64 containerd://1.6.3 + +node2 Ready control-plane,master 13d v1.23.6 10.0.10.115 Debian GNU/Linux 10 (buster) 4.19.0-20-amd64 containerd://1.6.3 + +node3 Ready 13d v1.23.6 10.0.10.116 Debian GNU/Linux 10 (buster) 4.19.0-20-amd64 containerd://1.6.3 +``` + +Notice the CONTAINER-RUNTIME column's value must be "containerd". + +Ensure that the Kubernetes cluster's runtime class is "gVisor." You can verify this by running the following command. + +``` +debian@node1:~$ kubectl get runtimeclass + +NAME HANDLER AGE +gvisor runsc 13d + +``` + +## Step 2: Praetor App Login + +Go to the [Praetor Application](https://akash.praetorapp.com/) to become an Akash Cloud Provider + + +![](../../../../assets/praetor-app-login-home.jpg) + +Click on the "Connect" button. It will ask you to connect your Akash wallet using the Keplr browser extension. + +> NOTICE! This address will be used to become a cloud provider on the network. + +![](../../../../assets/connect-keplr-wallet.jpg) + +Keplr will request your permission to connect the wallet with Praetor App. Click "Approve" to continue. + +![](../../../../assets/sign-message.jpg) + + +Kelpr wallet would ask you to approve the transaction by approving your signature. +This signature would be used to make secure communication between the services. + +![](../../../../assets/kubernetesBuild.png) + +You would be redirected to a page where you select the number of servers you want to provide to Akash. As you already have you already have an existing Kubernetes cluster, click on the "Skip this step if you have Kubernetes" button. + +## Step 3: Control Machine Access + + +![](../../../../assets/controlAccess.png) + +> NOTE! If you have GPUs, select "Yes" and you will see two options for your GPU selection. Please choose the appropriate answer and click the "Verify" button. + + +To install the Akash software and connect with your Kubernetes cluster, Praetor requires access to your server. This process needs a user with sudo access or root user privileges. + +### Prerequisites: + +**Open SSH Port:** Open the SSH port (usually 22) for the IP addresses "185.209.177.59, 185.209.177.46, 185.209.176.35" (Praetor App's IP). + +### Inputs Required: + +**Hostname:** Your server's hostname (either IP or web address without HTTP or HTTPS). If you use an IP address, it must be your public IPv4 address. + +**Username:** The server username to log in (e.g., root, admin, ubuntu, debian, etc.). + +### Password or File: + +**Password:** Enter the login password for the user. +**File:** Upload the SSH private key file. If your key file is encrypted, you can also provide a passphrase. +**Kube Config File:** Upload a valid Kubernetes configuration file. + +Upon clicking "verify," the following pop-up screen will open. + +![](../../../../assets/kubernetesReady.png) + +This alert message asks if you have the necessary dependencies for the Akash Network already installed. The required dependencies for Akash Network are Akash Software, hostname operator, network policy, and Ingress NGINX. + +* Clicking "No" will install the Akash Network dependencies on the server. +* Clicking "Yes" indicates that all dependencies are already installed on the server and skips the Akash installation process. + +## Step 4: Import Akash Wallet + +You need to import a wallet to be able to run your provider as well as to receive lease payouts in AKT. + +![](../../../../assets/importWallet.png) + +There are two ways to import your Akash wallet, namely: + +1. Praetor Mode(Recommended) + +![](../../../../assets/praetorMode.png) + +Praetor will verify a seed phrase for an existing account and create a Keystore file in your server. + +**Input** +* Seed Phrase: Wallet Seed phrase (e.g. apple create carpet grain juice) +* Password: 8 letter password of your choice. The app will use the password to encrypt the Keystore file. + +> IMPORTANT! Praetor uses end-to-end encryption on both your password and seed phrase, so you can rest assured that they are safe. That said, if you don’t want to provide your seed phrase here, you can switch to manual mode by clicking on the “Switch to Manual Mode” button. + +2. Manual Mode + +![](../../../../assets/manualMode.png) + +Run the following steps on your server: + +(i) Login to the control machine using the username you used in the **Step 2** + +(ii) Create a Keyring file using the command + +`~/bin/akash — keyring-backend file keys add wallet_name — recover` + +(iii) Enter your mnemonic seed phrase and password + +(iv) Run the following command and enter the same passphrase you have used in (ii) + +`echo {passphrase} > ~/.praetor/wallet_phrase_password.txt` + +## Step 5a: Provider Configuration + +![](../../../../assets/providerConfig.png) + +You one step are closer to becoming a provider on the Akash Network. + +On the `Provider Configuration` page, provide your Domain name and Organization Name, after which you then click "Next." + + +**Input** + +* Domain Name: Please enter your domain name. Please make sure you have access to the domain name as you'll need the DNS details later on. + +* Organization Name: Choose a unique name for your machine on the Akash Network (e.g. Praetor App). + +## Step 5b: Provider Pricing + + +![](../../../../assets/providerPricing.png) + +On the "Provider Pricing" page, you would be required to enter your system configuration. Praetor will use the information provided to generate a server certificate, aand turn on your provider service on Akash. + +Under advanced settings, you can set the pricing you wish to lease out your machine. It would also allow you to see the estimated earnings you would receive from your provider. + +**Input** + +* CPU Scale Bid Price: CPU scale pricing in USD per thread per month. +* Memory Scale Bid Price: Memory scale pricing in USD per GB per month. +* Storage Scale Bid Price: Storage scale pricing in USD per GB per month. +* Persistent Storage Scale Bid Price: Persistent Storage scale pricing in USD per GB per month. + +**Advanced Settings** + +* IP Scale Price: IP Scale price in USD per IP per month. +* Endpoint Scale Bid Price: Endpoint pricing in USD per porth per month. +* Bid Deposit: Bid deposit in uakt (e.g. 5000000 uakts = 5 AKTs). + +## Step 5c: Provider Attributes + +![](../../../../assets/providerAttributes.png) + +On the "Provider Attributes" page, you can add custom attributes to your provider. To do so, you would need to enter the attributes as a key-value pair, and then click on the "Next" button. + +> NOTE! Adding extra attributes may incur additional charges. + +Once you have filled in all the necessary information, click on "Next". The process of becoming provider on chain will then begin. + +![](../../../../assets/creatingScript.png) + +Wait a few minutes as the progress screen keeps you updated as Praetor runs a script to make you an Akash provider. + +![](../../../../assets/congratsScreen.png) + +Once the process is completed you'll be redirected to a page congratulating you on became a provider on Akash Network. + +## Step 6: Port & DNS Configuration + +All the ports listed in the port table have to open for 0.0.0.0(Anywhere IPv4). + +Ensure your provider domain and ingress domain point to the correct IP Address shown in the image below. + +![](../../../../assets/portDNS.png) + +## Step 7: Akash Audit + +Akash is audited by security professionals trusted by the Akash community. They are responsible for auditing providers' technical proficiency so as to provide ansurance to consumers about the minimum quality of service you can provide. + +![](../../../../assets/akashAudit.png) + +To begin the auditing process, click on the "Apply for Audit" button as shown in the image above. +You would then be required to provide basic information about your provider. + +![](../../../../assets/applyAudit.png) + +Complete the form and submit. You may also decide to skip the audit process if you want to, but that means you would not be considered a reliable provider by most potential customers. + + +## Step 8: Dashboard + +![](../../../../assets/dashboard.png) + +Congratulations! You are now a provider, and should be able to receive leases on your machine. The Dashboard will provide information about your machine's server statistics, as well as show hactive, available, and pending resources. + +![](../../../../assets/providerSettings.png) + +Click on "Provider Settings" if you want to modify various settings for your provider. These include attributes, pricing, domain name, provider url and provider node. You can also restart or upgrade your provider,as well as send a message to your deployers. + +![](../../../../assets/providerDeployments.png) + +Click on "Provider Deployments" to see active and inactive deployments in your provider. + +## Support + +If you have any issues or trouble getting the provider machine up and running, you may reach out to the [Praetor](https://praetorapp.com) team on [Discord](https://discord.com/invite/uzUCHTF93D) or [Twitter/X](https://x.com/praetor_app). + + + + + + + + + + diff --git a/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/single-server-provider/index.mdx b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/single-server-provider/index.mdx new file mode 100644 index 00000000..c12f95bf --- /dev/null +++ b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/single-server-provider/index.mdx @@ -0,0 +1,180 @@ +--- +categories: ["Praetor App"] +tags: ["Praetor App"] +weight: 6 +title: "Single Server Provider" +linkTitle: "Single Server Provider" +--- + + +If you have a single server and wish to become a cloud provider on the Akash Network, this guide will help you set up Kubernetes and become an Akash provider using the Praetor App. + +**Prerequisites** + +* Keplr Wallet: Ensure the Keplr wallet extension is enabled in your web browser. + +* Akash Wallet: You need at least 5 AKT in your Akash wallet to become a provider. +* Domain Name: A valid domain name is required to make DNS changes and point it to your server's IP address. + +**GPU Testnet** + +If you're joining the Testnet, select "Testnet" from the dropdown. Note that only the latest Nvidia GPUs are currently supported by the Akash Network. + + +## Step 1: Praetor App Login + +1. Access Praetor App: + +![](../../../../assets/praetor-app-login.jpg) + + +* Go to the [Praetor Application](https://akash.praetorapp.com/) to begin the setup. + + + +2. Connect Wallet: + +![](../../../../assets/connect-keplr-wallet.jpg) + +* Click "Connect" and connect your Akash wallet using the Keplr extension. + +* Select "Testnet" if applicable. + + +3. Authorize Connection: + +![](../../../../assets/sign-message.jpg) + +* Approve the connection request from Keplr to connect your wallet to Praetor App. + +* Sign the message in Keplr to secure communication with the backend. + + +4. Server Provisioning: + +![](../../../../assets/kubernetesBuild.png) + +* Select the number of servers to provide to Akash. For a single server, select "1 Server". + + +## Step 2: Server Access + +1. Server Details: + +![](../../../../assets/serverAccess.png) + +> NOTE!: If you have a GPU then select "Yes" and you will see two new options for your GPU selection. Please choose the appropriate answer and click "Next". + +* Provide your server's hostname (IP or web address without HTTP/HTTPS). + +* Enter the username (e.g., root, admin) and either the login password or upload the SSH private key file. + +2. Install Dependencies: + +![](../../../../assets/installDependencies.png) + +* The application will access your server to install Kubernetes, Akash software, and necessary dependencies. Ensure SSH port 22 is open. + +## Step 3: Import Akash Wallet + +You need to import a wallet to be able to run your provider as well as to receive lease payouts in AKT. + +![](../../../../assets/importWallet.png) + +There are two ways to import your Akash wallet, namely: + + +1. Praetor Mode (Recommended): + +![](../../../../assets/praetorMode.png) + +* Input your wallet seed phrase and password. The app will verify the seed phrase and create a keystore file on your server. + + +> IMPORTANT! Praetor uses end-to-end encryption on both your password and seed phrase, so you can rest assured that they are safe. That said, if you don’t want to provide your seed phrase here, you can switch to manual mode by clicking on the “Switch to Manual Mode” button. + + +2. Manual Mode: + +![](../../../../assets/manualMode.png) + +* Log in to your server. + +* Use the command `~/bin/akash — keyring-backend file keys add wallet_name — recover` to create a keyring file. + +* Enter your seed phrase and password, run ```echo {passphrase} > ~/.praetor/wallet_phrase_password.txt```. + + +## Step 4a: Provider Configuration + + +![](../../../../assets/providerConfig.png) + + +* Domain Name: Enter your domain name. + +* Organization Name: Provide a unique name representing your machine on Akash Network. + +## Step 4b Provider Pricing + +![](../../../../assets/providerPricing.png) + +* CPU, Memory, Storage Pricing: Set your pricing in USD per month for each resource. + +* Advanced Settings: Configure additional pricing for IPs, endpoints, and bid deposits in uakt (e.g. 5000000 uakts = 5 AKTs). + +## Step 4c Provider Attributes + +![](../../../../assets/providerAttributes.png) + +* Custom Attributes: Add any custom attributes in key-value pairs. + +> NOTE! Adding extra attributes may incur additional charges. + +![](../../../../assets/creatingScript.png) + +Wait a few minutes as the progress screen keeps you updated as Praetor runs a script to make you an Akash provider. + +![](../../../../assets/congratsScreen.png) + +Once the process is completed you'll be redirected to a page congratulating you on became a provider on Akash Network. + + +## Step 5: Port & DNS Configuration + +![](../../../../assets/portDNS.png) + +* Ensure all required ports are open for IPv4 (0.0.0.0). + +* Update your DNS settings to point your domain to the correct IP address shown in the image above. + + +## Step 6: Akash Audit + + +![](../../../../assets/akashAudit.png) + +* Apply for Audit: Provide basic information to apply for an Akash audit. + +![](../../../../assets/applyAudit.png) + +* Skip Audit: You can choose to skip the audit and proceed to the dashboard. + +## Step 7: Dashboard + +![](../../../../assets/dashboard.png) + +* Dashboard Overview: Monitor your server's statistics, including active, available, and pending resources. + +![](../../../../assets/providerSettings.png) + +* Provider Settings: Modify settings, restart, or upgrade your provider. + +![](../../../../assets/providerDeployments.png) + +* Provider Deployments: View and manage active and inactive deployments. + +## Support + +If you have any issues or trouble getting the provider machine up and running, you may reach out to the [Praetor](https://praetorapp.com) team on [Discord](https://discord.com/invite/uzUCHTF93D) or [Twitter/X](https://x.com/praetor_app). + diff --git a/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/sudo-user-reqs/index.mdx b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/sudo-user-reqs/index.mdx new file mode 100644 index 00000000..be5cfa89 --- /dev/null +++ b/src/content/Docs/other-resources/archived-resources/praetor-app/akash-provider/sudo-user-reqs/index.mdx @@ -0,0 +1,43 @@ +--- +categories: ["Praetor App"] +tags: ["Praetor App"] +weight: 6 +title: "Sudo User Requirements" +linkTitle: "Sudo User Requirements" +--- + +This document explains how to grant sudo rights to a user before using the Praetor App. + +## Steps to Grant Sudo Rights + +1. Connect to Your Server + +First, connect to your server using SSH. + +2. Edit the Sudoers File + +After logging in to the server, type the following command: + +`sudo visudo` + +This command opens the sudoers file for editing. + +3. Update the Sudoers File + +Locate the following lines in the sudoers file and update them as shown to enable sudo access for the current user: + +``` +%admin ALL=(ALL) NOPASSWD: ALL +%sudo ALL=(ALL:ALL) NOPASSWD: ALL + ALL=(ALL) NOPASSWD: ALL + +``` + +Replace `` with the username you wish to grant sudo rights to, if it is not already an admin or root user. For example, if the user is `praetor`, the line should read: + +``` +praetor ALL=(ALL) NOPASSWD: ALL + +``` + +![](../../../../assets/praetorRoot.png) diff --git a/src/content/Docs/other-resources/archived-resources/praetor-app/what-is/index.mdx b/src/content/Docs/other-resources/archived-resources/praetor-app/what-is/index.mdx new file mode 100644 index 00000000..2d7675ca --- /dev/null +++ b/src/content/Docs/other-resources/archived-resources/praetor-app/what-is/index.mdx @@ -0,0 +1,17 @@ +--- +categories: ["Praetor App"] +tags: ["Praetor App"] +weight: 5 +title: "What is Praetor App?" +linkTitle: "What is Praetor App?" +--- + + +Praetor App simplifies the process of becoming a cloud provider for the Akash Network. Instead of using a Command-line Interface, you can manage everything through our user-friendly interface. Once you set up as a provider, deployers who choose your services will pay you in AKT. + +With Praetor App, you can offer a single server or multiple servers, supporting operating systems like Ubuntu, Debian, and CentOS. + +Got underutilized Kubernetes? You can also integrate it with the Akash Network through Praetor App. Our app helps you configure your existing Kubernetes setup for Akash Network compatibility and initiates the Provider Service necessary to accept bids and manifests. + +Have questions or need assistance? You may reach out to us on [Discord](http://discord.gg/uzUCHTF93D). + diff --git a/src/content/Docs/other-resources/experimental/hardware-and-software-recommendations/index.md b/src/content/Docs/other-resources/experimental/hardware-and-software-recommendations/index.md index 41826cd6..7d150cdc 100644 --- a/src/content/Docs/other-resources/experimental/hardware-and-software-recommendations/index.md +++ b/src/content/Docs/other-resources/experimental/hardware-and-software-recommendations/index.md @@ -12,7 +12,7 @@ linkTitle: "Hardware and Software Recommendations" ### **Easy** -[**Praetor**](https://praetorapp.com/) **(Web based setup/Keplr wallet)** +[**Akash Provider Console**](https://provider-console.akash.network/) **(Web based setup/Keplr wallet)** Web based setup / Requires [Keplr](https://www.keplr.app/) wallet and uses SSH to install k3s From 49b384e715dea168632927a1b0fc6da92f70855a Mon Sep 17 00:00:00 2001 From: oiclid <1678413+oiclid@users.noreply.github.com> Date: Thu, 27 Feb 2025 10:56:48 +0100 Subject: [PATCH 10/10] added references to the change of name from 'praetor app' to 'provider console' where relevant --- src/content/Docs/index.mdx | 2 +- .../experimental/hardware-and-software-recommendations/index.md | 2 +- .../provider-console/provider-console/index.md | 2 +- .../build-a-cloud-provider/provider-console/what-is/index.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/content/Docs/index.mdx b/src/content/Docs/index.mdx index 68d31c75..f25ec845 100644 --- a/src/content/Docs/index.mdx +++ b/src/content/Docs/index.mdx @@ -96,7 +96,7 @@ import rocket from "./assets/providers/rocket.svg"; /> diff --git a/src/content/Docs/other-resources/experimental/hardware-and-software-recommendations/index.md b/src/content/Docs/other-resources/experimental/hardware-and-software-recommendations/index.md index 7d150cdc..a4937d9b 100644 --- a/src/content/Docs/other-resources/experimental/hardware-and-software-recommendations/index.md +++ b/src/content/Docs/other-resources/experimental/hardware-and-software-recommendations/index.md @@ -12,7 +12,7 @@ linkTitle: "Hardware and Software Recommendations" ### **Easy** -[**Akash Provider Console**](https://provider-console.akash.network/) **(Web based setup/Keplr wallet)** +[**Akash Provider Console (previously known as Praetor App)**](https://provider-console.akash.network/) **(Web based setup/Keplr wallet)** Web based setup / Requires [Keplr](https://www.keplr.app/) wallet and uses SSH to install k3s diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md index a945a241..47711b4c 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/provider-console/index.md @@ -6,7 +6,7 @@ title: "Creating an Akash Provider Using the Akash Console" linkTitle: " Building with Provider Console" --- -The Akash Provider Console is an easy way to become an Akash Provider. Being a provider allows individuals and organizations to rent out their unused computing resources. +The Akash Provider Console (previously known as Praetor App) is an easy way to become an Akash Provider. Being a provider allows individuals and organizations to rent out their unused computing resources. This guide will walk you through the process of setting up an **Akash Provider** using the Akash Provider Console. diff --git a/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md b/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md index a2028b3b..e3985540 100644 --- a/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md +++ b/src/content/Docs/providers/build-a-cloud-provider/provider-console/what-is/index.md @@ -8,7 +8,7 @@ linkTitle: "What is Provider Console?" # Provider Console -The **Provider Console** simplifies the process of becoming a cloud provider on the Akash Network. Instead of using a Command-line Interface, you can manage everything through our intuitive graphical interface. Once set up as a provider, deployers who select your services will compensate you in **AKT**. +The **Provider Console** (previously known as Praetor App) simplifies the process of becoming a cloud provider on the Akash Network. Instead of using a Command-line Interface, you can manage everything through our intuitive graphical interface. Once set up as a provider, deployers who select your services will compensate you in **AKT**. ## Features