The Templates section of the JCA displays a list of all the software templates available on the platform.
The table provides the following information:
Version - shows the latest supported version of the software templated (for the legacy NATIVE and CARTRIDGE types only)
Node Mission - defines a layer in the environment topology wizard where a template should be displayed
Type - contains a template type (NATIVE, CARTRIDGE, or DOCKERIZED)Note: Currently, most of the templates are provisioned based on the Docker standard adoption (DOCKERIZED), while the usage of the NATIVE and CARTRIDGE types are mostly deprecated.
Published - denotes whether a particular template is published (✔) or not (-), i.e. available/unavailable for end-users via the dashboard
Manifest URL - provides a link to the source manifest file (for the legacy CARTRIDGE type only)
The legacy NATIVE and CARTRIDGE templates can be expanded (if at least one node is created) to list hosts with this instance.
You can manage available templates in the following ways:
You can integrate your custom stacks into the platform by expanding the Add menu at the tools panel and selecting the From Docker Repository option.
- In the Add Template dialog, select the required Registry (or leave blank for Docker Hub) and specify the Repository where your template is stored.
Сlick Next (or the magnifying glass icon) to fetch the image data.
- Some of the settings are defined within the template and cannot be changed via the form: Node Mission (layer), Node Type (unique ID), and Engine Type (programming language).
Other parameters can be adjusted up to your needs:
- Display Name - server name that is displayed within JCA and at the end-user dashboard
- Icons - images of the smaller and bigger size (16✕16 and 32✕32 respectively) that will be used for the stack in the dashboard and JCA
- Auto-Selection of Provisioned Tags - enables automatic update and delivery of the latest template versions (tags); herewith, you can additionally:
- Keep previously selected tags published - prevents unpublishing of the already provided tags during the auto-selection procedure
- Allow system to switch the ‘Default’ tag - changes the default tag to the latest version available during auto-selection procedureTip:
Use the following system settings to customize the tags auto-selection process:
- jelastic.templates_update.minor_versions.number - sets a number of latest minor versions (within each major release) to keep during the tags auto-selection
- qjob.templates_update.cron_schedule - configures the frequency of the tags auto-selection operation (once a day by default)
- Tags - allows to manually choose template versions available via topology wizard and set a Default tag (is provisioned unless a specific one is defined). If needed, you can click Exclude from List (“-”) to explicitly forbid tag usage (including via API) or use Include to List (“+”) to re-add it. If the tags auto-selection is enabled, the platform overrides any manual changes to the list during the periodic updates.
- Renew tags list now - initiates the auto-selection procedure immediately after applying changes (the same operation as Actions > Re-Import Template)
When you are finished, click Add for a new template to appear in the software stacks list (unpublished, i.e. not available for end-users, by default).
It is possible to adjust settings within the dockerized templates by selecting the required instance and clicking the Edit button on the tools panel (or double-click for quick access).
In the opened Edit Template dialog window, you can adjust the same settings as during the template addition (except the Registry and Repository options, which cannot be changed).
Run Additional Actions
While working with templates, you can perform some additional operations by expanding the Actions menu.
Here, the following options are available:
- Regenerate Pool of the legacy NATIVE and CARTRIDGE templates; could be done only for the currently selected stack or for all of them (the Regenerate Current and Regenerate All options respectively)
- Preview Unpublished templates by opening your developer dashboard in a new browser tab with all the software stacks available at the topology wizard (including unpublished ones). If needed, you can Open in Popup, but the JCA panel will be unavailable till the pop-up is closed
- Re-Import Template to apply any changes committed to the registry (for DOCKERIZED) or manifest file (for CARTRIDGE)
To make software stack available for the end-users, you need to select it via JCA and Publish with the appropriate button.
In the same way, you can Unpublish any template to hide it from the end-users.
To delete a template, select it within the list, click the appropriate Remove button at the top panel, and confirm via the pop-up. Be aware that such an operation may affect customers with the template already in use.
In the Docker Registries subsection, you can Add your public or private registry to the list of known hosts. These records define trusted sources for integrating your custom dockerized templates to JCA.
In the Add Registry dialog frame, the following details are required:
- Name - specify a name to identify your registry
- Docker Host/IP - insert a URL/IP address of the custom Docker registry (or leave blank for Docker Hub)
- Login/Password - type credentials for your account (if needed)
Click Add, and your custom registry will appear in the list.
You can select the existing record to Edit the earlier provided information or Remove this registry (using the appropriate buttons from the top pane).