CKAN Puppet Module

About

This module installs, configures, and manages ckan. Customizations such as site logo, about page, license, and customized css are easily configurable from this module.
The ckan database is automatically backed up every day to <backup_dir>/ckan_database.pg_dump.

Installation

The module can be obtained from the Puppet Forge. The easiest method for installation is to use the puppet-module tool. Run the following command from your modulepath:

puppet-module install landcareresearch/ckan

Requirements

In order to get all of the dependencies do the following:

• puppet module install landcareresearch-ckan

Other Requirements

• Ubuntu 12.04, 14.04, 16.04 Operating System.

Administration

Once ckan is setup and installed, its necessary to manage the instance through several command line tools.

Create Admin Account

Creating an admin account has been simplified with the use of the following command:

/usr/local/bin/ckan_create_admin.bash <USERNAME> <EMAIL>

Purge Account

CKAN currently doesn't enable automation in purging users. You can easily deactivate a user from the web ui. There is a paster command for marking a user as 'deleted' but that user is still in the system. In order to completely remove (purge) a user from the system, use the following command:

/usr/local/bin/ckan_purge_account.bash <USERNAME>

Backups

In order to backup the entire ckan installation, the database and the file store need to be included in your backup system. The following paths should be backed up.

• <backup_dir>/ckan_database.pg_dump
• /var/lib/ckan/default/resources
• /var/lib/ckan/default/storage

Backup Recovery

In order to recover from a data failure or to just install a new instance do the following as root.

/usr/local/bin/ckan_recover_db.bash

Upgrading ckan puppet module

Its currently unsupported to upgrade between minor versions. For instance version 0.2.x to version 0.3.x. Please see the change log for more details. Its highly recommended to provision a clean system when moving between major and minor versions. Upgrading between build versions can be done on existing systems.

Upgrading CKAN

Upgrading between ckan versions is currently not fully automated via puppet. To upgrade on an existing server, just change the ckan version. After puppet is run with the new ckan version, there are two scripts that can be used after the upgrade.

• /usr/local/bin/ckan_upgrade_db.bash
• /usr/loca/bin/ckan_upgrade_version.bash

ckan_upgrade_db will upgrade the database schema between versions.
ckan_upgrade_version will create the necessary views.

Classes

See REFERENCE.md for details.

Extensions The following are classes that utilize the ckan modularization framework known as extensions. To fully realize the plugin, puppet needs to be run twice. The first time puppet runs, the extension won't be added to ckan due to how this module manages the plugins.

See REFERENCE.md for details on the ext classes.

Manual Configuration

A systems admin account is still required to be created manually. If using Ubuntu, use the following command:

/usr/local/bin/ckan_create_admin.bash <username>

Usage

This section shows example uses of the ckan module.

Example 1

This example demonstrates the most basic usage of the ckan module.

class { 'ckan':
  site_url              => 'test.ckan.com',
  site_title            => 'CKAN Test',
  site_description      => 'A shared environment for managing Data.',
  site_intro            => 'A CKAN test installation',
  site_about            => 'Pilot data catalogue and repository.',
  plugins               => 'stats text_preview recline_preview datastore resource_proxy pdf_preview',
  app_instance_id       => '{xxxxxxxxxxxxxxxx}',
  beaker_secret         => 'xxxxxxxxxxxx',
  is_ckan_from_repo     => 'false',
  ckan_package_url      => 'http://packaging.ckan.org/python-ckan_2.2_amd64.deb',
  ckan_package_filename => 'python-ckan_2.2_amd64.deb',
}

Example 2

This example demonstrates a customize the ckan module.

Declaring a class that manages the configuration files.

class {landcare_ckan::config: }

Declaring the ckan module with the customized parameters.

class { 'ckan':
  site_url              => 'test.ckan.zen.landcareresearch.co.nz',
  site_title            => 'Landcare Research Test CKAN Repository',
  site_description      => 'A shared environment for managing Landcare Research Data.',
  site_intro            => 'Welcome to the Landcare Research Pilot Data Repository. This is a trial installation of the CKAN software, for us to test ahead of (all going well) a wider company rollout.',
  site_about            => 'Pilot data catalogue and repository for [Landcare Research] (http://www.landcareresearch.co.nz)',
  plugins               => 'stats text_preview recline_preview datastore resource_proxy pdf_preview',
  app_instance_id       => '{xxxxxxxxxxxxxxxx}',
  beaker_secret         => 'xxxxxxxxxxxx',
  site_logo             => $landcare_ckan::config::logo_src,
  license               => $landcare_ckan::config::license_src,
  is_ckan_from_repo     => false,
  ckan_package_url      => 'http://packaging.ckan.org/python-ckan_2.2_amd64.deb',
  ckan_package_filename => 'python-ckan_2.2_amd64.deb',
  custom_css            => $landcare_ckan::config::css_src,
  custom_imgs           => $landcare_ckan::config::custom_images_array,
  require               => Class['landcare_ckan::config'],
}

Class where the customized configuration files are managed

class landcare_ckan::config {
  $img_dir             = '/usr/lib/ckan/default/src/ckan/ckan/public/base/images'
  $landcare_src        = 'puppet:///modules/landcare_ckan'
  $css_src             = "$landcare_src/custom.css"
  $background_img_src  = "$landcare_src/LCR-ckan-homepage-background.jpg"
  $custom_images_array = [$background_img_src]
  $logo_filename       = 'lcr_logo_white_sm.png'
  $logo_src            = "$landcare_src/$logo_filename"
  $license             = 'NZ_licenses_ckan.json'
  $license_src         = "$landcare_src/$license"
  $backup_dir          = '/backup',
}

Deploying with Vagrant

Vagrant can be used to easily deploy the ckan module for testing or production environments. Vagrant was used for the development of the ckan module.

Vagrantfile

