Provider Playbook Script

The Provider Playbook Script is an automated solution for setting up and configuring Akash providers. It uses Ansible playbooks to streamline the deployment process, making it easier to set up and manage provider infrastructure. The script follows the same principles and configurations as the Akash CLI provider setup, automating many of the manual steps involved in the process.

Table of Contents

• Features
• Prerequisites
• Quick Start
• Related Documentation
• Advanced Usage
  • Customizing the Playbook
• Troubleshooting
• Support
• Contributing

Source Code: The Provider Playbook Script is open source and available on GitHub. Contributions and feedback are welcome!

Features

• Automated Kubernetes Setup: Deploys and configures a Kubernetes cluster optimized for Akash provider operations
• GPU Support: Automatically detects and configures GPU resources
• Storage Solutions: Configures storage options including NVMe and SSD support
• Standardized Deployment: Ensures consistent and repeatable provider deployments
• Infrastructure as Code: All configurations are managed through code for easy versioning and updates

Prerequisites

Before using the Provider Playbook Script, ensure you have:

• A server or VM with the following minimum specifications:

  • 4 CPUs
  • 8 GB RAM
  • 50 GB Disk

  Note: This server will become your Akash provider node.

• Root access to the server:

  Note: Root access is required to install and configure system-level components like Kubernetes and other dependencies.

• SSH access to the server:

  Note: You’ll need to be able to connect to your server via SSH. The playbook script will help you set up SSH keys and configure access. This is necessary for the script to remotely configure your server.

  For more information about SSH, see What is SSH? from Cloudflare.

• An Akash wallet with at least 5 AKT for provider registration:

  Note: The 5 AKT minimum is required for provider registration on the Akash network.

  We recommend:

  • Having at least 10-15 AKT in your provider wallet to cover:
    • Provider registration fees
    • Transaction fees for operations
    • Buffer for unexpected costs
  • Keeping additional AKT available for:
    • Bidding on deployments
    • Handling provider operations
    • Emergency situations

  For more information on wallet setup and funding, see our Wallet Setup Guide.

Quick Start

1. Clone the provider playbooks repository:

   git clone https://github.com/akash-network/provider-playbooks.git
   cd provider-playbooks

2. Run the setup script:

   ./scripts/setup_provider.sh

3. Follow the interactive prompts to configure your provider.

Related Documentation

For more detailed information about specific provider features and configurations, refer to the following Akash CLI documentation:

• Kubernetes Cluster Setup
• GPU Resource Enablement
• Persistent Storage Enablement
• IP Leases Enablement
• Provider Attribute Updates

Advanced Usage

Customizing the Playbook

You can customize the playbook by editing the following files:

• inventory.yml: Configure your server details
• group_vars/all.yml: Set global variables
• roles/*: Modify specific role configurations

Troubleshooting

Common issues and solutions:

• Kubernetes Cluster Issues

  • Check system resources
  • Verify network connectivity
  • Review Kubernetes logs

• Storage Configuration Problems

  • Verify device names
  • Check storage class configurations
  • Review storage provider logs

• Provider Registration Issues

  • Verify wallet balance
  • Check network connectivity
  • Review provider logs

Support

For support and questions:

• Join the Akash Discord
• Check the GitHub Issues
• Review the Akash Documentation

Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Submit a pull request

See CONTRIBUTING.md for more details.