Skip to content

Latest commit

 

History

History
132 lines (94 loc) · 3.45 KB

README.md

File metadata and controls

132 lines (94 loc) · 3.45 KB

Go Report Card

plow

Plow is an Ajax friendly Helm Tiller proxy using grpc-gateway. It was previously called Wheel.

API Reference

  • Tiller Version
GET http://127.0.0.1:9855/tiller/v2/version/json
  • Summarize releases

GET http://127.0.0.1:9855/tiller/v2/releases/json
GET http://127.0.0.1:9855/tiller/v2/releases/json?status_codes=DEPLOYED&&status_codes=DELETED

Available query parameters:
  sort_by=NAME|LAST_RELEASED
  all=true|false
  sort_order=ASC|DESC
  status_codes=UNKNOWN, DEPLOYED, DELETED, SUPERSEDED, FAILED, DELETING
  • Release status
GET http://127.0.0.1:9855/tiller/v2/releases/my-release/status/json
  • Release content

GET http://127.0.0.1:9855/tiller/v2/releases/my-release/content/json
GET http://127.0.0.1:9855/tiller/v2/releases/my-release/content/json?format_values_as_json=true
  • Release history
GET http://127.0.0.1:9855/tiller/v2/releases/my-release/json
  • Rollback release
GET http://127.0.0.1:9855/tiller/v2/releases/my-release/rollback/json
  • Install release from url
POST http://127.0.0.1:9855/tiller/v2/releases/my-release/json

{
	"chart_url": "https://github.com/tamalsaha/test-chart/raw/master/test-chart-0.1.0.tgz",
	"values": {
		"raw": "{\"ns\":\"c10\",\"clusterName\":\"h505\"}"
	}
}
  • Install release from stable kubeapps (most recent version)
POST http://127.0.0.1:9855/tiller/v2/releases/my-release/json

{
	"chart_url": "stable/fluent-bit"
}
  • Install release from stable kubeapps (specific version)
POST http://127.0.0.1:9855/tiller/v2/releases/my-release/json

{
	"chart_url": "stable/fluent-bit/0.1.2"
}
  • Update release
PUT http://127.0.0.1:9855/tiller/v2/releases/my-release/json

{
	"chart_url": "https://github.com/tamalsaha/test-chart/raw/master/test-chart-0.1.0.tgz",
	"values": {
		"raw": "{\"ns\":\"c15\",\"clusterName\":\"h505\"}"
	}
}
  • Uninstall release
DELETE http://127.0.0.1:9855/tiller/v2/releases/my-release/json
  • Uninstall & purge release
DELETE http://127.0.0.1:9855/tiller/v2/releases/my-release/json?purge=true

Supported Versions

Kubernetes 1.5+ . Helm Tiller server checks for version compatibility. Please pick a version of Plow that matches your Tiller server.

Plow Version Helm/Tiller Version
0.2.0 2.5.x, 2.6.x
0.1.0 2.5.x, 2.6.x

Installation

To install Plow, please follow the guide here.

Contribution guidelines

Want to help improve Plow? Please start here.

The plow server collects anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag --analytics=false.

Support

If you have any questions, you can reach out to us.