The following content should be copied to a clean Vagrantfile. Note, make sure to edit puppet.module_path with a path to where the ckan module and the ckan module dependencies are located.

# -*- mode: ruby -*-
# vi: set ft=ruby :
Vagrant.configure("2") do |config|
  config.vm.box = "precise64"
  config.vm.box = "ubuntu/precise64"

  config.vm.network "private_network", ip: "192.168.33.10"
  config.vm.provider "virtualbox" do |v| 
    v.memory = 2048
    v.cpus = 1 
  end 

  config.vm.provision :shell, :path => "upgrade-puppet.sh"

  config.vm.provision "puppet" do |puppet|
    puppet.module_path = "</path to modules>/modules/"
    puppet.manifests_path = "manifests"
    puppet.manifest_file  = "test-ckan.pp"
  end 
end

test-ckan.pp

This is the file that contains the declaration of the ckan module. The file test-ckan.pp should be created in project_home/manifests/.

class { 'ckan':
  site_url              => 'http://192.168.33.10',
  site_title            => 'CKAN Test',
  site_description      => 'A shared environment for managing Data.',
  site_intro            => 'A CKAN test installation',
  site_about            => 'Pilot data catalogue and repository.',
  plugins               => 'stats text_preview recline_preview datastore resource_proxy pdf_preview',
  app_instance_id       => '{xxxxxxxxxxxxxxxx}',
  beaker_secret         => 'xxxxxxxxxxxx',
  is_ckan_from_repo     => false,
  ckan_package_url      => 'http://packaging.ckan.org/python-ckan_2.2_amd64.deb',
  ckan_package_filename => 'python-ckan_2.2_amd64.deb',
  pg_hba_conf_defaults  => true,
}

upgrade-puppet.sh

This file manages installing the latest puppet from puppetlabs and updates apt-get The file upgrade-puppet.sh should be created in project_home/ (same directory as the Vagrantfile).

#!/bin/bash

DISTRIB_CODENAME=$(lsb_release --codename --short)
DEB="puppetlabs-release-${DISTRIB_CODENAME}.deb"
DEB_PROVIDES="/etc/apt/sources.list.d/puppetlabs.list" # Assume that this file's existence means we have the Puppet Labs repo added

if [ ! -e $DEB_PROVIDES ]
then
    apt-get install --yes lsb-release
    # Print statement useful for debugging, but automated runs of this will interpret any output as an error
    # print "Could not find $DEB_PROVIDES - fetching and installing $DEB"
    wget -q http://apt.puppetlabs.com/$DEB
    sudo dpkg -i $DEB
    sudo apt-get update
    sudo apt-get install --yes puppet
fi

Usage

In the project directory (vagrant directory),

• Run vagrant: vagrant up
• Wait for vagrant to finish deploying and installing ckan Basically, wait for the console to return. You will see the following line:

notice: Finished catalog run in 648.91 seconds

• Open a web browser and enter the following url http://192.168.33.10

Limitations

Only works with debian based OS's.

Development

The module is Free and Open Source Software. Its available on bitbucket. Please fork!

Reference

Classes

• ckan: Installs, configures, and manages ckan.
• ckan::ext::archiver: Installs the archiver extension.
• ckan::ext::dcat: Installs the dcat extension.
• ckan::ext::galleries: Installs the "galleries" extension.
• ckan::ext::geoview: Installs the geoview extension.
• ckan::ext::googleanalytics: Installs the "googleanalytics" extension.
• ckan::ext::harvest: Installs the harvest extension.
• ckan::ext::hierarchy: Installs the "hierarchy" extension from data.gov.uk.
• ckan::ext::lcrnz: Installs the Landcare Research extension.
• ckan::ext::ldap: Installs the "ldap" extension.
• ckan::ext::officedocs: Installs the officedocs extension.
• ckan::ext::pages: Installs the pages extension.
• ckan::ext::pdfview: Installs the "pdf_view" extension
• ckan::ext::private_datasets: This CKAN extension allows a user to create private datasets.
• ckan::ext::repeating: Installs the "repeating" extension.
• ckan::ext::report: Installs the report extension.
• ckan::ext::showcase: Installs the showcase extension.
• ckan::ext::spatial: Installs the "spatial" extension.
• ckan::ext::viewhelpers: Installs the viewhelpers extension.
• ckan::ext::zippreview: Installs the zippreview extension.
• ckan::redis: A simple non-configured redis server install for the harvest extension.

Defined types

• ckan::ext: A type which can be used to install a CKAN extension in the default location.
• ckan::lang: Manages installing a non default language.

Classes

ckan

Install Details: http://docs.ckan.org/en/ckan-2.0/install-from-package.html

Additional features:

• Database can be backed up to <backup_dir>/ckan_database.pg_dump determined by the frequency selected.

COPYRIGHT

GPL-3.0+

Examples

Default Setup

class { 'ckan':
  site_url              => 'test.ckan.com',
  site_title            => 'CKAN Test',
  site_description      => 'A shared environment for managing Data.',
  site_intro            => 'A CKAN test installation',
  site_about            => 'Pilot data catalogue and repository.',
  plugins               =>
   text_preview recline_preview datastore resource_proxy pdf_preview',
  is_ckan_from_repo     => 'false',
  ckan_package_url      =>
   'http://packaging.ckan.org/python-ckan_2.1_amd64.deb',
  ckan_package_filename => 'python-ckan_2.1_amd64.deb',
}

Parameters

The following parameters are available in the ckan class.

site_url

Data type: String

The url for the ckan site.

Default value: 'localhost'

site_title

Data type: String

The title of the web site.

Default value: 'localhost'

site_description

Data type: Optional[String]

The description (found in header) of the web site.

Default value: undef

site_intro

Data type: Optional[String]

The introduction on the landing page.

Default value: undef

site_about

Data type: Optional[String]

Information on the about page.

