Python Client

    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. Get Longhorn endpoint

      One way to communicate with Longhorn is through longhorn-frontend service.

      If you run your automation/scripting tool inside the same cluster in which Longhorn is installed, connect to the endpoint http://longhorn-frontend.longhorn-system/v1

      If you run your automation/scripting tool on your local machine, use kubectl port-forward to forward the longhorn-frontend service to localhost:

      1. kubectl port-forward services/longhorn-frontend 8080:http -n longhorn-system

      and connect to endpoint http://localhost:8080/v1

    2. Using Python Client

      Import file longhorn.py which contains the Python client into your Python script and create a client from the endpoint:

      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
      12. volumes = client.list_volume()
      13. # Get volume by NAME/ID
      14. testvol1 = client.by_id_volume(id="testvol1")
      15. # Attach TESTVOL1
      16. testvol1 = testvol1.attach(hostId="worker-1")
      17. # Detach TESTVOL1
      18. testvol1.detach()
      19. # Create a snapshot of TESTVOL1 with NAME
      20. snapshot1 = testvol1.snapshotCreate(name="snapshot1")
      21. # Create a backup from a snapshot NAME
      22. testvol1.snapshotBackup(name=snapshot1.name)
      23. # Update the number of replicas of TESTVOL1
      24. testvol1.updateReplicaCount(replicaCount=2)
      25. # Find more examples in Longhorn integration tests https://github.com/longhorn/longhorn-tests/tree/master/manager/integration/tests
      27. # Node operations
      28. # List all nodes
      29. nodes = client.list_node()
      30. # Get node by NAME/ID
      31. node1 = client.by_id_node(id="worker-1")
      32. # Disable scheduling for NODE1
      33. client.update(node1, allowScheduling=False)
      34. # Enable scheduling for NODE1
      35. client.update(node1, allowScheduling=True)
      36. # Find more examples in Longhorn integration tests https://github.com/longhorn/longhorn-tests/tree/master/manager/integration/tests
      38. # Setting operations
      39. # List all settings
      40. settings = client.list_setting()
      41. # Get setting by NAME/ID
      42. backupTargetsetting = client.by_id_setting(id="backup-target")
      43. # Update a setting
      44. backupTargetsetting = client.update(backupTargetsetting, value="s3://backupbucket@us-east-1/")
      45. # Find more examples in Longhorn integration tests https://github.com/longhorn/longhorn-tests/tree/master/manager/integration/tests