Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

further provider docs edits #551

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 61 additions & 69 deletions src/content/Docs/_sequence.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,43 +45,84 @@ export const docsSequence = [
{
label: "Akash Console",
},
{ label: "Sandbox", subItems: [{ label: "Sandbox Introduction" }] },
{ label: "Stable Payment Deployments" },
],
},
{
label: "Providers",
subItems: [
{ label: "Provider Overview"},
{
label: "Praetor App",
label: "Build A Cloud Provider",
subItems: [
{ label: "What is Praetor App?" },
{
label: "Akash Provider",
{ label: "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: "Building with Provider Console"},
{ label: "How to Enable Root Sign-in"},
],
},
],
},
{
label: "Provider Console",
subItems: [
{ label: "How to Enable Root Sign-in"},
{ label: "Provider Console"},
],

},
{ label: "Sandbox", subItems: [{ label: "Sandbox Introduction" }] },
{ label: "Stable Payment Deployments" },
{ label: "Akash Provider FAQ and Guide" },
{ label: "Community Solutions" },
{ label: "Custom Kubernetes Cluster Settings" },
],
},
{
label: "Guides",

subItems: [
{ label: "Guides Overview"},
{
label: "Machine Learning",
subItems: [
{ label: "OneClickLLM" },
{ label: "DeTrain" },
{ label: "Ray" },
{ label: "FLock.io" },
Expand Down Expand Up @@ -239,56 +280,7 @@ export const docsSequence = [
}
],
},
{
label: "Providers",
subItems: [
{
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: "Akash Provider FAQ and Guide" },
{ label: "Community Solutions" },
{ label: "Custom Kubernetes Cluster Settings" },
],
},


{
label: "Akash Nodes",
Expand Down
38 changes: 38 additions & 0 deletions src/content/Docs/guides/introduction/index.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 3 additions & 3 deletions src/content/Docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
/>
<Card
title="Build a Cloud Provider with Praetor App"
description="Praetor App provides an easy way to become a cloud provider for Akash Network. You can become a provider using a simplified UI rather than Command-line Interface. Once you become a cloud provider, and if the deployers choose your provider to deploy their application, they pay you in AKT."
title="Build a Cloud Provider with Akash Provider Console"
description="Provider Console (formerlly Praetor App) provides an easy way to become a cloud provider for Akash Network. You can become a provider using a simplified UI rather than Command-line Interface. Once you become a cloud provider, and if the deployers choose your provider to deploy their application, they pay you in AKT."
icon={praetor}
link="/docs/deployments/praetor-app/what-is"
link="/docs/providers/build-a-cloud-provider/provider-console/what-is"
/>
<Card
title="Akash Provider FAQ and Guide "
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ provider.yourdomain.com
#### Example DNS Configuration

![](../../../assets/namecheapCapture.png)
![](../../../../assets/namecheapCapture.png)

## Step 6 - Hostname Operator Build

Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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)


---
Expand All @@ -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)



Expand All @@ -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.

Expand Down Expand Up @@ -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)



Expand All @@ -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.

Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
categories: ["Provider Console"]
tags: []
weight: 2
weight: 1
title: "How to Enable Root Sign-in to Provider Console"
linkTitle: "How to Enable Root Sign-in"
---
Expand Down
Loading