Default value: undef

plugins

Data type: Optional[Array[String]]

Contains the ckan plugins to be used by the installation. Do not include the following plugins as they are defaults and are already included. DO NOT INCLUDE: ['stats','text_view','image_view','recline_view'] @example plugins => ['text_preview','datastore','resource_proxy', 'datapusher']

Default value: undef

app_instance_id

Data type: Optional[String]

The secret password for the app instance . To generate a config file that contains a new password, run the following command: @example 'paster make-config ckan /etc/ckan/default/dev.ini'

Default value: undef

beaker_secret

Data type: Optional[String]

The secret password for beaker. To generate a config file that contains a new password, run the following command. @example 'paster make-config ckan /etc/ckan/default/dev.ini'

Default value: undef

site_logo

Data type: Optional[String]

The source of the logo. Should be specified as puppet:////.png Requires the png file extension.

Default value: undef

license

Data type: String

The source to the json license file. Should be specified as puppet://// and maintained by your module

Default value: 'puppet:///modules/ckan/license.json'

ckan_version

Data type: Optional[String]

Helps identify settings and configuration necessary between the different version of ckan. Valid formats:

• '2.2'
• '2.3'
• eq: 'x.y'

Note, ckan_package_url & ckan_package_filename are not set, than the ckan version will use the package url from ckan.org and the appropriate name.

Default value: undef

is_ckan_from_repo

Data type: Boolean

A boolean to indicate if the ckan package should be installed through an already configured repository setup outside of this module. If using Ubuntu/Deb should be able to do "apt-get install python-ckan" Its the same idea for yum and other package managers.

Default value: false

ckan_package_url

Data type: Optional[String]

If not using a repo, then this url needs to be specified with the location to download the package. Note, this is using dpkg so deb/ubuntu only.

Default value: undef

ckan_package_filename

Data type: Optional[String]

The filename of the ckan package.

Default value: undef

custom_css

Data type: String

The source to a css file used for the ckan site. This replaces the default main.css. Should be specified as puppet://// and maintained by your module. Images used in the custom css should be set in custom_imgs.

Default value: 'main.css'

custom_imgs

Data type: Optional[Array[String]]

An array of source for the images to be used by the css. Should be specified as ['puppet:////','...']

Default value: undef

recaptcha_version

Data type: String

The version of recaptcha. Valid options:

• 1 Older style with a red box. The user enters text
• 2 Newer style that the user clicks on a checkbox (cleaner).

@see recaptcha-version

Default value: '2'

recaptcha_publickey

Data type: Optional[String]

The public key for recaptcha. @see ckan-recaptcha-publickey

Default value: undef

recaptcha_privatekey

Data type: Optional[String]

The private key for recaptcha. @see recaptcha-privatekey

Default value: undef

max_resource_size

Data type: String

The maximum in megabytes a resource upload can be. @see max-resource-size

Default value: '100'

max_image_size

Data type: String

The maximum in megabytes an image upload can be. @see max-image-size

Default value: '10'

max_file_size

Data type: String

This sets the upper file size limit for in-line previews. @see resource-proxy-max-file-size

Default value: '1048576'

datapusher_formats

Data type: String

File formats that will be pushed to the DataStore by the DataPusher. When adding or editing a resource which links to a file in one of these formats, the DataPusher will automatically try to import its contents to the DataStore.

Default value: 'csv xls application/csv application/vnd.ms-excel'

default_views

Data type: Array[String]

Defines the resource views that should be created by default when creating or updating a dataset. From this list only the views that are relevant to a particular resource format will be created. This is determined by each individual view.

Default value: ['image_view','recline_view']

text_formats

Data type: String

Formats used for the text preview. @see http://docs.ckan.org/en/latest/maintaining/configuration.html#ckan-preview-text-formats

Default value: 'text plain text/plain'

json_formats

Data type: String

JSON based resource formats that will be rendered by the Text view plugin @see http://docs.ckan.org/en/latest/maintaining/configuration.html#ckan-preview-json-formats

Default value: 'json'

xml_formats

Data type: String

XML based resource formats that will be rendered by the Text view plugin @see http://docs.ckan.org/en/latest/maintaining/configuration.html#ckan-preview-xml-formats

Default value: 'xml rdf rss'

image_formats

Data type: String

Space-delimited list of image-based resource formats that will be rendered by the Image view plugin @see http://docs.ckan.org/en/latest/maintaining/configuration.html#ckan-preview-image-formats

Default value: 'png jpeg jpg gif'

postgres_pass

Data type: String

The password for the postgres user of the database (admin user).

Default value: 'pass'

ckan_pass

Data type: String

The password for the ckan user of the database.

Default value: 'pass'

pg_hba_conf_defaults

Data type: Boolean

True if use the default hbas and false to configure your own. This module uses postgresql so this setting informs the postgresql module that the hba's should be handled outside of this module. Requires your own hba configuration.

Default value: true

pg_hba_rules

Data type: Optional[Hash]

This is a hash which uses create_resources to create the hba rules. Optional. The hba rules can also be defined outside of this class.

Default value: undef

postgis_version

Data type: String

The version of postgis to use.

• '2.1' uses postgresql 9.4
• '2.2' uses postgresql 9.5
• '2.3' uses postgresql 9.6
• '2.4' uses postgresql 9.6
• '2.5' uses postgresql 10

Default value: $ckan::params::postgis_version

install_ckanapi

Data type: Boolean

Installs the ckan api if set to true. Also installs a helper script in /usr/bin/ckan/ckanapi.bash which launches ckanapi with the environment setup.

@see https://github.com/ckan/ckanapi

Default value: false

enable_backup

Data type: Boolean

Backs up the database to /backup/ckan_database.pg_dump.

Default value: true

backup_daily

Data type: Boolean

If backups enabled, sets backups to either daily (true) or weekly (false).

