ccs_software

Table of Contents

1. Overview
2. Description
3. Setup - The basics of getting started with ccs_software
   • What ccs_software affects
   • Setup requirements
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how

Overview

This module manages installations of Camera Control System (CCS) software.

Description

The ccs_software module can optionally manage one or more installations.

Setup

What ccs_software affects

• install.py script
• ccs /scripts/
• /lsst link
• clone(s) of the package-list repo
• ccs etc directory
• ccs log directory
• [optional] /installations/ of ccs software
• [optional] systemd service units for ccs applications

Setup Requirements

• ccs and ccsadm user accounts
• The systemd service units created by this module require java to be installed on the system. See [java_artisanal])https://github.com/lsst-it/puppet-java_artisanal)

Usage

Absolute Minimal Example / If you want to manually create installations

When the ccs_software class is included with no parameters it will create directories, install the install.py script, etc. but it will not create a CCS installation.

accounts::user { 'ccs': }
accounts::user { 'ccsadm': }
include ccs_software

Example profile

This is an example of minimal profile that provides the requirements listed in Setup requirements. The intent is that the majority of configuration to the ccs_software class be provided via hiera data.

class profile::ccs::common {
  include ccs_software
  include accounts
  include java_artisanal

  Class['java_artisanal']
  -> Class['ccs_software']

  accounts::user { 'ccs':
    uid => 62000,
    gid => 62000,
  }
  accounts::user { 'ccsadm':
    uid => 62001,
    gid => 62001,
  }
}

Installation(s)

This example creates two installations at the paths /opt/lsst/ccs/master and /opt/lsst/ccs/e4a8224. Where master and e4a8224 are refs in the lsst-camera-dh/dev-package-lists.

---
classes:
  - "profile::ccs::common"

ccs_software::hostname: "comcam-mcm"  # not required if `comcam-mcm` is the real hostname
ccs_software::env: "ComCam"
ccs_software::installations:
  master: {}
  e4a8224: {},

The literal invocations of the install.py command would be something like:

/opt/lsst/release/bin/install.py --ccs_inst_dir /opt/lsst/ccs/master /opt/lsst/ccsadm/package-lists/master/ComCam/comcam-mcm/ccsApplications.txt

and

/opt/lsst/release/bin/install.py --ccs_inst_dir /opt/lsst/ccs/e4a8224 /opt/lsst/ccsadm/package-lists/e4a8224/ComCam/comcam-mcm/ccsApplications.txt

Note that a separate clone of the dev-package-lists repo is created for each installation.

Service(s)

This example will create a systemd service unit named comcam-mcm that executes /opt/lsst/ccs/dev/bin/comcam-mcm.

classes:
  - "profile::ccs::common"

ccs_software::env: "ComCam"
ccs_software::installations:
  e4a8224:
    aliases:
      - "dev"
ccs_software::services:
  dev:
    - "comcam-mcm"

Desktop

classes:
  - "profile::ccs::common"

ccs_software::desktop: true  # default is false

Multiple Installations sharing a git clone

This may be an efficiency optimization for simulating a large number of hosts on a single node.

---
classes:
  - "profile::ccs::common"

ccs_software::base_path: "/opt/lsst"
ccs_software::env: "ComCam"
ccs_software::installations:
  test-mcm:
    repo_path: "%{lookup('ccs_software::base_path')}/ccsadm/package-lists/e4a8224"
    repo_ref: "e4a8224"
    hostname: "comcam-mcm"
  test-fp:
    repo_path: "%{lookup('ccs_software::base_path')}/ccsadm/package-lists/e4a8224"
    repo_ref: "e4a8224"
    hostname: "comcam-fp01"
ccs_software::services:
  test-mcm:
    - "comcam-mcm"
  test-fp:
    - "comcam-fp01"

Force git clone update

In the event that a git clone has local changes, and the vcsrepo type is having trouble updating it, setting the force_git flag will cause the clones to be deleted and re-cloned on every puppet run. This flag should generally only be set temporarily to resolve a known issue.

---
classes:
  - "profile::ccs::common"

ccs_software::env: "ComCam"
ccs_software::force_git: true
ccs_software::installations:
  master: {}

Pedantic Example

---
classes:
  - "profile::ccs::common"

