Skip to content

Commit 3ff7963

Browse files
chore: adding score-compose provisioners command in cli (#161)
2 parents 171b2ab + 1da0254 commit 3ff7963

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

content/en/docs/score implementation/score-compose/cli.md

+39-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ Specifies the location to store sample `.env` file.
202202
score-compose run -f ./score.yaml -o ./compose.yaml --env-file ./backend.env
203203
```
204204

205-
#### `--file` | `f`
205+
#### `--file` | `-f`
206206

207207
Specifies the path to the Score file. Uses `./score.yaml` as a default value if the flag isn't specified.
208208

@@ -286,6 +286,44 @@ Increases log verbosity and detail by specifying this flag one or more times.
286286
score-compose resources --verbose
287287
```
288288

289+
## `provisioners`
290+
291+
The `provisioners` command provides subcommand related to provisioners in `score-compose`
292+
293+
```bash
294+
score-compose provisioners [command]
295+
```
296+
297+
### Subcommands
298+
299+
#### `list`
300+
301+
List available `provisioners`
302+
303+
```bash
304+
score-compose provisioners list [flags]
305+
```
306+
307+
##### Flags
308+
309+
###### --format | -f
310+
311+
Display listed provisioners in the format provided. Uses `table` as default value. Allowed values: `table`, `json`
312+
313+
```bash
314+
score-compose provisioners list --fornat json
315+
```
316+
317+
### Flags
318+
319+
#### `--help` | `-h`
320+
321+
Displays help information for the `provisioners` command, including its available subcommands.
322+
323+
```bash
324+
score-compose provisioners --help
325+
```
326+
289327
## `help`
290328

291329
The help command provides information on all commands.

content/en/docs/score implementation/score-compose/resources-provisioners.md

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ aliases:
2727
| `service-port` | (any) | `workload`, `port` | `hostname`, `port` |
2828
| `s3` | (any) | (none) | `endpoint`, `access_key_id`, `secret_key`, `bucket`, with `region=""`, `aws_access_key_id=<access_key_id>`, and `aws_secret_key=<secret_key>` for compatibility |
2929
| `volume` | (any) | (none) | `source` |
30+
| mssql | (any) | (none) | `server`, `port`, `connection`, `database`, `username`, `password` |
3031

3132
These can be found in the default provisioners file. You are encouraged to write your own provisioners and add them to the `.score-compose` directory (with the `.provisioners.yaml` extension) or contribute them upstream to the [default.provisioners.yaml](https://github.com/score-spec/score-compose/blob/main/internal/command/default.provisioners.yaml) file.
3233

0 commit comments

Comments
 (0)