Default value: true

backup_dir

Data type: String

The location where backups are stored.

Default value: '/backup'

solr_url

Data type: String

The base url for downloading solr.

Default value: 'http://archive.apache.org/dist/lucene/solr'

solr_version

Data type: String

The version of solr to install.

Default value: '5.5.3'

solr_schema_version

Data type: String

The version of the solr schema to use. Valid options:

• '1.2'
• '1.3'
• '1.4'
• '2.0'
• 'spatial' - configures solar with the spatial extensions. Only supports bounding box.
• 'spatial-ext' - configures solar with the extended spatial extension. This allows for bounding box, point, and Polygon.
• 'default'

The options correspond to the following structure:

/usr/lib/ckan/default/src/ckan/ckan/config/solr/schema-<solr_schema_version>

The only exception is default which means schema.xml (required as of ckan 2.3).

Default value: 'default'

solr_jts_url

Data type: String

The url to be used to download the jts library for solr spatial ext. Only used if spatial-ext option is set.

Default value: $ckan::params::jts_url

locale_default

Data type: String

Use this to specify the locale (language of the text) displayed in the CKAN Web UI.

Default value: 'en'

i18n_directory

Data type: Optional[String]

By default, the locales are searched for in the ckan/i18n directory. Use this option if you want to use another folder.

Default value: undef

ckan_storage_path

Data type: String

The location where files will be stored for the file store. Note, this module handles creating the directory; however, ensure the path leading up to the directory has already been created.

Default value: '/var/lib/ckan/default'

display_timezone

Data type: String

By default, all datetimes are considered to be in the UTC timezone. Use this option to change the displayed dates on the frontend. Internally, the dates are always saved as UTC. This option only changes the way the dates are displayed. The valid values for this options can be found at pytz Available from CKAN 2.5+ (has no effect on previous versions).

Default value: 'UTC'

feeds_author_name

Data type: String

This controls the feed author’s name. If unspecified, it’ll use ckan.site_id. @see feeds-author-name

Default value: ''

feeds_author_link

Data type: String

This controls the feed author’s link. If unspecified, it’ll use ckan.site_url. @see feeds-author-link

Default value: ''

feeds_authority_name

Data type: String

The domain name or email address of the default publisher of the feeds and elements. If unspecified, it’ll use ckan.site_url. @see feeds-authority-name

Default value: ''

feeds_date

Data type: String

A string representing the default date on which the authority_name is owned by the publisher of the feed. @see feeds-date

Default value: ''

smtp_server

Data type: Optional[String]

The SMTP server to connect to when sending emails with optional port. The format is : @example: smtp.example.com:587 @see smtp-server

Default value: undef

smtp_starttls

Data type: Optional[String]

Whether or not to use STARTTLS when connecting to the SMTP server. @see smtp-starttls

Default value: undef

smtp_user

Data type: Optional[String]

The username used to authenticate with the SMTP server. Example: username@example.com @see smtp-user

Default value: undef

smtp_password

Data type: Optional[String]

The password used to authenticate with the SMTP server. @see smtp-password

Default value: undef

smtp_mail_from

Data type: Optional[String]

The email address that emails sent by CKAN will come from. Note that, if left blank, the SMTP server may insert its own. Example: ckan@example.com @see smtp-mail-from

Default value: undef

email_errors_to

Data type: Optional[String]

An e-mail address to send any error reports to. Example: errors@example.com @see email-errors-to

Default value: undef

email_errors_from

Data type: Optional[String]

The from e-mail address to use when sending any error reports. Example: ckan-errors@example.com @see email-errors-from

Default value: undef

roles_cascade

Data type: Optional[String]

Makes role permissions apply to all the groups down the hierarchy from the groups that the role is applied to. @see roles-cascade

Default value: undef

featured_orgs

Data type: Optional[String]

Defines a list of organization names or ids. Example: 'org_one' @see featured-orgs

Default value: undef

featured_groups

Data type: Optional[String]

Defines a list of group names or group ids. Example: 'group_one' @see featured-groups

Default value: undef

activity_streams_enabled

Data type: Boolean

Turns on and off the activity streams used to track changes on datasets, groups, users, etc @see activity-streams-enabled

Default value: true

activity_streams_email_notifications

Data type: Boolean

Turns on and off the activity streams’ email notifications. @see activity-streams-email-notifications

Default value: false

tracking_enabled

Data type: Boolean

This controls if CKAN will track the site usage. @see tracking-enabled

Default value: false

use_ssl

Data type: Boolean

Enable SSL for the site.

Default value: false

use_google_verification

Data type: Boolean

Enable google verification in the nginx configuration.

Default value: false

use_nagios

Data type: Boolean

Use a /nagios.txt in the nginx configuration file.

Default value: false

google_verification_string

Data type: Optional[String]

The google verification string.

Default value: undef

ssl_cert_path

Data type: Optional[String]

The path to the ssl certificate for nginx.

Default value: undef

ssl_key_path

Data type: Optional[String]

The path to the ssl key for nginx.

Default value: undef

ckan::ext::archiver

Installs the archiver extension.

• See also https://github.com/ckan/ckanext-archiver

Parameters

The following parameters are available in the ckan::ext::archiver class.

ckan_conf

Data type: String

Default value: $ckan::params::ckan_conf

paster

Data type: String

Default value: $ckan::params::paster

ckan::ext::dcat

Note, requires the harvest extension.

• See also https://github.com/ckan/ckanext-dcat

Parameters

The following parameters are available in the ckan::ext::dcat class.

revision

Data type: String

The version of dcat to install from github. Can be a git branch or git label.

Default value: 'v0.0.7'

ckan::ext::galleries

This extension allows storing and referencing image and video assets.

This extension does not install properly on Ubuntu 12.04.

• See also https://github.com/DataShades/ckan-galleries

ckan::ext::geoview

