Triunnia Labs

Create Files Api

From the list of Microservices within your Application, click Create to access the Create Microservice screen. Enter a name for the microservice and give it the type Files Api.

Click Create on this screen to create the Files Api microservice and add it to the Application. It will take you back to the list of Microservices within the Application.

Configure Files Api

Click on the Files Api microservice you just created in the list to edit its settings.

Setting up the microservice involves going through each section and configuring them as required. On these screens, you will see the raw values, but when providing them to the Files Api, they are given in encrypted form. The Control Panel prepares that encryption for you.

Menu Item

Description

Microservice

Configure general settings about the microservice.

Access

Configure how this microservice can be accessed.

Application

Configure how to access the Application Api.

Protected Memory

Configure the protected memory system.

Files Api

Configure the data path and cache settings.

References

References indicate to the Control Panel that a microservice has dependencies on other microservices. When these are specified, the Control Panel will make their encrypted access settings available in the generated configuration files. The Files Api has no dependencies -- and therefore no references -- so this section can be skipped.

Deployment

To proceed further, you must deploy your Files Api. In your arch-files-api.yml file will be a series of environment variables that require values. Obtain those values from the Environment Variables screen in the Control Panel. A helpful Copy to Clipboard button is provided next to each value, just click that and paste into its appropriate spot in the service yml file.

Deploy the Files Api into its Docker container when the environment variables are set up in arch-files-api.yml. Also change the volume source path to something appropriate for your deployment — this is where the Files Api will write encrypted file data. As you require, you may also perform any other configurations to the yml file.

With the container running, perform a Health Check (see below). If the health check shows Healthy, the Files Api is ready to accept requests.

Grant Access to the Files Api in your application. Arch protects the entire distributed application and without this authorized access, all calls to the Files Api will be disallowed.

Menu Item

Description

AppSettings.json

Get the encrypted settings to use for appsettings.json.

Environment Variables

Get the encrypted settings as environment variables.

Grant Access

Authorize this microservice with the Application Api.

Diagnostics

The Control Panel provides diagnostic capabilities for microservices in Arch to help troubleshoot any issues.

A Health Check can be performed to ensure the microservice is properly configured and starts up correctly. Health checks should be performed whenever setting up the microservice and for health monitoring.

A more thorough Configuration diagnostic can be performed to evaluate whether the configuration of the microservice matches what the Control Panel has specified. If there are discrepencies, there will most likely be Unauthorized Access and/or encryption errors. As this feature decrypts and relays configuration data to the Control Panel from the microservice, it must be enabled on the microservice in order to work. In the service yml file, add the following Microservice__EnableDiagnostics environment variable and set its value to true, then restart the container.

Microservice__EnableDiagnostics=true

Be sure to remove this setting when diagnostics is complete -- you never want this enabled in Production.

The Verify Authorization screen allows the authorization functions for the Files Api to the Application Api and for clients of the Files Api to the Files Api to be tested in isolation. These tests should both pass for the Files Api to be considered successfully set up.

Menu Item

Description

Health Check

Perform a health check on the microservice.

Configuration

Diagnose deployed configuration settings.

Verify Authorization

Diagnose authorization protocols.