ccs_software::base_path: "/opt/lsst"
ccs_software::etc_path: "/etc/ccs"
ccs_software::log_path: "/var/log/ccs"
ccs_software::user: "ccs"
ccs_software::group: "ccs"
ccs_software::adm_user: "ccsadm"
ccs_software::adm_group: "ccsadm"
ccs_software::pkglist_repo_url: "https://github.com/lsst-camera-dh/dev-package-lists" # overriden in installations hash
ccs_software::release_repo_url: "https://github.com/lsst-it/release"
ccs_software::release_repo_ref: "IT-2233/working"
ccs_software::env: ~ # overriden in installations hash
ccs_software::hostname: "%{lookup(facts.hostname)}" # overidden in installations hash
ccs_software::desktop: false
ccs_software::git_force: false
ccs_software::installations:
  test1:
    repo_path: "%{lookup('ccs_software::base_path')}/ccsadm/package-lists/test1"
    repo_url: "https://github.com/lsst-camera-dh/dev-package-lists"
    repo_ref: "e4a8224"
    env: "ComCam"
    hostname: "comcam-mcm"
    aliases:
      - "dev"
  test42:
    repo_path: "%{lookup('ccs_software::base_path')}/ccsadm/package-lists/test42"
    repo_url: "https://github.com/lsst-camera-dh/dev-package-lists"
    repo_ref: "e4a8224"
    env: "IR2"
    hostname: "lsst-dc01"
    aliases:
      - "prod"
ccs_software::services:
  dev:
    - "comcam-mcm"
  prod:
    - "lsst-dc01"

Reference

See REFERENCE.

Reference

Table of Contents

Classes

Public Classes

• ccs_software: Installs and configures CCS software

Private Classes

• ccs_software::config: Install /etc/ccs files.
• ccs_software::desktop: Add desktop menu entries for CCS apps.
• ccs_software::install: Install ccs software.
• ccs_software::log: Create /var/log/ccs and install logrotation.
• ccs_software::pre: Install ccs software prerequisites
• ccs_software::service: Manages ccs systemd service units

Classes

ccs_software

Installs and configures CCS software

Parameters

The following parameters are available in the ccs_software class:

• installations
• service_workdir
• services
• base_path
• etc_path
• log_path
• user
• group
• adm_user
• adm_group
• influx_url
• influx_name
• influx_username
• influx_password
• kafka_files
• kafka_auths
• service_email
• pkglist_repo_url
• release_repo_url
• release_repo_ref
• env
• hostname
• desktop
• git_force
• global_properties
• udp_properties

installations

Data type: Hash[String, Hash]

Hash of hashes which describes one or more CCS "installations" to manage.

Options:

• name-of-installation String: The top level hash keys are the name of the installation. Eg., foo would create the installation /opt/lsst/ccs/<foo>.

Supported keys in nested hashes:

• repo_path - Overrides the default path to package list repo clone for this installation.
• repo_url - Overrides the pkglist_repo_url param for this installation.
• repo_ref - Overrides the pkglist_repo_ref param for this installation.
• env - Overides the env param for this installation.
• hostname - Overides the hostname param for this installation.
• aliases - [Array] of "alias" links to create for the current installation.

Default value: {}

service_workdir

Data type: Optional[String]

CWD for services

Default value: undef

services

Data type: Hash[String, Array[Variant[String, Hash]]]

Hash of Arrays of services to create systemd service units for.

Options:

