For fully automated deployments of FlashGrid server (non-clustered) it may be preferable to use REST API instead of FlashGrid Launcher GUI.
Note: Access to the REST API is restricted to approved customers only and requires providing a key. Please contact technical support if you need access to the REST API.
Endpoints
The REST API endpoints have the following address format: https://<version>-skybase.cloudprov.flashgrid.io/api/gen_cf
<version> corresponds to a FlashGrid server (non-clustered) release version. For example, 2010 for version 20.10. The following REST API endpoints are currently valid:
https://2102-server.cloudprov.flashgrid.io/api/gen_cfhttps://2010-skybase.cloudprov.flashgrid.io/api/gen_cf
Input
The REST API accepts the following inputs:
api-key:<accesskey>- the API access key provided in the request header- Cluster configuration file provided as POST binary data.
Example of using the API
curl -o generated_template.json -H api-key:mycompany-4717983475934759 --data-binary @skybase-config-file.cfg https://2010-skybase.cloudprov.flashgrid.io//api/gen_cf
This example will generate a FlashGrid server template from skybase-config-file.cfg configuration file and will save it as a file named generated_template.json.
SSL cerificate validation
When using curl you may get the following error if your OS does not have the corresponding Certification Authority certificate installed:
curl: (60) Peer's Certificate issuer is not recognized.
To prevent this error you may choose to install the certificate used by the endpoint or to skip certificate validation by adding --insecure option to the curl command.
Creating and managing configuration files for use with the REST API
The following scanarios provide recommendations for creating and managing configuration files depending on a specific scenario.
-
Deploying new instance(s) for new database/application(s)
Use SkyBase Launcher GUI for creating and saving the initial version of a configuration file. You can start with a blank configuration or upload a configuration file that you created previously. Subsequently, the configuration file can be stored in a version control system, cloned, and customized as needed.
-
Deploying instance(s) in Dev/Test/QA/Pre-prod environment that need to match configuration of a system in Prod environment
Start with the configuration file used for deploying the production system and customize it as needed for the new environment. Use the same API version for consistency.
-
Deploying a secondary system (with configuration matching the primary system) in a different region for DR purposes.
Start with the configuration file used for deploying the production system and customize it as needed for the new environment. Use the same API version for consistency.
- Re-deploying a system if it is damaged or destroyed by mistake
Use the same configuration file that was used for creating the system initially. In some cases using newer API version for the deployment may be preferred or required, for example, if the initial system had been deployed long time ago and was since updated to newer OS and/or software versions. Using newer API version might require modifications to some of the parameters stored in the configuration file.
Submit request to technical support if you need help with modifying the configuration file.