logoBack to home screen

Deployment Package Contents

Your package should have the following contents:

File / FolderDescription
resourcesFolder containing tools and resources required for local deployment. Do not modify this folder!
check-health.shScript that runs a health check against the specified URL. This can be used as an after-setup test to verify that deployed services are available and work properly.
check-health.batWindows script equivalent to the above.
create-backup.shCreates a backup of your installation (packaged as .zip).
create-backup.batWindows script equivalent to the above.
encrypt.shScript that encrypts the passed value. This is used to avoid clear text passwords in configuration files. See Password Encryption for more information.
encrypt.batWindows script equivalent to the above.
example-environment.shIf this is the first deployment, you may want to create an environment script which sets the environment variables. This is useful in environments where multiple Java installations are available and JAVA_HOME doesn't point to the one that's supposed to be used for the installation. The easiest way to create the environment script is to copy this file to the default location (explained in installation instructions). Afterwards, simply open the file in a text editor and set respective values.
example-environment.batWindows script equivalent to the above.
example-installation-settings.yamlExample configuration file which you can use as a template.
install.shScript that performs a local installation, i.e. Tomcat setup and asset deployment. Run install.sh to display usage information.
install.batWindows script equivalent to the above.
jinni.shScript that runs Jinni with the specified request. Jinni is the Tribefire setup tool. It is used for various setup related tasks such as asset downloading, Tomcat setup, Docker image building, Kubernetes manifest creation or password encryption. It therefore supports a lot of different commands for different use cases. For further information about Jinni run jinni.sh to display usage information or jinni.sh help to list the available commands.
This deployment package has been built specifically for local installation. It's usually not required to run jinni.sh directly. Instead one can just use the provided convenience scripts (see above). These scripts also use Jinni, but require less parameters, and are thus easier to use.
jinni.batWindows script equivalent to the above.
restore-backup.shRestores a backup of your installation.
restore-backup.batWindows script equivalent to the above.
READMEReadme file with basic information, linking to the documentation.