Skip to main content

Cloudomation Installer

Setup script for on-premise Cloudomation installations

Managing on-premise installations is hard. We found that our users have a need for simple tooling that lets them install, update and manage their Cloudomation workspace installations.

This setup script enables Cloudomation on-premise users to install and update Cloudomation on their own, create backups and clean their database.

Human requirements:

  • Basic Linux knowledge
  • Serviceaccount & license file (you get those when you buy a license)
  • Having read the Cloudomation docs (https://docs.cloudomation.com/)

System requirements:

note

For the on-premise system requirements please click here.

Download installer

release-6

Introduction

The setup.sh file is your single entry point to either a fresh Cloudomation workspace installation, an update of an existing workspace installation or to perform database cleanups and licensing tasks.

FlagDescription
-d | --directory DIRWhere Cloudomation should be installed. defaults to ./cloudomation
-v | --verboseEnable verbose logging, provides additional output. useful for debugging
--vacuumVacuum the postgresql database Cloudomation uses
-h | --helpDisplay help in the terminal

Install a fresh Cloudomation workspace installation

Extract the zip file. Place your serviceaccount.json and license.yml file in the same directory as setup.sh. Open a terminal in this directory and run ./setup.sh. Set the desired installation directory with -d flag. If no flag is passed, the default value ./cloudomation is used.

Most configuration values are set to reasonable defaults. Still, you will be prompted for the following settings:

SettingDescription
ORGANIZATION_NAMEName of your organization
WORKSPACE_NAMEName of your workspace. Useful if you want to create multiple workspaces.
BOOTSTRAP_USERAn email address. An invite will be sent to this address. The user will be able to set a password and login to Cloudomation.
SMTP_HOSTHostname of your SMTP server
SMTP_PORTPort of your SMTP server
SMTP_USE_TLSWether or not to use TLS for SMTP

Install self-signed certificate in browser

After the installation is done, you will need to install the self-signed HTTPS certificate in your browser as an authority. The certificate cert.crt is located in the Cloudomation root directory.
Install cert in Chrome
Install cert in Firefox
Install cert in Brave

Your Cloudomation workspace is now ready for action! 🎉🎉
Per default it is reachable via https://localhost

Change configuration and apply changes

If you want to change any settings (wether pre-defined or user-defined), edit setup.yml and run setup.sh again. A diff editor will open, enabling you to control which values should be used. The documentation for imediff is available here. Press h for help.

How to use tools (database cleanup, license only, etc...)

The setup script comes with one additional utility for managing your Cloudomation deploy.

vacuum postgresql:

This executes postgresqls internal garbage-collection feature, which reclaims space that is not in use by the database anymore. For performance reasons, this dead-space is not reclaimed while the database is running.
Further information: https://www.postgresql.org/docs/current/sql-vacuum.html

The --vacuum flag safely shuts down Cloudomation, executes the vacuum command and restarts all services.