A JBoss Project
Red Hat

Aerogear Guides Tutorials to help get you off and running.

Digger Administration guide

AeroGear Digger Administration

The following text serves as a reference for AeroGear Digger components administration:

  • Nagios monitoring

  • Installing and configuring Jenkins Plugins

  • Using HTTP proxy for Digger installation and …​ -

Installing Jenkins plugins

Digger will by default install a number of Jenkins plugins required for its proper operation. If more Jenkins plugins are required, they can be installed by including them in Ansible playbook or using the Jenkins UI.

Plugins for Jenkins can be found at https://plugins.jenkins.io

Using Ansible Playbook

The jenkins_plugins parameter can be overridden to include new plugins. The structure of a Jenkins plugin is as follows.

-
  name: sample-plugin
  version: 1.20
  archive: http://updates.jenkins-ci.org/download/plugins/sample-plugin/1.20/sample-plugin.hpi

Using Jenkins UI

Go to Manage Jenkins → Manage Plugins. If the plugin is not available in the Available tab then it can be installed by uploading an .hpi file in Advanced → Upload Plugin.

Digger Nagios Monitoring

Nagios is provisioned by default by the Digger Ansible playbook. Once Nagios is successfully installed, a number of checks are triggered by the playbook:

  • Check that the Android PVC (PersistentVolumeClaim) is Bound

  • Check that the macOS server is running is accessible by Jenkins

  • Check that the Jenkins instance is running

The URL and credentials for accessing the Nagios instance will be provided when the Ansible job has completed its provisioning.

Using HTTP/HTTPS Proxy with Aerogear Digger

HTTP Proxies that require authentication are not supported. Please check the Known Issues for more details.

If you want to install the Digger behind proxy, the installer will automatically configure the following components to use the proxy (if an outbound Internet access is required):

  • The Jenkins server

  • The Android SDK pod used to download Android SDKs

  • Container/node that will run the build jobs, by adding the appropriate environment variables like HTTP_PROXY and HTTPS_PROXY in the inventory file. Sample provided in AeroGear Digger GitHub repo.

  • macOS servers used to run iOS builds

Ansible Variables Regarding HTTP/HTTPS Proxy

You can run AeroGear Digger behind a HTTP proxy server by setting the following Ansible Variables:

Variable name

Description

proxy_url

This URL is pasted into http_proxy and https_proxy environment variables.

proxy_host

The host name of the proxy server. Follow URL format <host>:<port> e.g. 127.0.0.1:8080

proxy_port

The port number of the proxy

proxy_user

Required if proxy authentication is enabled

proxy_pass

Required if proxy authentication is enabled

proxy_protocol

Optional. The protocol to use with the proxy. Default value is http.

You can define these variables either in an inventory file, or via CLI. Please refer to the Ansible Playbook Variables Docs for more details.

Using external tools with HTTP/HTTPS Proxy

If you want to use the external tools with HTTP/HTTPS proxy, you will have to manually update the configuration for those tools in the Jenkinsfile, using the values from the environment variables such as HTTP_PROXY and HTTPS_PROXY.

Known issues

List of known issues can be found in the Installation Guide - Known Issues

redhatlogo-wite