score-compose resources provisioners
resources provisioners of score-compose
2 minute read
score-compose comes with out-of-the-box support of the following provisioners, that you can list with this command score-compose provisioners list:
| Type | Class | Params | Output | Description |
|---|---|---|---|---|
amqp | (any) | (none) | host, password, port, username, vhost | Provisions a dedicated RabbitMQ vhost on a shared instance. |
dns | (any) | (none) | host | Outputs a *.localhost domain as the hostname. |
elasticsearch | (any) | (none) | host, password, port, username | Provisions a dedicated Elastic Search instance. |
kafka-topic | (any) | (none) | host, name, num_partitions, port | Provisions a dedicated Kafka topic on a shared Kafka broker. |
mongodb | (any) | (none) | connection, host, password, port, username | Provisions a dedicated MongoDB database. |
mssql | (any) | (none) | connection, database, password, port, server, username | Provisions a dedicated database on a shared MS SQL server instance. |
mysql | (any) | (none) | database, host, name, password, port, username | Provisions a dedicated MySQL database on a shared instance. |
postgres | (any) | (none) | database, host, name, password, port, username | Provisions a dedicated database on a shared PostgreSQL instance. |
redis | (any) | (none) | host, password, port, username | Provisions a dedicated Redis instance. |
route | (any) | host, path, port | Provisions a ingress route on a shared Nginx instance. | |
s3 | (any) | (none) | access_key_id, aws_access_key_id, aws_secret_key, bucket, endpoint, region, secret_key | Provisions a dedicated S3 bucket with AWS-style credentials on a shared MinIO instance. |
service-port | (any) | port, workload | hostname, port | Outputs a hostname and port for connecting to another workload. |
volume | (any) | (none) | source, type | Creates a persistent volume that can be mounted on a workload. |
The source code of these provisioners implementations can be found in the score-compose’s default provisioners file.
Users are encouraged to write their own custom provisioners to support new resource types or to modify the default implementations above. Learn how to do that with this example here.
A list of provisioners shared by the community can also be found here. Users are encouraged to use them and contribute to this growing list of provisioners.