You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration.md
+53-7Lines changed: 53 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,10 +95,8 @@ outputs:
95
95
- type: cli
96
96
```
97
97
98
-
Possible types of output include:
99
-
-`local` for a local file.
100
-
-`gcs` for a Google Cloud Storage bucket.
101
-
-`cli` for command line output.
98
+
There are different ways to output the results.
99
+
The `type` property indicates support of platform where results are going to be written.
102
100
103
101
Most types also require a `format` to be specified.
104
102
Possible formats are:
@@ -107,13 +105,61 @@ Possible formats are:
107
105
-`html` for a HTML formatted report.
108
106
-`intermediate` to output the raw JSON fetched by the *data gatherers*.
109
107
110
-
With the `cli` type output the format is optional
111
-
and defaults to the `cli` format, for a coloured CLI formatted report.
112
-
113
108
The reports in `markdown`, `html` and `cli` format make use of the
114
109
*policy manifest* to produce a human readable report describing
115
110
which checks passed and which failed.
116
111
The `json` format is raw output from OPA evaluation.
117
112
118
113
If no `outputs` are specified Preflight will output a report
119
114
of the results to the CLI.
115
+
116
+
### cli
117
+
118
+
With the `cli` type output the format is optional
119
+
and defaults to the `cli` format, for a coloured CLI formatted report.
120
+
121
+
### local
122
+
123
+
The `local` type output writes the results to a local directory.
124
+
The directory must be specified with the `path` property.
125
+
It will be created in case it does not exist.
126
+
127
+
```
128
+
- type: local
129
+
format: json
130
+
path: ./output
131
+
```
132
+
133
+
### gcs
134
+
135
+
The `gcs` type output uploads the results to a Google Cloud Storage bucket.
136
+
137
+
The property `bucket-name` indicates the ID of the GCS bucket where the results are going to be uploaded.
138
+
Preflight assumes the bucket already exists.
139
+
140
+
`credentials-path` is the path to the credentials that can be used to write to that bucket.
141
+
It is recommended to create a JSON key for a dedicated service account.
142
+
143
+
```
144
+
- type: gcs
145
+
format: json
146
+
bucket-name: myresultsbucket
147
+
credentials-path: ./credentials.json
148
+
```
149
+
150
+
### azblob
151
+
152
+
The `azblob` output uploads the results to an Azure Blob Storage container.
153
+
154
+
The `container` property indicated the ID of the container where to upload the results.
155
+
Preflight assumes the container already exists.
156
+
157
+
```
158
+
- type: azblob
159
+
format: json
160
+
container: myresultscontainer
161
+
```
162
+
163
+
Authentication is done by setting the environment variables `AZURE_STORAGE_ACCOUNT` and `AZURE_STORAGE_ACCESS_KEY`. You can create keys for a storage account from the Azure portal:
0 commit comments