Skip to content

Latest commit

 

History

History
 
 

client

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
client.go
client.go
 
 
common.go
common.go
 
 
generated_activate_input.go
generated_activate_input.go
 
 
generated_api_version.go
generated_api_version.go
 
 
generated_attach_input.go
generated_attach_input.go
 
 
generated_attachment.go
generated_attachment.go
 
 
generated_backing_image.go
generated_backing_image.go
 
 
generated_backing_image_cleanup_input.go
generated_backing_image_cleanup_input.go
 
 
generated_backing_image_disk_file_status.go
generated_backing_image_disk_file_status.go
 
 
generated_backing_image_restore_input.go
generated_backing_image_restore_input.go
 
 
generated_backup.go
generated_backup.go
 
 
generated_backup_backing_image.go
generated_backup_backing_image.go
 
 
generated_backup_input.go
generated_backup_input.go
 
 
generated_backup_list_output.go
generated_backup_list_output.go
 
 
generated_backup_status.go
generated_backup_status.go
 
 
generated_backup_target.go
generated_backup_target.go
 
 
generated_backup_volume.go
generated_backup_volume.go
 
 
generated_client.go
generated_client.go
 
 
generated_clone_status.go
generated_clone_status.go
 
 
generated_controller.go
generated_controller.go
 
 
generated_detach_input.go
generated_detach_input.go
 
 
generated_disk_condition.go
generated_disk_condition.go
 
 
generated_disk_info.go
generated_disk_info.go
 
 
generated_disk_update.go
generated_disk_update.go
 
 
generated_disk_update_input.go
generated_disk_update_input.go
 
 
generated_empty.go
generated_empty.go
 
 
generated_engine_image.go
generated_engine_image.go
 
 
generated_engine_upgrade_input.go
generated_engine_upgrade_input.go
 
 
generated_error.go
generated_error.go
 
 
generated_expand_input.go
generated_expand_input.go
 
 
generated_instance_manager.go
generated_instance_manager.go
 
 
generated_kubernetes_status.go
generated_kubernetes_status.go
 
 
generated_longhorn_condition.go
generated_longhorn_condition.go
 
 
generated_node.go
generated_node.go
 
 
generated_node_condition.go
generated_node_condition.go
 
 
generated_orphan.go
generated_orphan.go
 
 
generated_purge_status.go
generated_purge_status.go
 
 
generated_pvccreate_input.go
generated_pvccreate_input.go
 
 
generated_pvcreate_input.go
generated_pvcreate_input.go
 
 
generated_rebuild_status.go
generated_rebuild_status.go
 
 
generated_recurring_job.go
generated_recurring_job.go
 
 
generated_replica.go
generated_replica.go
 
 
generated_replica_remove_input.go
generated_replica_remove_input.go
 
 
generated_restore_status.go
generated_restore_status.go
 
 
generated_salvage_input.go
generated_salvage_input.go
 
 
generated_setting.go
generated_setting.go
 
 
generated_setting_definition.go
generated_setting_definition.go
 
 
generated_snapshot.go
generated_snapshot.go
 
 
generated_snapshot_cr.go
generated_snapshot_cr.go
 
 
generated_snapshot_crinput.go
generated_snapshot_crinput.go
 
 
generated_snapshot_crlist_output.go
generated_snapshot_crlist_output.go
 
 
generated_snapshot_input.go
generated_snapshot_input.go
 
 
generated_snapshot_list_output.go
generated_snapshot_list_output.go
 
 
generated_support_bundle.go
generated_support_bundle.go
 
 
generated_support_bundle_initate_input.go
generated_support_bundle_initate_input.go
 
 
generated_system_backup.go
generated_system_backup.go
 
 
generated_system_restore.go
generated_system_restore.go
 
 
generated_tag.go
generated_tag.go
 
 
generated_update_access_mode_input.go
generated_update_access_mode_input.go
 
 
generated_update_backup_compression_input.go
generated_update_backup_compression_input.go
 
 
generated_update_data_locality_input.go
generated_update_data_locality_input.go
 
 
generated_update_freeze_fsfor_snapshot_input.go
generated_update_freeze_fsfor_snapshot_input.go
 
 
generated_update_min_number_of_copies_input.go
generated_update_min_number_of_copies_input.go
 
 
generated_update_replica_auto_balance_input.go
generated_update_replica_auto_balance_input.go
 
 
generated_update_replica_count_input.go
generated_update_replica_count_input.go
 
 
generated_update_replica_disk_soft_anti_affinity_input.go
generated_update_replica_disk_soft_anti_affinity_input.go
 
 
generated_update_replica_soft_anti_affinity_input.go
generated_update_replica_soft_anti_affinity_input.go
 
 
generated_update_replica_zone_soft_anti_affinity_input.go
generated_update_replica_zone_soft_anti_affinity_input.go
 
 
generated_update_snapshot_data_integrity_input.go
generated_update_snapshot_data_integrity_input.go
 
 
generated_update_snapshot_max_count_input.go
generated_update_snapshot_max_count_input.go
 
 
generated_update_snapshot_max_size_input.go
generated_update_snapshot_max_size_input.go
 
 
generated_update_unmap_mark_snap_chain_removed_input.go
generated_update_unmap_mark_snap_chain_removed_input.go
 
 
generated_volume.go
generated_volume.go
 
 
generated_volume_attachment.go
generated_volume_attachment.go
 
 
generated_volume_condition.go
generated_volume_condition.go
 
 
generated_volume_recurring_job.go
generated_volume_recurring_job.go
 
 
generated_volume_recurring_job_input.go
generated_volume_recurring_job_input.go
 
 
generated_workload_status.go
generated_workload_status.go
 
 
schemas.go
schemas.go
 
 
types.go
types.go
 
 

README.md

Longhorn API client

The code in this package is generated by rancher/go-rancher. But in order to fix some compatibility issues, you must use the longhorn-v1 branch of this repo instead.

Generate code in go-rancher

The version of go-rancher we use does not have Go module support. It must be cloned onto the correct location on the GOPATH and the Go tools must be executed with GO111MODULE=off. This might be unusual for developers used to working with modern Go.

  1. Run longhorn-manager. There may be an easier way, but generally, this means deploy Longhorn to a cluster using a development version of the longhorn-manager container.
  2. Expose the longhorn-manager API. If running in a cluster, change the spec.type of the longhorn-backend service from ClusterIP to NodePort. The IP is the IP of any node and the port is given by spec.ports.nodePort.
  3. Clone go-rancher to the correct location on your GOPATH and check out the correct branch.
cd $GOPATH/src/github.com/niusmallnan/
git clone https://github.com/niusmallnan/go-rancher
cd go-rancher
git checkout longhorn-v1
  1. Get dependencies.
GO111MODULE=off go get
  1. Generate code.
GO111MODULE=off scripts/generate-longhorn-schemas.sh http://<ip>:<port>

Copy code to longhorn-manager

  1. Copy the client to your project directory.
cp $GOPATH/src/github.com/niusmallnan/go-rancher/longhorn/*.go <project_directory>/client/
  1. Correct the package name.
cd <project_directory>/client
sed -i -e 's/package longhorn/package client/g' *.go
  1. Check the git diff. There are likely unrelated changes you did not intend. For now, just revert any changes that don't appear to be directly related to your work. Maybe we can make the process more idempotent in the future.

Notes:

The generator currently no longer generates actions, so you need to ensure not to overwrite the ActionUpdateAccessMode in generated_volume.go. I currently don't have the time to look into this and since we are planning on reworking the api down the line, this is a low priority issue for now.