Currently, you can operate Longhorn using Longhorn UI. We are planning to build a dedicated Longhorn CLI in the upcoming releases.

    In the meantime, you can access Longhorn API using Python binding, as we demonstrated below.

    1. Using Python Client

      1. import longhorn
      3. # If automation/scripting tool is inside the same cluster in which Longhorn is installed
      4. longhorn_url = 'http://longhorn-frontend.longhorn-system/v1'
      5. # If forwarding `longhorn-frontend` service to localhost
      6. longhorn_url = 'http://localhost:8080/v1'
      8. client = longhorn.Client(url=longhorn_url)
      10. # Volume operations
      11. # List all volumes
      13. # Get volume by NAME/ID
      14. # Attach TESTVOL1
      15. testvol1 = testvol1.attach(hostId="worker-1")
      16. # Detach TESTVOL1
      17. testvol1.detach()
      18. # Create a snapshot of TESTVOL1 with NAME
      19. snapshot1 = testvol1.snapshotCreate(name="snapshot1")
      20. # Create a backup from a snapshot NAME
      21. testvol1.snapshotBackup(name=snapshot1.name)
      22. # Update the number of replicas of TESTVOL1
      23. testvol1.updateReplicaCount(replicaCount=2)
      24. # Find more examples in Longhorn integration tests https://github.com/longhorn/longhorn-tests/tree/master/manager/integration/tests
      26. # Node operations
      28. # Get node by NAME/ID
      29. node1 = client.by_id_node(id="worker-1")
      30. # Disable scheduling for NODE1
      31. client.update(node1, allowScheduling=False)
      32. # Enable scheduling for NODE1
      33. client.update(node1, allowScheduling=True)
      34. # Find more examples in Longhorn integration tests https://github.com/longhorn/longhorn-tests/tree/master/manager/integration/tests
      36. # Setting operations
      37. # List all settings
      38. settings = client.list_setting()
      39. # Get setting by NAME/ID
      40. backupTargetsetting = client.by_id_setting(id="backup-target")
      41. # Update a setting
      42. # Find more examples in Longhorn integration tests https://github.com/longhorn/longhorn-tests/tree/master/manager/integration/tests