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.

Sign up for GitHub

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

Jump to bottom

edits to README.md #2

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

edits to README.md #2

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6929e5
edits to README.md
oiclid Jul 27, 2024
e0f8872
Update README.md
oiclid Jul 27, 2024
6af4978
Update README.md
oiclid Jul 27, 2024
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
68 changes: 34 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ Download and attach the latest AkashOS Release ISO to your chosen hardware: **Ba
- **Infinite Earnings:** Unlock unparalleled earning potential as a provider!
- **Versatile Application:** Compatible with various setups, ensuring everyone can join!

# What is this image best used for?
## What is this image best used for?

You can use this image to takeover any x86 machine or virtual machine that you want to configure as a provider on the Akash Network.

# Target audience for this ISO - you should be on this list
## Target audience for this ISO - you should be on this list

1. Hypervisor (Proxmox/VMware)
2. Homelab
3. Unraid/TrueNas
4. DevOps/SRE/Kubernetes Admins
5. Full stack developers

# Installation Difficulty Level
## Installation Difficulty Level

## Medium (terminal experience required)
### Medium (terminal experience required)

Human Dependencies: ~30 minutes

Expand All @@ -44,69 +44,69 @@ Human Dependencies: ~30 minutes

Software Dependencies: ~30 minutes

- Install Akash OS
- Install [AkashOS](https://github.com/cryptoandcoffee/akashos/releases)
- Configure Pricing


# Dependencies
## Dependencies

## Human Requirements
### Human Requirements
1. Be ready to run workloads for dWeb. Understand what you are getting into and be ready to learn.
2. Docker and Kubernetes experience will greatly help you, learn all you can.
3. With great power comes great responsibility. Be aware of the risks and use Lens to monitor your cluster.
4. If you experience any abuse, ddos, spam, or other issues please report the offending wallet address to the Akash team.
3. With great power comes great responsibility. Be aware of the risks and use [Lens](https://k8slens.dev/) to monitor your cluster.
4. If you experience any abuse, DDoS, spam, or other issues please report the offending wallet address to [Akash](https://discord.akash.network/).

## Software Requirements
### Software Requirements
1. Domain name (example.com) that you own and can manage DNS records.
2. 50 AKT to send to new provider wallet
3. Access to your firewall/router for port forwarding
4. [Lens](https://k8slens.dev/) - Recommend for cluster daily ops - you will need this to easily interact with your new cluster
5. [Balena Etcher](https://www.balena.io/etcher/), [Rufus](https://rufus.ie/), or [Ventoy](https://www.ventoy.net/en/index.html) for creating bootable USB drives on Linux, Mac, PC.
6. Dynamic DNS update client and domain for residential IP's.
6. Dynamic DNS update client and domain for residential IPs.

## Hardware Requirements First Node
### Hardware Requirements First Node

- 2 CPU / 4 Threads
- 8Gb Memory
- 64Gb Disk

## Hardware Requirements Additional Nodes
### Hardware Requirements Additional Nodes

- 1 CPU
- 2Gb Memory
- 8Gb Disk

## Proxmox / VirtualBox / VMware
### Proxmox / VirtualBox / VMware

1. Download Akash OS ISO
1. Download the [AkashOS ISO](https://github.com/cryptoandcoffee/akashos/releases).
2. Create VM - Attach a disk drive with the ISO
3. Start the VM
4. Reboot when install completed and detach the ISO.
6. Login with default username and password "akash", follow the on-screen instructions.
7. Once the system has rebooted, goto the Control Panel address.
8. Update the provider attributes with the recommended values and click Save.
9. Click STOP next to Provider.
10. Click Re-Deploy Provider Button.
11. Send at least 5 AKT to the new wallet address to start the provider.
12. Click Download Kubeconfig and import into Lens. When first using Lens be sure to set the Namespace to : All or you won't see anything.
5. Login with default username and password "akash", follow the on-screen instructions.
6. Once the system has rebooted, goto the Control Panel address.
7. Update the provider attributes with the recommended values and click Save.
8. Click STOP next to Provider.
9. Click Re-Deploy Provider Button.
10. Send at least 5 AKT to the new wallet address to start the provider.
11. Click Download Kubeconfig and import into Lens. When first using Lens be sure to set the Namespace to : All or you won't see anything.

## Bare Metal Datacenter with IPMI/ISO Support
### Bare Metal Datacenter with IPMI/ISO Support

1. Download Akash OS ISO
1. Download the [AkashOS ISO](https://github.com/cryptoandcoffee/akashos/releases).
2. Upload the ISO to the datacenter ISO storage location (Vultr/HostHatch/etc) or Attach the ISO to your IPMI Virtual Console Session.
3. Start the machine with the ISO for the boot drive (F11 may be required)
4. Reboot when install completed and detach the ISO.
6. Login with default username and password "akash", follow the on-screen instructions.
7. Once the system has rebooted, goto the Control Panel address.
8. Update the provider attributes with the recommended values and click Save.
9. Click STOP next to Provider.
10. Click Re-Deploy Provider Button.
11. Send at least 5 AKT to the new wallet address to start the provider.
12. Click Download Kubeconfig and import into Lens. When first using Lens be sure to set the Namespace to : All or you won't see anything.
5. Login with default username and password "akash", follow the on-screen instructions.
6. Once the system has rebooted, goto the Control Panel address.
7. Update the provider attributes with the recommended values and click Save.
8. Click STOP next to Provider.
9. Click Re-Deploy Provider Button.
10. Send at least 5 AKT to the new wallet address to start the provider.
11. Click Download Kubeconfig and import into Lens. When first using Lens be sure to set the Namespace to : All or you won't see anything.

## USB Key
### USB Key

1. Download Akash OS ISO
1. Download the [AkashOS ISO](https://github.com/cryptoandcoffee/akashos/releases).
2. Use Balena Etcher / Rufus / Ventoy to write the ISO to a USB key
3. Insert the USB key into the computer you want to make an Akash provider.
4. Start the machine with the USB key for the boot drive (F11 may be required)
Expand All @@ -119,7 +119,7 @@ Software Dependencies: ~30 minutes
11. Send at least 5 AKT to the new wallet address to start the provider.
12. Click Download Kubeconfig and import into Lens. When first using Lens be sure to set the Namespace to : All or you won't see anything.

Todos:
### Todos:
-When changing pricing params, delete the configmap akash-provider-bidscripts from akash-services before re-deploy
-Remove static/dynamic question during initial boot, confusing to user
-Show nodes in cluster on Dashboard with kubectl get nodes -A -o wide
Expand Down