Requirements:

In order for this module to update the default_views parameter, it MUST be declared before the ckan module in the manifests. This will allow all of the variables to be evaulated.

Also, ensure that resource_proxy plugin has been enabled.

• See also https://github.com/ckan/ckanext-geoview

Parameters

The following parameters are available in the ckan::ext::geoview class.

openlayers_viewer_enable

Data type: Boolean

Default value: true

openlayers_formats

Data type: String

A string seperated by spaces. Available formats

• Web Map Service (WMS) wms
• Web Feature Service (WFS) wfs
• GeoJSON geojson
• GML gml
• KML kml
• ArcGIS REST API arcgis_rest
• Google Fusion Tables gft (requires google_api_key)

Default value: 'wms geojson'

openlayers_hide_overlays

Data type: Boolean

Overlays won't be visible by default (only the base layer)

Default value: false

openlayers_hoveron

Data type: Boolean

The feature data popup will be displayed when hovering on.

Default value: true

openlayers_google_api_key

Data type: Optional[String]

The google api key required to render google fusion table resources. @see https://developers.google.com/fusiontables/docs/v1/using#APIKey

Default value: undef

leaflet_geojson_viewer_enable

Data type: Boolean

Default value: true

leaflet_wmts_viewer_enable

Data type: Boolean

Default value: true

ckan::ext::googleanalytics

Sends tracking data to Google Analytics and retrieves statistics from Google Analytics and inserts them into CKAN pages.

You should enable the "googleanalytics" plugin to use this extension.

• See also https://github.com/ckan/ckanext-googleanalytics

Parameters

The following parameters are available in the ckan::ext::googleanalytics class.

id

Data type: String

The Google Analytics tracking ID (usually of the form UA-XXXXXX-X).

account

Data type: String

The account name @example example.com @see https://www.google.com/analytics).

username

Data type: String

Google Analytics username.

password

Data type: String

Google Analytics password.

track_events

Data type: Boolean

Adds Google Analystics Event tracking.

Default value: false

revision

Data type: String

The revision (or version) of the source to checkout with git.

Default value: 'master'

ckan::ext::harvest

Installs the harvest extension.

• See also https://github.com/ckan/ckanext-harvest

Parameters

The following parameters are available in the ckan::ext::harvest class.

revision

Data type: String

The revision to use (a git label or git branch).

Default value: 'v1.1.1'

ckan_conf

Data type: String

Default value: $ckan::params::ckan_conf

paster

Data type: String

Default value: $ckan::params::paster

cron_job

Data type: String

Sets the ensure state of the cron job. Options: the standard options for the ensure parameter.

Default value: 'present'

cron_interval

Data type: String

The minute that cron will run (so will run every hour at the specified minute).

Default value: '5'

cron_warning

Data type: String

Check if there is no previous long running harvester instance, if there is and has been running longer then $WARN seconds complain about it as it might be stuck.

Default value: '21600'

ckan::ext::hierarchy

This extension allows organizations to have parents, and displays them in a tree.

• See also https://github.com/datagovuk/ckanext-hierarchy

ckan::ext::lcrnz

Requirements:

Installs the following extensions.

• ckan::ext::repeating
• ckan::ext::ldap

The id can be found at the following url: http://<CKAN URL/api/action/organization_show?id=

Parameters

The following parameters are available in the ckan::ext::lcrnz class.

uri

Data type: String

The uri to the ldap server to connect. @example 'ldap://localhost:389'

base_dn

Data type: String

The ldap base dn to use for user authentication. @example 'ou=users,dc=landcareresearch,dc=co,dc=nz'

source

Data type: String

The source of the git repository for this extension.

Default value: 'http://github.com/okfn/ckanext-lcrnz'

revision

Data type: String

The revision (or version) of the source to checkout with git.

Default value: 'master'

organization_id

Data type: Optional[String]

If this is set, users that log in using LDAP will automatically get added to the given organization.

Default value: undef

ckan::ext::ldap

Installs the "ldap" extension.

Parameters

The following parameters are available in the ckan::ext::ldap class.

uri

Data type: String

The uri to the ldap server to connect. @example 'ldap://localhost:389'

base_dn

Data type: String

The ldap base dn to use for user authentication. @example 'ou=users,dc=landcareresearch,dc=co,dc=nz'

search_filter

Data type: String

The filter for searching through identities in ldap.

Default value: 'uid={login}'

username

Data type: String

The user name to use as a lookup.

Default value: 'uid'

email

Data type: String

The field that contains the user's email address.

Default value: 'mail'

fullname

Data type: String

The field that contains the user's full name.

Default value: 'cn'

organization_role

Data type: String

The role of the user when logged in through ldap.

Default value: 'member'

organization_id

Data type: Optional[String]

If this is set, users that log in using LDAP will automatically get added to the given organization.

To create the organisation specified in ckanext.ldap.organization.id use the paste command:

