Skip to content

Onteon Control Center - Installation

Simple Installation

First, you need to go to download page and then download the suitable Onteon Control Center Installation package.

If you downloaded installation package, untar it and run:

sudo ./install.sh --authmock-base-url http://localhost:8050

--authmock-base-url parameter is a base url for authorization mock. If you want to use other authorization, read Advanced Installation Chapter.

Installation contains everything that Onteon Control Center needs to work.

Installation script will:

  • install Onteon Control Center as a system service.
  • create (if not exist) user that runs Onteon Control Center.
  • clean the installation files.
  • start Onteon Control Center.

For more advanced installation, read Advanced Installation Chapter.

Advanced Installation

First, you need to go to download page and then download the suitable Onteon Control Center Installation package.

If you downloaded installation package, untar it.

Help

To get list of installation parameters, run sudo ./install.sh --help.

Onteon Control Center installation script.

Attaching to cluster:
  --attach-to-cluster cluster_base_url - attaches current Onteon Control Center to cluster. If don't
  specified, Onteon Control Center will create a new cluster.

Authorization
  --authorization auth_type - possible values: [authmock, keycloak]. By default it's 'authmock'.
  --authmock-base-url base_url - required with authmock authorization. E.g. http://192.168.10.100:8050.
  --keycloak-base-url base_url - required with keycloack authorization. E.g. http://192.168.10.100:8080.

Monitoring
  --enable-monitoring - enables monitoring.
  --sonario-base-url base_url - base url to Sonario Server. E.g. http://192.168.10.100:8100.

Optional arguments:
  --user user - linux user. If specified user does not exist it will be created. Default user is 'onteon'.
  --group group - linux group. If specified group does not exist it will be created. Default group is 'onteon'.
  --ip-address ip_address - ip address of Onteon Control Center.
  --dont-start - don't start Control Center after the installation. By default it is false.
  --dont-cleanup - it will prevent from removing installation files. By default it is false.
  --installation-dir path - installation path. By default it is /opt.

Scaling

If you are going to install multiply instances of Onteon Control Center, you need to use --attach-to-cluster parameter.

First, you need to install Onteon Control Center without attaching to cluster.

sudo ./install.sh --authmock-base-url http://<ip-address>:8050

Next instances will be installed with --attach-to-cluster parameter.

sudo ./install.sh \ 
    --authmock-base-url http://<ip-address>:8050 \ 
    --attach-to-cluster http://<first-instance-ip-addres>:8050

Keycloak Authorization

You can install Onteon Control Center with Keycloak authorization type.

You need to:

  • specify authorization type with --authorization parameter.
  • specify Keycloak base url with --keycloak-base-url parameter.
sudo ./install.sh \
    --authorization keycloak \
    --keycloak-base-url http://<keycloak-ip>:8080

Monitoring

If you want to use Sonario Monitoring, you need to:

  • enable monitoring with --enable-monitoring parameter.
  • specify Sonario monitoring base url with --sonario-base-url parameter.
sudo ./install.sh \ 
    --authmock-base-url http://localhost:8050 \ 
    --enable-monitoring \
    --sonario-base-url http://<sonario-ip-address>:8100

Example Production Installation

For production environment we highly recommend to create a cluster. It requires at least 3 nodes to work.

First Onteon Control Center:

sudo ./install.sh \ 
    --authorization keycloak \
    --keycloak-base-url http://<keycloak-ip>:8080 \
    --enable-monitoring \
    --sonario-base-url http://<sonario-ip-address>:8100

Next Onteon Control Centers:

sudo ./install.sh \ 
    --authorization keycloak \
    --keycloak-base-url http://<keycloak-ip>:8080 \
    --enable-monitoring \
    --sonario-base-url http://<sonario-ip-address>:8100 \
    --attach-to-cluster http://<first-instance-ip-addres>:8050

Every Control Center should share directories. Read more about sharing directories.

Manual Installation

Production ready

For production environment we highly recommend to create a cluster. It requires at least 3 nodes to work.

Download

To install Onteon Control Center, go to download page, and download suitable version.

Extract

Unpack downloaded archive on every OS which will run Control Center's node.

Setup authorization

For production environments we highly recommend to connect with authorization system used by the company or the organization. To do so edit configuration file (config/configuration.yml) on every node with proper values.

KeyCloak

Below is shown example configuration used for KeyCloak provider.

onteon:
  auth:
    provider:
      name: keycloak
      params:
        configurationUrl: http://keycloak:8080/auth/realms/master/.well-known/openid-configuration

Enable Monitoring

Before configuring monitoring, you need to install Sonario monitoring. Click here to read more about Sonario installation.

To enable monitoring, edit configuration file (config/configuration.yml) on every node with proper values.

onteon:
  monitoring:
    enabled: "true"
    elasticsearch:
      url: "http://<sonario-ip-address>:8100/sonario-elasticsearch"

Here you can read more about monitoring configuration.

Share directories

If you have more than one Onteon Control Center in your cluster, you need to share directories listed below.

onteon-control-center/storage/application-registry/
onteon-control-center/storage/application-registry-session/
onteon-control-center/storage/node-upgrade-registry/
onteon-control-center/storage/node-upgrade-registry-session/

Start

Start running Control Center with only one node with the command shown below.

./start-onteoncc.sh

Other nodes (starting from the second one) can be started with same command but with Control Center's endpoint (which can be a balancer with pool of nodes) to which it should attach as shown below.

./start-onteoncc.sh --attach-to-cluster <cluster_endpoint>

You can check status of cluster by doing HTTP GET query to <cluster_endpoint>/api/info/status.

curl <cluster_endpoint>/api/info/status

Testing and development

For testing and development environment one node cluster can be used with default configuration with mock instead of proper authorization (all requests are accepted).

Download

To install Onteon Control Center, go to download page, and download suitable version.

Extract

Unpack downloaded archive on every OS which will run Control Center's node.

Start

Start running Control Center with only one node with the command shown below.

./start-onteoncc.sh

You can check status of clsuter by doing HTTP GET query to <cluster_endpoint>/api/info/status.

curl <cluster_endpoint>/api/info/status

Logs

You can find Onteon Control Center logs in onteon-control-center/logs directory.

Here onteon-control-center/logs/server/main/start/server.out you can find start logs.

Firewall Ports

8050/tcp - API port.