Package Based Operations

Important

  1. All installation and migration commands need to be executed as root user.
  2. If you are running a multihost setup, please run the upgrade and migration commands on the ClickHouse host first.

Reconfigure Installation

This is required if you change /etc/instana/settings.yaml and do NOT wish to upgrade the packages (release) of an existing installation.

instana-configure

Upgrade Installation

This command will upgrade and configure/reconfigure the installation.

instana-update

Upgrading from Release 161

  • Release 164 will add a new improvements to the Application Dashboards.

    • This leads to a database migration that must be started at the end of the update.

      # Run all migrations as 'root' user, otherwise environment is not setup correctly
      sudo -i
      # 1. update all Instana packages
      instana-update
      # 2. run custom database migration scrips
      instana-migrate-164

Upgrading from Release 157

  • Release 161 will add a new component which needs an additional user:group.

    • thus you need to run this update as 'root'

      # Run all migrations as 'root' user, otherwise environment is not setup correctly
      sudo -i
      # 1. update all Instana packages
      instana-update

Upgrading from Release 150

  • We extended migrations that are needed for release 154

    • first run instana-update, this will update your local instana-commonap package
    • (only on ClickHouse host) run instana-migrate-150-clickhouse
    • afterwards you need to run instana-update which will update all other packages

      # Run all migrations as 'root' user, otherwise environment is not setup correctly
      sudo -i
      # 1. get latest instana-commonap package
      instana-update
      # 2. migrate clickhouse schema (run on ClickHouse host)
      instana-migrate-150-clickhouse
      # 3. update all other packages
      instana-update

Upgrading from Release 147

  • Starting with release 150 we replaced MongoDB and PostgreSQL with CockroachDB
  • Release 150 also purges Redis. Since release 147 we utilize Cassandra to store 1sec metrics for 24h
  • Please run the following commands to upgrade your installation:

    • first run instana-update, this will update your local instana-commonap package
    • then you have to run the data migration using instana-migrate-150
    • (only on ClickHouse host) run instana-migrate-150-clickhouse
    • afterwards you need to run instana-update which will update all other packages

      # Run all migrations as 'root' user, otherwise environment is not setup correctly
      sudo -i
      # 1. get latest instana-commonap package
      instana-update
      # 2. migrate existing data from MongoDB & Postgres -> CockroachDB
      instana-migrate-150
      # 3. migrate clickhouse schema (run on ClickHouse host)
      instana-migrate-150-clickhouse
      # 4. update all other packages
      instana-update

Upgrading from Release 143

  • The datastructure for ClickHouse changed from 143 to 144

    • first run instana-update, this will update your local instana-commonap package
    • you have to migrate tenant ClickHouse data to shared tables using the following steps (time estimate 1min - 5min)
    • Note: If upgrading multihost mode, instana-update must be run on both nodes.
    • Note: If upgrading multihost mode, the scripts must be run on the server on which ClickHouse is installed.

      # Run all migrations as 'root' user, otherwise environment is not setup correctly
      sudo -i
      # 1. get latest instana-commonap package
      instana-update
      # 2. run the following commands after upgrading to the newest version
      instana-migrate-appdata-144 -i
      instana-migrate-appdata-144 -m -c tu-config.txt -t BOTH
      # 3. migrate existing data from MongoDB & Postgres -> CockroachDB
      instana-migrate-150
      # 3. migrate clickhouse schema (run on ClickHouse host)
      instana-migrate-150-clickhouse
      # 5. update all other packages
      instana-update

Stop all components

This command will stop all the components of the backend setup (for automation, you can use a "-y" parameter to proceed without verification).

instana-stop

Start all components

This command will start all the components of the backend setup (for automation, you can use a "-y" parameter to proceed without verification).

instana-start

Initialize/Reset Installation

This command will initialize the installation, destroying existing data.

instana-init

Debug

This command will dump information for the system the backend should run on. In case something is wrong, this is a "first step."

instana-debug

This small program will gather information about the system, the hardware, the state of all the installed components, and their health. This data will then be piped out to stdout, nothing will be transmitted over the wire. Furthermore, a temporary directory is being created in /tmp (when the tool has sufficient write permissions) with JSON blobs of running Elasticsearch entities and healthchecks, as well as component configuration settings which will give our support engineers helpful information in case something needs to be adjusted.

Users and Groups Required

If system users cannot be added:

  • cassandra:cassandra
  • clickhouse:clickhouse
  • cockroachdb:cockroachdb
  • elasticsearch:elasticsearch
  • instana-acceptor:instana-acceptor
  • instana-accountant:instana-accountant
  • instana-ad-legacy-converter:instana-ad-legacy-converter
  • instana-appdata-processor:instana-appdata-processor
  • instana-appdata-reader:instana-appdata-reader
  • instana-appdata-writer:instana-appdata-writer
  • instana-butler:instana-butler
  • instana-cashier-ingest:instana-cashier-ingest
  • instana-cashier-rollup:instana-cashier-rollup
  • instana-eum-acceptor:instana-eum-acceptor
  • instana-eum-processor:instana-eum-processor
  • instana-filler:instana-filler
  • instana-groundskeeper:instana-groundskeeper
  • instana-issue-tracker:instana-issue-tracker
  • instana-processor:instana-processor
  • instana-ui-backend:instana-ui-backend
  • instana-ui-client:instana-ui-client
  • kafka:kafka
  • zookeeper:zookeeper