The Export Service allows users to request and download data archives for auditing or use with their own tooling. Because many ConsoleDot applications need to export data, this service provides some common functionality.
For more information on integrating with the export service, see the integration documentation.
- Golang >= 1.16
- podman-compose
- make (optional for running the Makefile)
- ginkgo
You can start the database, minio, and the api using make run
.
Ports now exposed:
- public api on localhost:8000
- metrics on localhost:9090
- internal api on localhost:10010
- minio on localhost:9099
(use
minio
as the access key andminioadmin
as the secret key to view the dashboard)
To test local changes, you can restart the api server using make run-api
.
You can create a new export request using make sample-request-create-export
which pulls data from the example_export_request.json
. It should respond with the following information:
{
"id":"0b069353-6ace-4403-8162-3476df3ae4ab",
"created":"2022-10-12T15:07:12.319191523Z",
"name":"Example Export Request",
"format":"json",
"status":"pending",
"sources":[{
"id":"0b1386f4-2b91-44d7-bcb0-9391cfbba4c5","application":"exampleApplication",
"status":"pending",
"resource":"exampleResource",
"filters":{}
}]
}
Replace the EXPORT_ID
and EXPORT_RESOURCE
in the Makefile
with the id
and the sources id
from the response.
You can then run make sample-request-internal-upload
to upload example_export_upload.zip
to the service. If this is successful, you should be able to download the uploaded file from the service using make sample-request-export-download
.