/etc/ckan/default/development.ini```

Default value: `undef`

### ckan::ext::officedocs

For this extension to work, the documents to be previewed must be accessible
to the wider internet, and will only work if you use a hostname, and not just
an IP address.

* **See also**
http://extensions.ckan.org/extension/officedocs/

#### Parameters

The following parameters are available in the `ckan::ext::officedocs` class.

##### `ckan_conf`

Data type: `String`



Default value: $ckan::params::ckan_conf

##### `paster`

Data type: `String`



Default value: $ckan::params::paster

### ckan::ext::pages

Installs the pages extension.

* **See also**
https://github.com/ckan/ckanext-pages

### ckan::ext::pdfview

If you want to enable pdf views of documents outside of
the ckan instance, you will need to enable resource_proxy plugin.

* **See also**
https://github.com/ckan/ckanext-pdfview

### ckan::ext::private_datasets

Only certain users will be able to see. When a dataset is being created,
it's possible to specify the list of users that can see this dataset.

* **See also**
https://github.com/conwetlab/ckanext-privatedatasets

#### Parameters

The following parameters are available in the `ckan::ext::private_datasets` class.

##### `show_acquire_url_on_create`

Data type: `Boolean`

To show the Acquire URL when the user is creating a dataset.

Default value: `false`

##### `show_acquire_url_on_edit`

Data type: `Boolean`

To show the Acquire URL when the user is editing a dataset

Default value: `false`

### ckan::ext::repeating

This extension provides a way to store repeating fields in CKAN datasets,
resources, organizations and groups.

* **See also**
https://github.com/open-data/ckanext-repeating

### ckan::ext::report

Installs the report extension.

* **See also**
https://github.com/datagovuk/ckanext-report

#### Parameters

The following parameters are available in the `ckan::ext::report` class.

##### `ckan_conf`

Data type: `String`



Default value: $ckan::params::ckan_conf

##### `paster`

Data type: `String`



Default value: $ckan::params::paster

### ckan::ext::showcase

Installs the showcase extension.

* **See also**
https://github.com/ckan/ckanext-showcase

### ckan::ext::spatial

Allows for the association of datasets with geographic locations, and
for searches across datasets to be restricted to a particular geographical
area. Additionally, it provides some support for previewing
geographical datasets.

* **See also**
http://docs.ckan.org/projects/ckanext-spatial/en/latest/

#### Parameters

The following parameters are available in the `ckan::ext::spatial` class.

##### `template`

Data type: `String`

The name the template that spatial will modify.
Note, this will overwrite the following files:

* templates/package/search.html
* templates/package/read_base.html

##### `map_provider`

Data type: `String`

Which map provider to use. Options:

* 'mapquest'
* 'openstreetmap'

Default value: 'mapquest'

##### `default_extent`

Data type: `Optional[String]`

Sets the default extent for the map.  Should be a string in the format:

'[[15.62, -139.21], [64.92, -61.87]]'

 or GeoJSON

'{ \"type\": \"Polygon\", \"coordinates\": [[[74.89, 29.39],[74.89, 38.45], [60.50, 38.45], [60.50, 29.39], [74.89, 29.39]]]}'

If undefined, will not set an extent.

Default value: `undef`

### ckan::ext::viewhelpers

Installs the viewhelpers extension.

* **See also**
https://github.com/ckan/ckanext-viewhelpers

### ckan::ext::zippreview

Installs the zippreview extension.

* **See also**
https://github.com/datagovau/ckanext-zippreview

### ckan::redis

There's too many redis modules in the forge to make a good assessment or to
enforce the use of any particular one of them for CKAN.  Enhancement
possibilities exist in making this optional in the harvest module
(e.g. supply your own).

#### Examples

##### include ckan::redis

```puppet

Defined types

ckan::ext

The ext directory classes utilize the ckan modularization framework known as extensions. To fully install the plugin, puppet needs to be run twice. The first time puppet runs, the extension won't be added to ckan due to how this module manages the plugins.

Parameters

The following parameters are available in the ckan::ext defined type.

extname

Data type: Optional[String]

The name of the extension. Defaults to $title.

Default value: undef

provider

Data type: String

The name of the VCS repository provider where the extension is hosted. Can be any provider supported by puppetlabs/vcsrepo. Defaults to 'git'.

Default value: 'git'

Optional[String]source

Data type: Optional[String]source The URL of the remote VCS repository. Defaults to "http://github.com/ckan/ckanext-$extname".

The URL of the remote VCS repository. Defaults to "http://github.com/ckan/ckanext-$extname".

revision

Data type: String

The revision of the VCS repository to check out and install.

Default value: 'stable'

plugin

Data type: Optional[Array[String]]

An array of strings that are plugins to add to the plugin configuration in the production.ini.

Default value: undef

views

Data type: Optional[Array[String]]

An array of string that are views to add to the view configuration in the production.ini.

Default value: undef

pip_requirements

Data type: String

The name of the requirements pip file to be installed. Only the name of the file which is found in the root directory of ext.

Default value: 'pip-requirements.txt'

user

Data type: Optional[String]

Uses the user's $HOME/.ssh setup

Default value: undef

source

Data type: Optional[String]

Default value: undef

ckan::lang

This class expects a zip file that has the contents of the language. The contents of the zip file should have the following:

• LC_MESSAGES/ckan.mo
• LC_MESSAGES/ckan.po

Parameters

The following parameters are available in the ckan::lang defined type.

url

Data type: Any

The url to the language build. The build is a zip file with a root directory.

language

Data type: Any

The language that is to be installed.

Default value: $title

2018-09-25 Release 2.7.6

• Changed Source URL to use https protocol.
• Changed formatting in change log

2018-09-25 Release 2.7.5

• Added revision parameter to harvest extension
• Updated dcat plugin module configuration.
• Removed redis server package from required packages as it was already included in redis extension.

2018-06-27 Release 2.7.4

• Added parameter parsing to the ckan_create_admin script
• Added required email parameter for ckan_create_admin script

2018-06-25 Release 2.7.3

• Changed the permissions on extension source directory
• Added types to the ckan::ext class
• Added user parameter to the ckan::ext class to use with vcsrepo

2018-06-20 Release 2.7.2

• Removed types from readme.
• Cleaned up a variable name.

2018-06-20 Release 2.7.1

• Changed a parameter in ext::lcrnz to be optional.

2018-06-20 Release 2.7.0

• Added support for SSL (nginx).
• Fixed directory permissions for language support.
• Added parameter types.
• Changed documentation style to use Puppet Strings.
• Added REFERENCE.md for class and type documentation based on Puppet Strings.
• Removed Preview loadable parameter as it was deprecated as of ckan 2.3

2018-01-23 Release 2.6.10

• New version of solr puppet module which uses OpenJDK instead of oracle.

