An application blueprint is a packaged tarball file (*.tar.gz
) that contains the application manifest YAML file (jovianx.yaml
) and the Helm Charts directories that are referenced by the application manifest. The application manifest defines the components used by the application. The components can be Helm Charts or other cloud-managed services. JovianX uses the Application Blueprint to create resources and set up services when a new account signs up.
The application blueprint contains the following:
Application Manifest - The application manifest is a YAML file named jovianx.yaml
. The manifest defines the components that are created for a new SaaS account. For example Kubernetes Helm Charts, DynamoDB, CloudDNS or other cloud managed services.
Helm Charts - The blueprint can also include the Helm Charts that are used for creation of application services.
The application manifest is a YAML file that describes the application. JovianX uses the manifest to create the needed resources and services when a new account signs-up.
A basic template of an application manifest looks as following:
jovianx.yaml# v1 - JovainX API Compatabilityjovianx_api_version: v1​# string - Name of this SaaS applicationapplication_name: '<APP-NAME>'​# semantic versioning - version of this JovianX blueprintversion: <SEM-VERSION>​# string - Name of a component to be used a main application entry pointmain_endpoint_component: '<COMPONENT-NAME>'​# Components section defines all application components and their helm chart implementationscomponents:- name: '<COMPONENT-NAME>'version: <COMPONENT-SEMVER>provider: helm_charthelm_chart_name: <PATH/TO/HELM/CHART>helm_set:# List of key-value pairs to pass to helm on account creation- key: '<SET-KEY>'value: '<SET-VALUE>'endpoints:- name: '<ENTRYPOPINT-NAME>'type: entry_pointservice_name: '<KUBERNETS-SERVICE-NAME>'port: <KUBERNETES-SERVICE-PORT>path: '<KUBERNETES-SERVICE-PATH>'​# Settings Descripts define user inputs andsettings_descriptors:# list of descriptos- name: <DESCRIPTOR-NAME>display: '<A QUESTION TO ASK THE USER ON SIGN-UP>'input_type: stringdefault: '<DEFAULT ANSWER>'components:- name: '<COMPONENT-NAME>' # Provide value to this componethelm_set:- key: '<SET-KEY>'
To create an application blueprint archive the application manifest and helm charts into a blueprint tar.gz
$ tar -cf <BLUEPRINT-NAME> jovianx.yaml <HELM-CHART> ...
Note: The Helm Charts should be open, untar direcotry.
Example: the following directory has an application manifest jovianx.yaml
and a Chart my-helm-chart
├── my-helm-chart│ ├── charts│ ├── templates│ ├── Chart.yaml│ └── values.yaml└── jovianx.yaml
To create an application blueprint for the directory use the following command:
$ tar -cf blueprint-1.0.0.tar.gz jovianx.yaml my-helm-chart
To upload your application blueprint to JovianX via the web console:
Navigate to Blueprints page
Click on Upload a new Blueprint
bar
Click on Choose blueprint tar.gz
file
Click on Upload
to upload your blueprint
Once the blueprint is upload you will be able to find it in the blueprints list, and view the application manifest.
To upload your application blueprint to JovianX via an automated CI process or from command line, you will need to find your API Access Key
and API Secret
. You can find both in Upload a new Blueprint
bar under Blueprints
navigation bar.
curl -u '<ACCOUNT-API-ACCESS-KEY>:<API-SECRET>' -F '[email protected]<PATH/TO/BLUEPRINT/FILE.TAR.GZ>' 'https://<ACCOUNT-API-PATH>/api/v1/upload_blueprint?make_default=true'
Key | Description |
| Description: Version of the JovianX Manifest API. Parent: Root Type: v1 Required |
| Description: Name of the SaaS Application. Parent: Root Type: string Required |
| Description: Version of the JovianX blueprint. Parent: Root Type: semantic version Required |
| Description: Main application end-point. Parent: Root Type: string Required |
​ | Description: components section is a list of all components(Helm Charts or Cloud Managed Services) used as part of the application, and their settings. Parent: Root Type: list Required |
| Description: Application timeout configuration Parent: Root Type: collection Optional |
| Description: How many status error detection are accepted before changing the app status to error. Parent: Root Type: collection Default: 1 Optional |
| Description: The list of agents Parent: Root Type: list Optional |
| Description: A list of settings descriptors Parent: Root Type: list Optional |
| Description: List of hooks Parent: Root Type: list Optional |
Components section is a list of all components used as part of the application, and their settings. Components are Helm Charts or Cloud Managed Services.
Key | Description |
| Description: Name of the component Parent: components Type: string Example: Required |
| Description: Version of the component Parent: components Type: semantic_version Example: Required |
| Description: Provider that implements the component Parent: components Type: Select Options:
Example: Required |
| Description: Path to unarchived helm chart within the blueprint Parent: components Type: string Example: Required for |
| Description: Path to values.yaml file for the component Parent: components Type: string Example: Optional for |
| Description: List of helm set key and value pairs Parent: components Type: list Example:
Optional for |
Key | Description |
| Type: string |
| Type: string |
| value: string | number | radio | select |
| Type: string |
| Type: string |
| Type: list |
Key | Description |
| Description: List hooks that are executed before app install Parent: Optional |
| Description: List of hooks that are executed after app install Parent: Optional |
Key | Description |
name | ​ |
on_failure | ​ |
timeout | ​ |
provider | ​ |
image | ​ |
command | ​ |
args | ​ |
env | ​ |
{{ account://vendor_company }}
{{ account://end_company }}
{{ account://account_api_key }}
{{ account://admin_email }}
{{ account://admin_password }}
{{ account://api_host }}
{{ account://application_version}}
examplecomponents:- name: node-componentversion: 1.0.0provider: helm_chart # helm_chart | dockerhelm_chart_name: node-charthelm_values_file: values-jovianx.yamlhelm_set:- key: repositoryvalue: https://gitlab.com/jovianx-saas-platform/hello-world-app.git- key: replicasvalue: 1- key: vendor_companyvalue: '{{ account://vendor_company }}'- key: end_companyvalue: '{{ account://end_company }}'- key: account_api_keyvalue: '{{ account://account_api_key }}'- key: admin_emailvalue: '{{ account://admin_email }}'- key: admin_passwordvalue: '{{ account://admin_password }}'- key: api_hostvalue: '{{ account://api_host }}'