From 8283397d689260b0813bebbd89d31a7011a3a598 Mon Sep 17 00:00:00 2001 From: Ben Meier Date: Thu, 27 Jun 2024 23:19:19 +0100 Subject: [PATCH] chore: update readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 009d55b..906462c 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,21 @@ Generally, users will want to copy in the provisioners files that work with thei For details of how the standard "template" provisioner works, see the `template://example-provisioners/example-provisioner` provisioner [here](internal/provisioners/default/zz-default.provisioners.yaml). For details of how the standard "cmd" provisioner works, see the `cmd://bash#example-provisioner` provisioner [here](internal/provisioners/default/zz-default.provisioners.yaml). +## Provisioner support + +`score-k8s` comes with out-of-the-box support for: + +| Type | Class | Params | Output | +| ------------- | ------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| volume | default | (none) | `source` | +| redis | default | (none) | `host`, `port`, `username`, `password` | +| postgres | default | (none) | `host`, `port`, `name` (aka `database`), `username`, `password` | +| mysql | default | (none) | `host`, `port`, `name` (aka `database`), `username`, `password` | +| dns | default | (none) | `host` | +| route | default | `host`, `path`, `port` | | + +Users are encouraged to write their own custom provisioners to support new resource types or to modify the implementations above. + ## Usage ### Installation