Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luthermonson/go-proxmox
Go client with types and tests for the Proxmox-VE REST API
https://github.com/luthermonson/go-proxmox
api api-client go golang golang-package lxc-containers proxmox proxmox-apis proxmox-cluster proxmox-ve qemu
Last synced: 8 days ago
JSON representation
Go client with types and tests for the Proxmox-VE REST API
- Host: GitHub
- URL: https://github.com/luthermonson/go-proxmox
- Owner: luthermonson
- License: apache-2.0
- Created: 2021-06-11T21:24:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T16:28:37.000Z (20 days ago)
- Last Synced: 2024-10-25T23:12:11.084Z (19 days ago)
- Topics: api, api-client, go, golang, golang-package, lxc-containers, proxmox, proxmox-apis, proxmox-cluster, proxmox-ve, qemu
- Language: Go
- Homepage:
- Size: 361 KB
- Stars: 163
- Watchers: 8
- Forks: 49
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Proxmox API Client Go Package
[](https://github.com/luthermonson/go-proxmox/actions/workflows/ci.yaml) [](https://github.com/luthermonson/go-proxmox/blob/main/LICENSE)
[](https://github.com/luthermonson/go-proxmox/issues)
[](https://GitHub.com/luthermonson/go-proxmox/releases/) [](https://codecov.io/gh/luthermonson/go-proxmox) [](https://goreportcard.com/report/github.com/luthermonson/go-proxmox) [](https://pkg.go.dev/github.com/luthermonson/go-proxmox)
Join the community to discuss ongoing client development usage, the proxmox API or tooling in the [#go-proxmox](https://gophers.slack.com/archives/C05920LDDD3) channel on the Gophers Slack and see the [self generated docs](https://pkg.go.dev/github.com/luthermonson/go-proxmox) for more usage details.
[](https://gophers.slack.com/archives/C05920LDDD3)
A go client for [Proxmox VE](https://www.proxmox.com/). The client implements [/api2/json](https://pve.proxmox.com/pve-docs/api-viewer/index.html) and inspiration was drawn from the existing [Telmate](https://github.com/Telmate/proxmox-api-go/tree/master/proxmox) package but looking to improve in the following ways...
* Treated as a proper standalone go package
* Types and JSON marshal/unmarshalling for all end points
* Full Testing, unit testing with mocks and integration tests against an API endpoint
* Configuration options when creating a client for flexible usage
* Client logging for debugging within your code
* Context support
* Added functionality for better go tooling built on this library, some things we'd like
* Boot VM from qcow URL, inspiration: [Proxmox Linux Templates](https://www.phillipsj.net/posts/proxmox-linux-templates/)
* Dynamic host targeting for VM, Proxmox lacks a scheduler when given VM params it will try and locate a host with resources to put it
* cloud-init support via no-cloud ISOs uploaded to node data stores and auto-mounted before boot, inspiration [quiso](https://github.com/luthermonson/quiso)
* Unattended XML Support via ISOs similar to cloud-init ideas
* node/vm/container shell command support via KVM proxy already built into proxmox
Core developers are home lab enthusiasts working in the virtualization and kubernetes space. The common use case we have for
Proxmox is dev stress testing and validation of functionality in the products we work on, we plan to build the following tooling
around this library to make that easier.
* [Docker Machine Driver](https://github.com/luthermonson/docker-machine-driver-proxmox) for consumption by [Rancher](https://rancher.com/docs/rancher/v1.5/en/configuration/machine-drivers/)
* [Terminal UI](https://github.com/luthermonson/p9s) inspired by [k9s](https://github.com/derailed/k9s) for quick management of PVE Clusters
* [Terraform Provider](https://github.com/luthermonson/terraform-provider-proxmox) with better local-exec and cloud-init/unattend xml support
* [Cluster API Provider Proxmox](https://github.com/luthermonson/cluster-api-provider-proxmox) to create kubernetes clusters
## Usage
Create a client and use the public methods to access Proxmox resources.
### Basic usage with login with a username and password credential
```go
package main
import (
"context"
"fmt"
"github.com/luthermonson/go-proxmox"
)
func main() {
credentials := proxmox.Credentials{
Username: "root@pam",
Password: "12345",
}
client := proxmox.NewClient("https://localhost:8006/api2/json",
proxmox.WithCredentials(&credentials),
)
version, err := client.Version(context.Background())
if err != nil {
panic(err)
}
fmt.Println(version.Release) // 7.4
}
```
### Usage with Client Options
```go
package main
import (
"context"
"crypto/tls"
"fmt"
"net/http"
"github.com/luthermonson/go-proxmox"
)
func main() {
insecureHTTPClient := http.Client{
Transport: &http.Transport{
TLSClientConfig: &tls.Config{
InsecureSkipVerify: true,
},
},
}
tokenID := "root@pam!mytoken"
secret := "somegeneratedapitokenguidefromtheproxmoxui"
client := proxmox.NewClient("https://localhost:8006/api2/json",
proxmox.WithHTTPClient(&insecureHTTPClient),
proxmox.WithAPIToken(tokenID, secret),
)
version, err := client.Version(context.Background())
if err != nil {
panic(err)
}
fmt.Println(version.Release) // 6.3
}
```
# Developing
This project relies on [Mage](https://magefile.org/) for cross os/arch compatibility, please see their installation guide.
## Unit Testing
Run `mage test` to run the unit tests in the root directory.
## Integration Testing
To run the integration testing suite against an existing Proxmox API set some env vars in your shell before running `mage testIntegration`. The integration tests will test logging in and using an API token credentials so make sure you set all five env vars before running tests for them to pass.
Please leave no trace when developing integration tests. All tests should create and remove all testing data they generate then they can be repeatably run against the same proxmox environment. Most people working on this package will likely use their personal Proxmox VE home lab and consuming extra resources via tests will lead to frustration.
### Bash
```shell
export PROXMOX_URL="https://192.168.1.6:8006/api2/json"
export PROXMOX_USERNAME="root@pam"
export PROXMOX_PASSWORD="password"
export PROXMOX_TOKENID="root@pam!mytoken"
export PROXMOX_SECRET="somegeneratedapitokenguidefromtheproxmoxui"
mage test:integration
```
### Powershell
```powershell
$Env:PROXMOX_URL = "https://192.168.1.6:8006/api2/json"
$Env:PROXMOX_USERNAME = "root@pam"
$Env:PROXMOX_PASSWORD = "password"
$Env:PROXMOX_TOKENID = "root@pam!mytoken"
$Env:PROXMOX_SECRET = "somegeneratedapitokenguidefromtheproxmoxui"
mage test:integration
```