2018-01-17 Release 2.6.9

• Added the zip preview extension support

2017-12-06 Release 2.6.8

• Added support for ckan 2.7
• Added support for solr 6.5.1 which requires the ckan/lib/search/init.py file in order to change schema.xml to managed-schema
• Support for Ubuntu 16.04.

2017-09-25 Release 2.6.7

• Changed wget from a class declaration to an include statement to allow for wget to be used in other puppet modules.

2017-07-05 Release 2.6.6

• Added revision for google analytics extension.

2017-05-16 Release 2.6.5

• Added max_file_size parameter.
• Added activity_streams_enabled & activity_streams_email_notification parameters.
• Added tracking_enable parameter.
• Added image_formats parameter.
• Updated readme with new parameters and links to configuration documentation.

2017-04-28 Release 2.6.4

• Added 2 new configuration parameters.
• Deleted undef variables in ckan::params
• Removed deleted variables in init.pp and replaced with undef.

2017-04-10 Release 2.6.3

• ckan verison 2.6 checks the schema version in the schema.xml file. By changing the version to 2.3, the check schema version error is fixed.

2017-04-10 Release 2.6.2

• Added the ability to install languages in the default directory.

2017-04-5 Release 2.6.1

• Updated solr puppet module version
• Updated systemd puppet module version
• Updated postgis version for Ubuntu 16.04

2017-04-05 Release 2.6.1

• Added new dependencies for ckan 2.6
• Moved git-core to required packages from its own declaration in install.pp
• Added a new type called lang which allows the installation of languages.

2017-03-15 Release 2.6.0

• Added support for CKAN version 2.6
• Changed from python-software-properties to software-common-properties
• Changed the default URL from latest to archive for downloading solr
• Changed default version of solr to 5.5.3
• Tested with Puppet 4

2017-01-25 Release 2.5.1

• the pdfview ext now adds pdf_view to the default_view parameter.

2017-01-25 Release 2.5.0

• Added views so that officedocs extension manages both plugins and views.
• Reworked views so that 'default_views' requires an array not a string.
• Fixed issues with geoview related to default_views

2017-01-23 Release 2.4.2

• Added the office docs extension.
• Fixed an issue with galleries ext not installing properly.

2016-12-23 Release 2.4.1

• Added a dependancy to puppetlabs/inifile

2016-12-20 Release 2.4.0

• Removed datastore extension. Just set datastore as a plugin as there is no extra work required to enable datastore.
• Fixed a spelling error in the hide_overlays parameter in geoview extension.
• Replaced puppet template code with the puppetlabs inifile types.
• Converted all extensions to use the new inifile puppet module
• Removed urls that use the git protocol and changed to http protocol.
• Fixed a bug with ckan::pip_package anchor naming
• Added a new parameter for setting the roles cascading.

2016-11-29 Release 2.3.3

• Custom facts have been used to auto populate the ckan.plugins configuration parameter based on ckan::ext. However, in later version of factor, this seems to be unreliable especially when running from Vagrant. This version removes custom facts completely. The mechanism still uses the /etc/ckan/plugins.out file for collecting the plugins and requires 2 puppet runs to enable the plugins in the ckan service. However, this solution will work consistently.

2016-11-18 Release 2.3.2

• The latest version of the postgresql puppet module 4.8.0 has changed their internal dependency structure with the apt puppet module. This has caused the dependency cycle issue because there was dependencies between the landcareresearch/solr module and eventually the puppetlabs/postgresql module. This build decouples those two modules completely.

2016-11-02 Release 2.3.1

• Added new dependencies based on updated version of solr puppet module including systemd, and java8

2016-11-02 Release 2.3.0

• Fixed potential dependency cycle with newer versions of postgresql puppet module.
• Upgraded the solr module version to 0.5.x. Do not use version 2.3.0 with existing ckan instances as this will most likely cause errors with the solr installation. the Solr 0.5.x puppet module now manages solr uses tarballs and not packages. This is an improvement but means that legacy systems will have problems upgrading.

2016-11-02 Release 2.2.7

• Added a cron job for to ensure harvest runs periodically.
• Updated docs to reflect additional parameters on the harvest ext.

2016-07-23 Release 2.2.6

• Added parameters for managing the smtp service. Note, this does NOT install an smtp service.

2016-07-15 Release 2.2.5

• Fixed an error in the spatial ext template.

2016-07-15 Release 2.2.4

• Mapquest is no longer serving tiles via the api used by spatial extension. So a feature has been added to use open street map tiles.
• Discovered that galleries extension doesn't install properly on Ubuntu 12.04 so updated documentation.

2016-07-11 Release 2.2.3

• Added the galleries extension
• Added a global parameter for specifying the ckan packaged python library

2016-07-07 Release 2.2.2

• Added a new class for installing redis for the harvest ext.
• Added missing ext classes documentation from readme.
• Added links to each ext class github repo.
• Removed Authors field in source file headers (as this promotes more of a community). Using contributors.txt is a better way.

2016-07-06 Release 2.2.1

• Fixed a typo in a require statement
• Fixed geoview ext's configuration providing order and white space.

2016-06-23 Release 2.2.0

• Added a parameter for the sender email.
• Added a parameter for the receiver email.
• Added a missing file source.
• Added a missing template.
• Updated documentation for modules.
• Updated readme (partial).

2016-06-22 Release 2.1.15

• Added a parameter for managing the directory for database backups and restores.
• Fixed a configuration problem with spatial search.
• Fixed a bug where an exec runs every puppet run (wsgi_create).
• Fixed a bug for the location of the paster command.

2016-06-21 Release 2.1.14

• Added geoview extension

2016-05-03 Release 2.1.13

• Fixed spatial search problem with templates.

2016-04-27 Release 2.1.12

• Changed from using the ckan python pip to the system packaged pip.
• Added installation of python2.7 and python-pip for deb versions.

