Cleanup up files with prettier

tinkerbell · Jun 4, 2020 · 0da5f5b · 0da5f5b
1 parent 90580f4
commit 0da5f5b
Show file tree

Hide file tree

Showing 15 changed files with 273 additions and 239 deletions.
diff --git a/README.md b/README.md
@@ -9,35 +9,36 @@ The CLI is used to create a workflow along with its building blocks, templates a
 # Packet Workflow
 
 A Packet Workflow is an open-source microservice that’s responsible for handling flexible, bare metal provisioning workflows, that is...
- - standalone and does not need the Packet API to function
- - contains `Boots`, `Tinkerbell`, `Osie`, and workers
- - can bootstrap any remote worker using `Boots + Osie`
- - can run any set of actions as Docker container runtimes
- - receive, manipulate, and save runtime data
+
+-   standalone and does not need the Packet API to function
+-   contains `Boots`, `Tinkerbell`, `Osie`, and workers
+-   can bootstrap any remote worker using `Boots + Osie`
+-   can run any set of actions as Docker container runtimes
+-   receive, manipulate, and save runtime data
 
 ## Content
 
- - [Setup](docs/setup.md)
- - [Components](docs/components.md)
-   - [Boots](docs/components.md#boots)
-   - [Osie](docs/components.md#osie)
-   - [Tinkerbell](docs/components.md#tinkerbell)
-   - [Hegel](docs/components.md#hegel)
-   - [Database](docs/components.md#database)
-   - [Image Registry](docs/components.md#registry)
-   - [Elasticsearch](docs/components.md#elastic)
-   - [Fluent Bit](docs/components.md#fluent-bit)
-   - [Kibana](docs/components.md#kibana)
- - [Architecture](docs/architecture.md)
- - [Say "Hello-World!" with a Workflow](docs/hello-world.md)
- - [Concepts](docs/concepts.md)
-   - [Template](docs/concepts.md#template)
-   - [Provisioner](docs/concepts.md#provisioner)
-   - [Worker](docs/concepts.md#worker)
-   - [Ephemeral Data](docs/concepts.md#ephemeral-data)
- - [Writing a Workflow](docs/writing-workflow.md)
- - [Tinkerbell CLI Reference](docs/cli/README.md)
- - [Troubleshooting](docs/troubleshoot.md)
+-   [Setup](docs/setup.md)
+-   [Components](docs/components.md)
+    -   [Boots](docs/components.md#boots)
+    -   [Osie](docs/components.md#osie)
+    -   [Tinkerbell](docs/components.md#tinkerbell)
+    -   [Hegel](docs/components.md#hegel)
+    -   [Database](docs/components.md#database)
+    -   [Image Registry](docs/components.md#registry)
+    -   [Elasticsearch](docs/components.md#elastic)
+    -   [Fluent Bit](docs/components.md#fluent-bit)
+    -   [Kibana](docs/components.md#kibana)
+-   [Architecture](docs/architecture.md)
+-   [Say "Hello-World!" with a Workflow](docs/hello-world.md)
+-   [Concepts](docs/concepts.md)
+    -   [Template](docs/concepts.md#template)
+    -   [Provisioner](docs/concepts.md#provisioner)
+    -   [Worker](docs/concepts.md#worker)
+    -   [Ephemeral Data](docs/concepts.md#ephemeral-data)
+-   [Writing a Workflow](docs/writing-workflow.md)
+-   [Tinkerbell CLI Reference](docs/cli/README.md)
+-   [Troubleshooting](docs/troubleshoot.md)
 
 ## Website
 

diff --git a/deploy/docker-compose.yml b/deploy/docker-compose.yml
@@ -1,4 +1,4 @@
-version: '2.1'
+version: "2.1"
 services:
   certs:
     build: tls
@@ -53,11 +53,11 @@ services:
       - 5432:5432
     depends_on:
       fluentbit:
-          condition: service_started
+        condition: service_started
     healthcheck:
       test: ["CMD-SHELL", "pg_isready -U tinkerbell"]
       interval: 1s
-      timeout:  1s
+      timeout: 1s
       retries: 30
     logging:
       driver: fluentd
@@ -137,9 +137,9 @@ services:
       cacher:
         condition: service_started
     logging:
-        driver: fluentd
-        options:
-          tag: boots
+      driver: fluentd
+      options:
+        tag: boots
     ports:
       - $TINKERBELL_HOST_IP:80:80/tcp
       - 67:67/udp

diff --git a/deploy/tls/ca-config.json b/deploy/tls/ca-config.json
@@ -6,18 +6,11 @@
     "profiles": {
       "server": {
         "expiry": "8760h",
-        "usages": [
-          "signing",
-          "key encipherment",
-          "server auth"
-        ]
+        "usages": ["signing", "key encipherment", "server auth"]
       },
       "signing": {
         "expiry": "8760h",
-        "usages": [
-          "signing",
-          "key encipherment"
-        ]
+        "usages": ["signing", "key encipherment"]
       }
     }
   }

diff --git a/docs/architecture.md b/docs/architecture.md
@@ -1,4 +1,3 @@
 # Architecture
 
-
-![](img/workflow-architecture.png)
+![](img/workflow-architecture.png)
diff --git a/docs/cli/README.md b/docs/cli/README.md
@@ -27,8 +27,6 @@ It also enables you to create a template which is eventually used to create a wo
 
 ### See Also
 
- - [tink hardware](hardware.md) - Hardware (worker) data operations
- - [tink template](template.md) - Template operations
- - [tink workflow](workflow.md) - Workflow operations
-
-
+-   [tink hardware](hardware.md) - Hardware (worker) data operations
+-   [tink template](template.md) - Template operations
+-   [tink workflow](workflow.md) - Workflow operations
diff --git a/docs/cli/hardware.md b/docs/cli/hardware.md
@@ -5,6 +5,7 @@ Hardware (worker) data operations.
 ### Synopsis
 
 Hardware operations:
+
 ```shell
   all         Get all known hardware for facility
   id          Get hardware by id
@@ -23,6 +24,5 @@ Hardware operations:
 
 ### See Also
 
- - [tink template](template.md) - Template operations
- - [tink workflow](workflow.md) - Workflow operations
-
+-   [tink template](template.md) - Template operations
+-   [tink workflow](workflow.md) - Workflow operations
diff --git a/docs/cli/template.md b/docs/cli/template.md
@@ -5,6 +5,7 @@ Template operations.
 ### Synopsis
 
 Template operations:
+
 ```shell
   create      create a workflow template
   delete      delete a template
@@ -21,32 +22,35 @@ Template operations:
 
 ### Examples
 
- - The following command creates a workflow template using the `sample.tmpl` file and save it as `sample`.
-   It returns a UUID for the newly created template.
- ```shell
-  $ tink template create -n <template-name> -p <path-to-template>
-  $ tink template create -n sample -p /tmp/sample.tmpl
- ```
-
- - List all the templates
- ```shell
-  $ tink template list
- ```
-
- - Update the name of an existing template
- ```shell
-  $ tink template update <template-uuid> -n <new-name>
-  $ tink template update edb80a56-b1f2-4502-abf9-17326324192b -n new-sample-template
- ```
-
- - Update an existing template and keep the same name
- ```shell
-  $ tink template update <template-uuid> -p <path-to-new-template-file>
-  $ tink template update edb80a56-b1f2-4502-abf9-17326324192b -p /tmp/new-sample-template.tmpl
- ```
+-   The following command creates a workflow template using the `sample.tmpl` file and save it as `sample`.
+    It returns a UUID for the newly created template.
 
-### See Also
+```shell
+ $ tink template create -n <template-name> -p <path-to-template>
+ $ tink template create -n sample -p /tmp/sample.tmpl
+```
+
+-   List all the templates
+
+```shell
+ $ tink template list
+```
+
+-   Update the name of an existing template
 
- - [tink hardware](hardware.md) - Hardware (worker) data operations
- - [tink workflow](workflow.md) - Workflow operations
+```shell
+ $ tink template update <template-uuid> -n <new-name>
+ $ tink template update edb80a56-b1f2-4502-abf9-17326324192b -n new-sample-template
+```
+
+-   Update an existing template and keep the same name
+
+```shell
+ $ tink template update <template-uuid> -p <path-to-new-template-file>
+ $ tink template update edb80a56-b1f2-4502-abf9-17326324192b -p /tmp/new-sample-template.tmpl
+```
+
+### See Also
 
+-   [tink hardware](hardware.md) - Hardware (worker) data operations
+-   [tink workflow](workflow.md) - Workflow operations
diff --git a/docs/cli/workflow.md b/docs/cli/workflow.md
@@ -5,6 +5,7 @@ Workflow operations.
 ### Synopsis
 
 Workflow operations:
+
 ```shell
   create      create a workflow
   data        get workflow data
@@ -23,18 +24,20 @@ Workflow operations:
 
 ### Examples
 
- - Create a workflow using a template and hardware devices
- ```shell
-  $ tink workflow create -t <template-uuid> -r <hardware_input_in_json_format>
-  $ tink workflow create -t edb80a56-b1f2-4502-abf9-17326324192b -r {"device_1": "mac/IP"}
- ```
- #### Note:
- 1. The key used in the above command which is "device_1" should be in sync with "worker" field in the template.
+-   Create a workflow using a template and hardware devices
+
+```shell
+ $ tink workflow create -t <template-uuid> -r <hardware_input_in_json_format>
+ $ tink workflow create -t edb80a56-b1f2-4502-abf9-17326324192b -r {"device_1": "mac/IP"}
+```
+
+#### Note:
+
+1.  The key used in the above command which is "device_1" should be in sync with "worker" field in the template.
     Click [here](../concepts.md) to check the template structure.
- 2. These keys can only contain letter, numbers and underscore.
+2.  These keys can only contain letter, numbers and underscore.
 
 ### See Also
 
- - [tink hardware](hardware.md) - Hardware (worker) data operations
- - [tink template](template.md) - Template operations
-
+-   [tink hardware](hardware.md) - Hardware (worker) data operations
+-   [tink template](template.md) - Template operations