zend/zend_common Puppet Module

This Puppet module contains shared resources for all Zend modules, which require the ZendPHP repositories and sometimes a license.

Table of Contents

1. What zend_common affects
2. Usage
3. Reference

What zend_common affects

zend_common::repo will setup the ZendPHP package repositories for yum or apt, depending on the operating system.

zend_common::license simply uploads the provided Zend product license to the proper directory.

Usage

Using zend_common::repo to setup the ZendPHP repositories without credentials is as simple as including the class.

include 'zend_common::repo'

Include credentials to gain access to ZendPHP LTS binaries.

class { 'zend_common::repo':
  creds => {
    username => '<ZEND_USERNAME>',
    password => '<ZEND_PASSWORD>',
  }
}

To change fail messages to be more relevant per product, define the product and support URLs.

class { 'zend_common::repo':
  product => 'ZendHQ',
  support_urls => {
    supported_platforms => 'https://help.zend.com/zendphp/current/content/installation/zendhq_supported_platforms.htm',
  },
}

Zend products like ZendHQ require a license file be present. zend_common::license simply ensures the product license file is uploaded to the proper directory.

class { 'zend_common::license':
  source => 'puppet:///modules/<MODULE_NAME>/zend/license',
}

Reference

See REFERENCE.md

Reference

Table of Contents

Classes

• zend_common::license: Upload a Zend product license to the proper directory
• zend_common::repo: Configure the ZendPHP package repositories depending on OS and version

Classes

zend_common::license

Upload a Zend product license to the proper directory

Examples

With license URL

class { 'zend_common::license':
  source    => 'puppet:///modules/<MODULE_NAME>/zend/license',
  notify    => Class['zendhq::service'],
  subscribe => Class['zendhq::package'],
}

With license text

$license = Deferred('vault_lookup::lookup',["licenses/zendhq"], 'https://vault.server.lcl:8200',)
class { 'zend_common::license':
  content    => $license,
}

Parameters

The following parameters are available in the zend_common::license class:

• source
• content

source

Data type: Optional[String[1]]

Source path or puppet URL to license file

Default value: undef

content

Data type: Optional[String[1]]

Contents of the license file

Default value: undef

zend_common::repo

Configure the ZendPHP package repositories depending on OS and version

Examples

Without parameters

include zend_common::repo

With product other than ZendPHP

class { 'zend_common::repo':
  product      => 'ZendHQ',
  support_urls => {
    supported_platforms => 'https://help.zend.com/zendphp/current/content/installation/zendhq_supported_platforms.htm',
  },
}

With credentials

class { 'zend_common::repo':
  creds => {
    username => '<ZEND_USERNAME>',
    password => '<ZEND_PASSWORD>',
  }
}

Parameters

The following parameters are available in the zend_common::repo class:

• product
• creds
• key
• support_urls

product

Data type: Enum['ZendPHP', 'ZendHQ']

Name of the Zend product

Default value: 'ZendPHP'

creds

Data type: Optional[Hash]

ZendPHP repo credentials

Options:

• username String: ZendPHP repo username
• password String: ZendPHP repo password

Default value: undef

key

Data type: Hash

ZendPHP repo key

Options:

• id String: ZendPHP repo key id
• source String: ZendPHP repo key source URL

Default value:

{
    id     => '799058698E65316A2E7A4FF42EAE1437F7D2C623',
    source => 'https://repos.zend.com/zend.key',
  }

support_urls

Data type: Hash

Links to relevant Zend product documentation

Options:

• supported_platforms String: Link to the supported platforms for the relevant Zend product

Default value:

{
    supported_platforms => 'https://help.zend.com/zendphp/current/content/introduction/supported_platforms.htm',
  }

Changelog

All notable changes to this project will be documented in this file.

v1.1.2 (2024-08-07)

Changes

• PDK Update
• Update to supported OSes

v1.1.1 (2022-12-14)

Bugfix

• Bump version of puppetlabs/apt to sync with other modules

v1.1.0 (2022-11-11)

Enhancements

• Allow 'content' option for license file #2 (RBasayev)

v1.0.0 (2022-10-26)

Initial release

Features

• Manage Zend product license
• Manage Zend binaries repository