NetBook
  • The Basics
    • About
      • 🧑‍🤝‍🧑Community
    • 🔰Getting Started
      • 🤟Introduction
    • 🛒Components
      • ⚒️WorkFlow
      • 👨‍🏫Projects
      • 🟩Dashboard
      • 🌐Workspaces
        • Overview
        • Quickstart
      • ⛏️Experiments
        • Setting Up your Code
        • Creating Training Docker Image
        • Training Data Setup
        • Start a New Training Job on NetBook UI
      • 🖥️Compute Backends
        • Add your Kubernetes Clusters
          • Create Kubernetes Cluster on E2E Nodes
          • Creating Kubernetes Cluster on Bare Metal Servers
      • 🧑‍💻Environments
        • Overview
        • Quickstart
    • 💳Accounts
      • 🌥️Bring your own Cloud
        • Azure
          • Setup in your Azure
          • Adding Credentials to Netbook Portal
        • AWS
          • Setup in your AWS account
          • Adding Credentials to NetBook Portal
    • 💵Billing
    • 🔧Settings
  • Api Docs
    • Api documentation
  • Issues and resolutions
    • Slack Support
  • Release Notes
    • Version 0
  • OpenSource
    • Docs
      • Spawner
        • reference
          • Cluster
          • Nodes
        • Setup
        • Usage examples
        • Issues and Troubleshooting
Powered by GitBook
On this page
  1. OpenSource
  2. Docs
  3. Spawner

Setup

Installation and getting start

PreviousNodesNextUsage examples

Last updated 3 years ago

  • Clone the repository

    git clone

  • Spawner comes with 2 components

    • spawner-service - gRPC service to manage cloud provider infra

    • spawner - command line interface to interact with service

  • Starting the Spawner-Service

    • You need to start spawner-service in your server/laptop to interact with your cloud provider. To start the service

      • update with the cloud provider credentials, gRPC ports.

      Note: To get Credentials for your and , you can refer to the links

      • Start the service by running the below command in the spawner folder

        • make run

        Note: If you edit your config.env file, make sure you re run the service to update the service

    Note: Keep this terminal active and running for spawner-cli to interact with

  • Using Spawner-Cli

    • Open a new terminal and run make build-client

    • This will setup a spawner executable in the folder

    • Copy this to your PATH or use it with the relative execution path or use ./spawner as per your convenience.

  • To use spawner-cli refer to

https://github.com/NetBook-ai/spawner.git
config.env
AWS account
AZURE account
Usage Examples