Overview
This guide will walk you through the following steps:
Guidelines on using Maverics Storage and Evaluation Bundles
Configuring Maverics Storage as your storage provider
Publishing config to Maverics Storage
Downloading an Evaluation bundle and starting an Orchestrator to pull config from Maverics Storage
Prerequisites
Permissions in your host environment install the orchestrator service
Maverics Storage & Orchestrator Evaluation Bundles
Maverics Storage and Orchestrator Evaluation Bundles simplify the deployment of application use cases for quick testing and local development.
Usage Guidelines:
For evaluation, testing, and local development purposes only.
Do not store or publish sensitive data or secrets in your configuration.
Always use a Secret Provider for managing sensitive information.
Storage Lifecycle:
Maverics Storage buckets are automatically recycled every 90 days.
Upon recycling, all stored configurations are deleted.
After recycling, you will need to publish your configurations again and download a new evaluation bundle.
Key Components:
Maverics Storage:
An automatically provisioned AWS bucket provided by Strata.
Stores published configurations for easy access.
Orchestrator Evaluation Bundle:
Available for Mac OS, Windows, and Linux.
Includes:
Executable orchestrator binary
Preconfigured environment variables for connecting to your Maverics Storage container
Self-signed certificates for secure TLS communication
How it Works:
Publish configuration: Publish your configuration to Maverics Storage.
Download orchestrator evaluation bundle: Select and download the appropriate evaluation bundle for your OS.
Start orchestrator: Run a single command to launch the orchestrator, automatically connecting it to your published configuration.
Publish configuration
Go to Deployments.
Create a new or select an existing deployment.
Under Host Environment section and next to Configuration Storage, click Edit.
From the dropdown menu, select Maverics Storage, click Save.
From the bottom of the Deployments screen, click Publish to open the Deployment Manager, click Publish to send a default config to your Maverics Storage.
Download Orchestrator Evaluation Bundle
The Orchestrator Evaluation Bundle contains everything you need to run the service and connect to your deployment’s Maverics Storage bucket.
From your Deployments page, in the Host Environment section, next to Orchestrator Services click Select Download.
Choose your platform and download.
Click to enlarge
Save the file to your computer and double click to unzip the contents.
Bundle Contents
Contents | Description |
---|---|
Mac OS: maverics_darwin_arm64 Linux: maverics_linux_amd64 | Orchestrator binaries that are executable via command line. They are for quick testing and not intended to be run as a service. For more information on deploying an orchestrator as a service see our Installation Overview. |
public_key.pem | The Orchestrator uses this public key to confirm configurations published by the Maverics Console are authentic and unchanged. Each deployment has its own unique public key, which you can place in the Orchestrator’s environment and load using environment variables. |
Mac OS & Linux: maverics.env | Contains the environment variables for the Orchestrator binaries. This includes the configuration storage location, private key for validating configuration, the HTTP address, self-signed certs to use for default TLS, the polling frequency and reload behavior. |
localhost.pem localhost-key.pem | Self signed certs used for TLS. |
rootCA.pem | Strata provides a root certificate authority that you can use with Maverics Tutorials when testing login flows. When this certificate is trusted on your computer, it will remove browser security warnings during user flows. |
Start the orchestrator on the host
1. As an Administrator, open the Command Prompt
In the Windows task bar search for Command Prompt, right click on the Command Prompt app, and select Run as administrator. Type cd and enter the path to the location where you extracted the orchestrator evaluation bundle.
4: Start the orchestrator
call maverics.bat && ./maverics-orchestrator.exe
In Terminal navigate to the directory where you downloaded and unzipped the orchestrator evaluation bundle.
Run the following command replacing with paths to the orchestrator binary.
source ./maverics.env && ./maverics_linux_amd64
In Terminal navigate to the directory where you downloaded and unzipped the orchestrator evaluation bundle.
Run the following command replacing with paths to the orchestrator binary.
source ./maverics.env && ./maverics_darwin_ARM64
Troubleshooting
What do I do if orchestrator fails to start with an error message
“…level=error msg="failed to instantiate config provider: unable to read file 'public_key.pem' specified in 'MAVERICS_BUNDLE_PUBLIC_KEY_FILE': open public_key.pem: no such file or directory"
?Configuration bundles published by the Maverics platform are signed to ensure data integrity. The orchestrator cannot load the public key associated with your deployment. In the host environment configuration check that the file path is correct.
What do I do if the orchestrator fails to start with the error message
"level=error msg="failed to load configuration: unable to unbundle 'maverics.tar.gz' config from <storage provider>: bundle signature verification failed: signature verification failed: go-jose/go-jose: error in cryptographic primitive"
?In this case, the signature verification failed. The configuration bundle signature did not match with the public key used to start the orchestrator. Get the Deployment, scroll down to the Host Environment section, download the Public Key, and update the path in your host environment to the new file.