Skip to content
This repository was archived by the owner on Apr 13, 2020. It is now read-only.

Commit 8bd0510

Browse files
authored
[DESIGN] added file format support (#390)
1 parent b855515 commit 8bd0510

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

technical-docs/designs/infra/scaffoldVariables.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ Reference: Introspection - An option to take variables in SPK scaffold
44
command<br> Authors: Andre Briggs, Yvonne Radsmikham, Nathaniel Rose, Dennis
55
Seah
66

7-
| Revision | Date | Author | Remarks |
8-
| -------: | ------------ | ----------- | ------------------------------------------------- |
9-
| 0.1 | Mar-07, 2020 | Dennis Seah | Initial Draft |
10-
| 0.2 | Mar-09, 2020 | Dennis Seah | Incorporated comments from Nate, Yvonne and Andre |
7+
| Revision | Date | Author | Remarks |
8+
| -------: | ------------ | ----------- | ------------------------------------------------------ |
9+
| 0.1 | Mar-07, 2020 | Dennis Seah | Initial Draft |
10+
| 0.2 | Mar-09, 2020 | Dennis Seah | Incorporated comments from Nate, Yvonne and Andre |
11+
| 1.0 | Mar-11, 2020 | Dennis Seah | Added information on support YAML and JSON file format |
1112

1213
## 1. Overview
1314

@@ -34,13 +35,25 @@ has 4 options (`--name`, `--source`, `--version` and `--template`). We shall
3435
introduce a new option `-f`, `--file` which allows user to specify a file that
3536
contains values for these variables.
3637

37-
The format of this file is `key=value`. E.g.
38+
The format of the file can be YAML or JSON. The command line tool will detect
39+
the format automatically. Example of YAML file is
3840

3941
```
40-
address_space=10.10.0.0/16
41-
agent_vm_count=4
42-
agent_vm_size=Standard_D2s_v3
43-
cluster_name=discovery-service-west
42+
address_space: 10.10.0.0/16
43+
agent_vm_count: 4
44+
agent_vm_size: Standard_D2s_v3
45+
cluster_name: discovery-service-west
46+
```
47+
48+
And example of JSON file is
49+
50+
```
51+
{
52+
"address_space": "10.10.0.0/16",
53+
"agent_vm_count": 4,
54+
"agent_vm_size": "Standard_D2s_v3",
55+
"cluster_name": "discovery-service-west"
56+
}
4457
```
4558

4659
leading and trailing spaces should be trimmed. E.g. `address_space=10.10.0.0/16`

0 commit comments

Comments
 (0)