2016-04-27 Release 2.1.11

• Added a parameter to change the postgis version.

2016-04-22 Release 2.1.10

• Added support for ckan version 2.5.

2016-04-18 Release 2.1.9

• A bug was discovered with the automatic backups. If the spatial extension was enabled than backups would fail. This bug has been fixed.

2016-03-29 Release 2.1.8

• Added a new extension called private dataset
• Added vagrant testing environment
• Handling nodejs for Ubuntu 12.04 and 14.04

2016-01-11 Release 2.1.7

• Added parameters to change the source repo for the lcr extension.

2015-12-09 Release 2.1.6

• Added ckan_upgrade_db.bash
• Added ckan_create_views.bash
• Added ckan_purge_account.bash (uses expect package)
• Added recaptcha version. Changed the default to 2 instead of 1.
• Fixed postgresql ppa problem bug.
• Added Ubuntu 14.04 support.
• Updated the solr default version to 5.3.0

2015-10-30 Release 2.1.4

• Added the json_formats and xml_formats for the configuration file.
• Text Formats will always be added to configuration.
• Changed recaptcha public/private defaults to undef.
• Updated for future parser compliance (puppet 4)

2015-09-xx Release 2.1.0

• Added support for ckan version 2.3
• Added default_locale param for ckan configuration
• Added ckan.i18n_directory param for ckan configuration
• Added support for 2.3 changes like preview vrs new view system
• Upgraded Landcare Research ext to lcrnz
• Added repeating extension
• Added ldap extension
• Enabled the storage path of the file store to be set by module.
• Updated to using Solr 5.x
• Enabled both solr and solr-spatial-field for the backend to spatiel search.

2015-04-02 Releaes 2.0.1

• The changed to using the postgresql password hash function.
• Added ckan version specifing the version of ckan to use.

2015-03-23 Releaes 2.0.0

NOTE

Due to a change of how the database is initialized, upgrading from previous version of this module will re-initialize your database!!!! This means, you need to backup the database before doing this upgrade.

To recover your database use the following command (make sure you sudo su first)

paster --plugin=ckan db clean --config=/etc/ckan/default/production.ini ckan_database.pg_dump
paster --plugin=ckan db load --config=/etc/ckan/default/production.ini ckan_database.pg_dump

• Added the landcareresearch/solr puppet module.
• Tested with solr 4.10.3.
• Database initialization is now moved to a bash script in /usr/local/bin
• Added a solr schema parameter that instructs which schema version to use.

2015-03-04 Release 1.0.13

• Migrated from github to bitbucket
• Changed ownership of puppetforge account
• Added openhub badge to readme.
• Migrated changelog into md format.
• Changed ckan_run dependancy to landcareresearch account.
• Output of new CKAN Fact now correctly reports if the /etc/ckan/plugins.out file doesn't exist.

2015-02-16 Version 1.0.12

• Including extension plugins in the plugins parameter caused the module to fail due to a depedancy on the extension to already be installed prior to ckan started.
• This patch incorperates the plugin into the extension so the extension plugins no longer need to be set via the plugin option. It will require 2 puppet runs in order to bring the extensions online though (there isn't any way around this that I know of).

2015-01-29 Version 1.0.11

• Added ckan user password string to ckan.ini.
• Added puppetforge badge

2015-01-28 Version 1.0.10

• Added an option to enable event tracking for the Google Analystics which pushes events every hour
• Added a convience script for creating admin accounts.
• Cleaned up code
• Added documentation for ckan::config
• Added configuration for backup directory
• Added configuration for ckan database password

2015-01-14 Version 1.0.9

• The ckanapi can now be installed (optional)
• A helper script for calling ckanapi command line tool

2015-01-08 Version 1.0.8

• Cleaned up the code based on puppet-lint (via puppetlinter.com)
• Enabled github hook for puppetlinter so future commits are checked and reported

2015-01-07 Version 1.0.7

• Fixed a recent security exploit that has effected CKAN sites globally
• Set the security settings to restrict anonymous users from creating groups and datasets
• Set the default backend for spatial search to solr in the spatial search extension
• Changed backups from weekly to daily

2014-11-12 Version 1.0.6

• CKAN Developers have added a new submodule for managing CKAN extensions.
• Added ckan::ext submodule
• Added Google Analytics extension
• Added Hierarchy extesion
• Added New Zealand Landcare extension
• Added Spatial extension
• Updated to using metadata.json

2014-08-13 Version 1.0.5

• A CKAN Developer has cleaned up the module and prepared for ckan extensions.
• Removed apache module dependency
• Removed module stage complexity with anchor pattern
• Removed hard coded security keys from production.ini.erb
• Added security keys to module parameters

2014-07-23 Version 1.0.4

• Removed the reset_apt module as vagrant can handle updating puppet with a recomended script
• Updated to the latest apache module which has the necessary changes integrated
• Changed default value of the apache headers variable

2014-06-09 Version 1.0.3

• Added dependancy for Debian/Ubuntu based systems only
• Updated readme with new installation parameters
• Added Server admin's email specified
• Added recaptcha support
• Added max_resource_size parameter
• Added data pusher formats
• Added apache head configuration (in order to control search engine crawlers) and is optional
• Added the postgres password as a parameter
• Added postgres hba configuration to pass in as a parameter

2014-06-08 Version 1.0.2

• Fixed a bug if the license was left off, caused errors in datastore
• Added support for CKAN 2.2 package

2014-01-15 Version 1.0.1

• Added a parameter to disable the apt reset
• Removed puppetlabs-apt and apt::ppa which was causing dependency loops if a class outside of ckan required apt::ppa
• Removed ppa for nodejs & ubuntugis
• Added puppetlabs-nodejs class
• Added dependency for puppetlabs-nodejs

Version 1.0.0

• Initial Release.