• name-of-alias String: [Array] of service names/service executables (links under /opt/lsst//bin/) Alternatively, array element can also be a hash of the form { name: "h2db", key: "value", ... } Allowed keys: cmd, user, group, workdir, env, enable. Values specify the associated service file values/state.

Default value: {}

base_path

Data type: Stdlib::Absolutepath

Base path for [all] CCS installations.

Default value: '/opt/lsst'

etc_path

Data type: Stdlib::Absolutepath

Path to global CCS configuration files.

Default value: '/etc/ccs'

log_path

Data type: Stdlib::Absolutepath

Path to CCS log files.

Default value: '/var/log/ccs'

user

Data type: String

Name of the role user under which CCS services will be run and the owner of config files

Default value: 'ccs'

group

Data type: String

Name of the role group

Default value: 'ccs'

adm_user

Data type: String

Name of the admin role user which owns many of the installed files

Default value: 'ccsadm'

adm_group

Data type: String

Name of the admin role group

Default value: 'ccsadm'

influx_url

Data type: String[1]

String giving URL of the influxDB server.

Default value: 'https://camera-influxdb.dev.lsst.org:443'

influx_name

Data type: String[1]

String giving name of the influxDB instance.

Default value: 'grafana'

influx_username

Data type: Sensitive[String[1]]

Sensitive string giving influxDB username.

Default value: Sensitive('user')

influx_password

Data type: Sensitive[String[1]]

Sensitive string giving influxDB password.

Default value: Sensitive('pass')

kafka_files

Data type: Hash[String, Hash]

Optional hash of kafka properties files and associated values. Eg: data-int: bootstrap_url: "bootstrap_url" registry_url: "registry_url"

Default value: {}

kafka_auths

Data type: Hash[String, Array[Variant[Sensitive[String],String]]]

Optional (but required for each key of kafka_files) hash of kafka files and the associated username and password. Eg: data-int:

- "user"
- "pass"

Default value: {}

service_email

Data type: String

String giving email address (or comma separated addresses) to receive change of service status emails from systemd.

Default value: 'root@localhost'

pkglist_repo_url

Data type: Stdlib::HTTPUrl

URL of the git repo to use for install.py package lists by default. This may be overriden in a installations hash with the repo_url key.

Default value: 'https://github.com/lsst-camera-dh/dev-package-lists'

release_repo_url

Data type: Stdlib::HTTPUrl

URL of the repo which contains the install.py script.

Default value: 'https://github.com/lsst-it/release'

release_repo_ref

Data type: String

install.py git repo ref.

Default value: 'IT-4348/python3'

env

Data type: Optional[String]

Name of the package list environment. Eg., ComCam. This may be overriden in a installation hash with the env key.

Default value: undef

hostname

Data type: Optional[String]

The "short" hostname used to select the installation set in a package lists repo.

Default value: $facts['networking']['hostname']

desktop

Data type: Boolean

Install desktop shortcuts.

Default value: false

git_force

Data type: Boolean

Force the update of managed git clones. This is done by passing force => true to vcsrepo type resources.

Default value: false

global_properties

Data type: Array[String]

Array of extra strings to add to the ccsGlobal.properties file.

Default value: []

udp_properties

Data type: Array[String]

Array of extra strings to add to the udp_ccs.properties file.

Default value: []

Changelog

All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.

v2.10.0 (2025-04-22)

Full Changelog

Implemented enhancements:

• (metadata.json) bump vcsrepo to include v7 #82 (badenerb)
• Update dependency puppet_metadata to v5 #81 (renovate[bot])

v2.9.0 (2024-12-18)

Full Changelog

Implemented enhancements:

• bump version constraint for systemd to include 8 #79 (badenerb)

v2.8.1 (2024-11-12)

Full Changelog

Implemented enhancements:

• Removed git status check from installCCS.sh #77 (mxturri)

v2.8.0 (2024-10-24)

Full Changelog

Implemented enhancements:

• bump version constraint for saz/sudo to allow 9.0.0 #75 (badenerb)

v2.7.0 (2024-09-04)

Full Changelog

Implemented enhancements:

• Add CCS desktops apps to default gnome favorites #69 (glennmorris)

v2.6.0 (2024-08-27)

Full Changelog

Implemented enhancements:

• Add option to install kafka-brokers properties files #67 (glennmorris)

v2.5.0 (2024-08-13)

Full Changelog

Implemented enhancements:

• Add new config file for influxDB #65 (glennmorris)

v2.4.0 (2024-08-07)

Full Changelog

Implemented enhancements:

• allow puppet/systemd 7.x #63 (jhoblitt)

v2.3.0 (2024-07-05)

Full Changelog

Implemented enhancements:

• Allow control over the enable state of services #60 (glennmorris)
• Added code to cleanup dev-package-list clone after installation #59 (mxturri)

v2.2.2 (2024-05-21)

Full Changelog

Implemented enhancements:

• (files/install/installCCS.sh) update CCS install script for use on summit #58 (glennmorris)
• (puppet-ccs-software) add license file #56 (dtapiacl)

v2.2.1 (2024-03-19)

Full Changelog

Breaking changes:

• use stdlib::ensure_packages() and require stdlib >= 9 #55 (jhoblitt)

Implemented enhancements:

• Bump version to 2.2.1 #53 (glennmorris)
• Add wget as a required system package #52 (glennmorris)

v2.2.0 (2023-10-04)

Full Changelog

Implemented enhancements:

• allow puppet/systemd 6.x #50 (jhoblitt)
• add almalinux 9 support #40 (jhoblitt)

v2.1.0 (2023-08-22)

Full Changelog

Implemented enhancements:

• allow saz/sudo 8.x #48 (jhoblitt)
• allow stdlib 9.x #46 (jhoblitt)

v2.0.0 (2023-06-23)

Full Changelog

Breaking changes:

• (plumbing) drop support for puppet6 #37 (jhoblitt)

Implemented enhancements:

• allow puppetlabs/vcsrepo 6.x #42 (jhoblitt)
• add support for puppet8 #38 (jhoblitt)
• (sudo) add 'reset-failed' to the commands ccs user can run #36 (glennmorris)

v1.4.0 (2023-04-17)

Full Changelog

Implemented enhancements:

• Extend the service hash to allow for more options #33 (glennmorris)

v1.3.0 (2023-03-06)

Full Changelog

Implemented enhancements:

• Switch to using python3 to run the install.py script #31 (glennmorris)

v1.2.1 (2023-01-31)

Full Changelog

Fixed bugs:

• fix .pmtignore rm'ing templates/log from release tarballs #30 (jhoblitt)

v1.2.0 (2023-01-31)

Full Changelog

Implemented enhancements:

• normalize supported operating systems #28 (jhoblitt)
• bump puppet/systemd to \< 5.0.0 #26 (jhoblitt)

v1.1.4 (2022-11-01)

Full Changelog

Merged pull requests:

• Use remote persistency server, get rid of 6.0.4 full paths workaround #25 (tony-johnson)

v1.1.3 (2022-08-17)

Full Changelog

Merged pull requests:

• release 1.1.3 #24 (jhoblitt)

v1.1.2 (2022-08-17)

Full Changelog

Merged pull requests:

• release 1.1.2 #23 (jhoblitt)

v1.1.1 (2022-08-17)

Full Changelog

Merged pull requests:

• release 1.1.1 #22 (jhoblitt)
• modulesync 5.3.0 #21 (jhoblitt)

v1.1.0 (2022-07-22)

Full Changelog

Merged pull requests:

• add EL8 support #20 (jhoblitt)

v1.0.2 (2022-07-08)

Full Changelog

v1.0.1 (2022-02-21)

Full Changelog

Merged pull requests:

• Default to CCS remote configuration server #19 (glennmorris)

v1.0.0 (2022-02-01)

Full Changelog

Merged pull requests:

• update to ~ voxpupuli 5.1.0 plumbing #18 (jhoblitt)

v0.8.0 (2021-11-30)

Full Changelog

Merged pull requests:

• Produce alert emails when a ccs systemd service fails #17 (glennmorris)
• Allow a service file to specify a custom ExecStart #16 (glennmorris)

v0.7.0 (2021-08-03)

Full Changelog

Merged pull requests:

• set org.hibernate.level=WARNING #15 (jhoblitt)

v0.6.1 (2021-07-30)

Full Changelog

v0.6.0 (2021-07-29)

Full Changelog

Merged pull requests:

• Add a sudo file allowing the ccs user to control ccs services #14 (glennmorris)

sudo-0.1 (2021-07-29)

Full Changelog

v0.5.0 (2021-04-08)

Full Changelog

Merged pull requests:

• It 2820 auxtel ccs #13 (glennmorris)

auxtel-0.3 (2021-04-06)

Full Changelog

auxtel-0.2 (2021-03-31)

Full Changelog

auxtel-0.1 (2021-03-30)

Full Changelog

v0.4.2 (2020-10-16)

Full Changelog

Merged pull requests:

• Add bash completion for the ccslog utility #12 (glennmorris)

v0.4.1 (2020-09-18)

Full Changelog

Merged pull requests:

• Install the /usr/local/bin/ccslog utility #11 (glennmorris)

v0.4.0 (2020-09-02)

Full Changelog

Merged pull requests:

• [blacksmith] Bump version to 0.4.0 #10 (jhoblitt)
• add WorkingDirectory to all systemd service units #9 (jhoblitt)
• sync puppet-lint plugins from lsst-it/lsst-itconf #8 (jhoblitt)
• README fixes #7 (jhoblitt)

v0.3.0 (2020-06-25)

Full Changelog

Merged pull requests:

• [blacksmith] Bump version to 0.3.0 #6 (jhoblitt)
• add jgroups bufs + allow manual installs + git_force param #5 (jhoblitt)

v0.2.0 (2020-06-12)

Full Changelog

Merged pull requests:

• release v0.2.0 #4 (jhoblitt)

v0.1.1 (2020-06-12)

Full Changelog

Merged pull requests:

• release v0.1.1 #3 (jhoblitt)
• change /var/log/ccs to 2777 #2 (jhoblitt)

v0.1.0 (2020-06-10)

Full Changelog

Merged pull requests:

• fwv #1 (jhoblitt)

* This Changelog was automatically generated by github_changelog_generator