- Setup - The basics of getting started with flatpak
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - List of those who've helped to make the module better
This module (optionally) installs Flatpak from the developer's PPA on Launchpad and offers two defined types, one for adding/removing Remotes and another for installing/removing Flatpak applications.
This module was created to allow for managing/installing Flatpak-based application distributions, as some developers have started to move away from more traditional system packages such as apt/deb and rpm/yum, instead leveraging Flatpak's ability to be one-size-fits all.
This module (optionally) adds the Flatpak PPA on Launchpad to the system's repository
manage_repo is true - default for Debian family) and installs Flatpak.
Currently, this module only supports Ubuntu and RedHat, but may work with other Debian- based or RedHat-based distributions.
This module requires the
puppetlabs-apt module in order to manage
Apt repos (if
manage_repo is true).
To install this module, call:
puppet module install brwyatt-flatpak
To install Flatpak for use in your Puppet manifests, simply include it into your manifests.
Installs the Flatpak PPA and installs Flatpak
package_ensure: Ensure value for the Flatpak package. Default: 'installed'
repo_file_name: Optional name for the repo source file. Defaults to the PPA naming scheme to avoid duplicate repository files.
Adds the Gnome SDK remote to Flatpak. Includes the
flatpak class to ensure
Flatpak is installed first.
This class has no parameters.
This type installs (or uninstalls) Flatpak apps.
ensure: If the package should be
arch: The package architecture to be installed. Cannot be used if
branch: The package branch to be installed. Cannot be used if
name: (namevar) The name of the package to be installed (or removed)
ref: The package ref to install. This can be any valid pakcage ref, from simply the package name up to a full Identifier Triple ("name/arch/branch"). Cannot be used if
remote: The name of the remote repo to install the package from. Required if
ensureis "installed" or "present".
If defined, this type will install the package identified in the
parameter. Otherwise, it will attempt to generate an Identifier Triple from
the values of
branch. If no parameters are explicitly defined,
this will result in attempting to install the package with the resource's name
and the remote's default architecture and branch.
This type adds and removes Flatpak remotes.
ensure: If the remote should be
name: (namevar) The name of the remote
location: The location for the remote
true, it specifies that location is a repo config file.
flatpak type. Default provider.
flatpak_remote type. Default provider.
Currently, this module can only install on Debian-based systems and has not been tested on distributions other than Ubuntu 16.04. It may or may not work on other Debian-based distributions, but makes no claims regarding such. This will not currently work at all on RHEL-based systems.
I may not have much time to work on (or test) this myself, so help to expand current functionality (especially to make it work for more people) is greatly appreciated and encouraged.
The list of contributors can be found at: https://github.com/brwyatt/puppet-flatpak/graphs/contributors.
All notable changes to this project will be documented in this file.
0.2.6 - 2020-10-10
manage_repoparameter to make repo management optional
- Add/claim support for RHEL/CentOS
- Module Hiera for setting defaults conditionally (used by new
0.2.5 - 2019-05-24
- PDK Update
- Travis CI integration
0.2.4 - 2019-05-10
- Ruby style violations (rubocop)
- Add '--assumeyes' to uninstall command
0.2.3 - 2018-12-29
- Detection of installed remotes when remote is down or returning errors
0.2.2 - 2018-07-02
- PDK Update
- Package resource dependency (should be on apt_update not apt::source)
0.2.1 - 2017-11-07
- PDK compatibility
- Manifest unit tests
- Ruby style violations (rubocop)
0.2.0 - 2017-10-12
- New parameters to
flatpaktype's namevar is now
ref. Behavior and expected values remains the same as before.
remoteparameter on the
flatpaktype is now explicitly required when installing a package.
- Made repo source file match PPA naming scheme
- Support for older Facter versions (<3.0.0)
flatpaktype now accepts a full Identifier Triple for
0.1.1 - 2017-09-12
- License format in Module metadata.json
- Unbounded dependency version ranges
0.1.0 - 2017-09-11
- support for Ubuntu (possibly other Debian-based distributions using apt)
- Install Flatpak from developer PPA
- Add/Remove Flatpak remotes
- Install/uninstall Flatpak apps
GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.