The Documentation Project for RADNAC.
RADAC provides a native-esque Azure experience by being deployed as a Managed Application through the Azure Marketplace whilst integrating tightly with Application Insights.
This project covers public materials related to the product.
Interaction with the API is best done using the Azure CLI against your Managed Application deployment resource.
So start by logging in with:
az login
As an end user, use the OpenAPI specification found in specification/user/managed-application.
To determine the API version your deployment uses inspect the value 'api.version' returned by running:
az rest --verbose \
--method post \
--uri '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/radnac-YYYYMMDDhhmmss/customstatus' \
--uri-parameters api-version=2018-09-01-preview
N.B. api-version in the query string is not related to the specifications found in this repository and must be provided and set to the value shown as it is required and consumed by Azure
The API version is fixed for a given deployment but may vary between differing deployments.
As an example, of using the API, to perform a 'restore' operation, use:
az rest --verbose \
--method post \
--uri '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/radnac-YYYYMMDDhhmmss/customrestore' \
--uri-parameters api-version=2018-09-01-preview \
--header 'content-type=application/json' \
--body '{"url":"https://account.blob.core.windows.net/container/backups/radnac?..."}'
N.B. your request is validated at runtime against the specification
Antora is used to generate documentation, which means AsciiDoc.
You will require pre-installed:
make- Node.js LTS
On committing and pushing, GitHub will automatically publish otherwise to work with local builds run:
make
You will require pre-installed:
m4makeyq
Generate the usable assets with:
make -C specification
This is done through tagging your commit with prod and pushing, GitHub will pick this up, and kick off a deployment task.
Follow the instructions on About custom domains and GitHub Pages which mostly states you will need to create a DNS CNAME RR for docs.radnac.com. to point to corememltd.github.io..