Installing and Updating Packages

Packages are available in the online Humio Marketplace and as standalone files, either shared as a Zip file or through a repository such as Github.

There are two methods available for installing a package:

If you decide to use the User Interface, you will be able to merge local changes with changes made in the new version of the package.

Package UI Installation

To install a package from the Humio Marketplace:

  1. Go to the Marketplace under the Settings tab in your view.

  2. Choose a package from the to the package summary.

  3. Choose the version of the package you want to install. The default version will be the latest version available, but you can select to install an earlier version if you wish.

  4. Click the Install package button.

  5. You will be presented with a summary of the components that will be installed.

    Figure 1, Package installation confirmation
  6. Click the Install button to install the package. Click the Cancel button to return to the package summary.

  7. Once the package has been installed, you will be taken to the Installed package list

Once you have installed a package, it will appear under the Packages ‣ Installed section of the Settings tab.

If you installed a library, you will now be able to navigate to dashboards, saved queries, alerts and parsers and from there create a new component based on a template from that library.

If you installed an application you will also be able to create new components based on the components within the application in the same way as when you install a library.

When using a component, you will find a grouping in the lists of components with the name of the application and under that you will find these managed components. Application components are freely customizable, including deleting parts not required. However, care should be taken as deleting components may implications when updating the package as updating an application will re-install deleted components.

Installing a Package from a File

To install a package from a Zip file that you have downloaded:

  1. Go to the Marketplace under the Settings tab in your view

  2. Go to Installed packages list under the Settings tab

  3. Click the Upload button.

  4. You can either drag and drop a package from your machine, or use the file selector to navigate and choose a package Zip file from your local machine.

  5. You will be presented with a summary of the components that will be installed when the package has been added to your system.

  6. Click the Install button to install the package. Click the Cancel button to return to the package summary.

  7. Once the package has been installed, you will be taken to the Installed package list

Once you have installed a package, it will appear under the Packages ‣ Installed section of the Settings tab.

Updating Packages using UI

To update a package through the UI:

  1. Go to the Packages section under the Settings tab in your view.

  2. You can either go to: 1. The Marketplace 2. If a package update is available in the Marketplace, an Update Available note will be shown next to the installed package in the list of available packages. 3. Selecting the package will show the Package summary; the you will see a Update to this version button. You can update a different version and not just the latest version available. Or: 1. The Installed page. 2. Selecting a package will show the package summary and an Update button.

  3. You will be presented with an update dialog that will list the components that will be updated or changed with this update.

    Figure 2, Package Update confirmation
  4. To update click Update, this will take you through the update process. Once the update has been completed you will be sent to the Installed section of the Packages view.

In the case of libraries, the component templates from the package are updated. Templates that have been modified from the original package remain unchanged.

For applications, where component templates are materialized during installation and afterwards managed by Humio, you may encounter conflicts during the upgrade process. Conflicts arise when you have made local changes to an application component prior to updating it. For example, if you installed an application with a dashboard and you’ve changed a widget of that dashboard, a conflict may occur when you update that application. In order to resolve conflict while updating an application Humio supports a basic Use Ours/Theirs merging view that lets you choose what to do with each conflicting component, meaning you either keep the modified version or replace it completely with the new version.

If you are using the Humio CLI you are able to entirely overwrite the installed package without handling update conflicts.

Updating a Package from a File

To update an existing package from a file:

  1. Go to the Marketplace under the Settings tab in your view

  2. Go to Installed packages list under the Settings tab

  3. Click the Upload button.

  4. You can either drag and drop a package from your machine, or use the file selector to navigate and choose a package Zip file from your local machine.

  5. You will be presented with an update dialog that will list the components that will be updated or changed with this update.

  6. To update click Update, this will take you through the update process.

Once the update has been completed you will be sent to the Installed section of the Packages view.

Package CLI Installation with humioctl

Installing packages this way will override any manual modification made in the UI. This is equivalent to a force push in git terminology. Any changes must be exported and placed in source control.

Let’s install the package we just exported and unzipped:

shell
humioctl packages install /path/to/my/packages/root/

Alternatively, if you’re maintaining your package on Github you can install from the Github URL,

shell
humioctl packages install https://github.com/myorg/my-package/

Or you can point directly to the zip file you just created:

shell
humioctl packages install /path/to/my/package.zip

There are a few more options that you can read about using humioctl packages install –help.

Uninstall a Package using the UI

If you want to uninstall a package you can do so through the UI or the CLI. Doing so will remove the components and templates previously installed by the package, even those that might currently be in use on your system.

To uninstall a package through the UI

  1. Go to the Marketplace under the Settings tab in your view

  2. Go to Installed packages list under the Settings tab

  3. Choose the package you want to Uninstall

  4. Click the Uninstall button

  5. You will be prompted that uninstalling the package will remove all components, including those you are currently using from your system. You will need to enter the full name of the package to confirm deletion.

Uninstall a Package using the CLI

To uninstall a package using the CLI, you must quote the package name:

shell
humioctl packages uninstall github/events