Triunnia Labs

Setup

Use the Control Panel to set up the Users Api.

The Users Api depends on the Application Api, Keys Api, Tokens Api, and Email Api. All four must already be created and running before proceeding. See the Application Api Setup, Keys Api Setup, Tokens Api Setup, and Email Api Setup pages if you have not done this yet.

Create Users 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 Users Api.

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

Configure Users Api

Click on the Users 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 Users 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.

Sql Server

Specify Sql Server connection strings.

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 Users Api depends on the Keys Api for per-user encryption keys, the Tokens Api for time-bound verification and reset tokens, and the Email Api for transactional email delivery. Add all three as References so the Control Panel can include their access settings in the Users Api's configuration.

Deployment

To proceed further, you must deploy your Users Api. In your arch-users-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 Users Api into its Docker container when the environment variables are set up in arch-users-api.yml. Also change the volume source path to something appropriate for your deployment. 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 Users Api is ready to accept requests.

Grant Access to the Users Api in your application. Arch protects the entire distributed application and without this authorized access, all calls to the Users 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 Users Api to the Application Api and for clients of the Users Api to the Users Api to be tested in isolation. These tests should both pass for the Users 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.