Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 8.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-pam_firewall', '1.0.5'
Learn more about managing modules with a PuppetfileDocumentation
pam_firewall
Configures firewall rules using the firewall module for Puppet Application Manager.
Description
This module configures firewall rules using the firewall module for Puppet Application Manager (PAM) installed on Puppet-supported Kubernetes.
The preserve-iptables-config
option should be supplied while installing PAM to leave the iptables
service enabled, as in bash -s preserve-iptables-config
. The PAM installation must be run after applying this module to ensure Kubernetes firewall rules are registered with the iptables
service.
It specifically avoids purging foreign rules and chains created by Kubernetes. It also exposes ports to cluster members that need access (currently treats primary and secondary nodes identically) and exposes application ports globally.
Usage
The module declares a single class that can be applied to your cluster members.
The defaults work for a Standalone install
include ::firewall
include ::pam_firewall
An example is provided that demonstrates using this while locking down most other inbound access. You can run it with Bolt
bolt module install
bolt apply examples/init.pp --run-as root --targets $target
Note that this module ensures firewall rules created by Kubernetes remain if purging unknown rules in firewall chains and unknown firewall chains with
Firewallchain {
purge => true,
}
resources { 'firewallchain':
purge => true,
}
but not if purging all unknown firewall rules with
resources { 'firewall':
purge => true,
}
HA cluster
If installing an HA cluster, you'll need to provide cluster_nodes
for all members to enable intra-cluster communication
include ::firewall
class {'::pam_firewall':
cluster_nodes => ['10.20.0.1', '10.20.0.2', '10.20.0.3'],
}
Application ports
You can also override app_ports
to be more restrictive if not using all ports. For example, port 9001 is only used by CD4PE in an offline install, and port 8000 is only used by CD4PE for webhooks
include ::firewall
class {'::pam_firewall':
app_ports => [443],
}
Subnets
If you need to override pod and/or service subnets for a PAM install, you'll also need to provide those here
include ::firewall
class {'::pam_firewall':
pod_subnet => '10.48.0.0/24',
service_subnet => '10.48.1.0/24',
}
Managing common firewall chains
If you manage common firewall chains explicitly and purge unknown rules, such as
firewallchain {'OUTPUT:filter:IPv4']:
policy => 'drop',
purge => true,
}
you'll need to disable this module's management of those chains and ignore foreign rules to avoid deleting rules created by Kubernetes
include ::firewall
class {'::pam_firewall':
manage_common_chains => false,
}
firewallchain {'OUTPUT:filter:IPv4']:
policy => 'drop',
purge => true,
ignore_foreign => true
}
Reference
Table of Contents
Classes
pam_firewall
: Firewall rules for Puppet Application Manager (PAM) and its applications on Puppet-supported Kubernetes.
Classes
pam_firewall
Firewall rules for Puppet Application Manager (PAM) and its applications on Puppet-supported Kubernetes.
Parameters
The following parameters are available in the pam_firewall
class:
cluster_nodes
Data type: Array[String]
Nodes in a cluster that need access to etcd, weave/flannel, and kubelet. Default works for Standalone architectures.
Default value: [$::ipaddress]
app_ports
Data type: Array[Variant[String, Integer]]
Specific application ports that need to be exposed. Default includes all possible ports.
Default value: [80, 443, 8000, 9001]
pod_subnet
Data type: String
The Kubernetes pod subnet selected when installing PAM. Default matches the default for Puppet-supported Kubernetes.
Default value: '10.32.0.0/22'
service_subnet
Data type: String
The Kubernetes service subnet selected when installing PAM. Default matches the default for Puppet-supported Kubernetes.
Default value: '10.96.0.0/22'
manage_common_chains
Data type: Boolean
These rules set ignore_foreign=true
on common chains like
INPUT/OUTPUT/FORWARD:filter:IPv4, PREROUTING/INPUT/OUTPUT/POSTROUTING:nat/mangle:IPv4,
and PREROUTING/OUTPUT:raw:IPv4. If managing these chains yourself, set
this to false; if you purge unknown firewall rules, set ignore_foreign=true
on these chains so Kubernetes rules aren't removed.
Default value: true
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v1.0.5 (2024-10-16)
Fixed
Added
v1.0.4 (2023-08-08)
Fixed
v1.0.3 (2023-07-10)
Fixed
v1.0.2 (2022-02-17)
Fixed
- (maint) Adding another ipv6 chain for k8s 1.21 #9 (abottchen)
- (maint) Adding additional k8s chains to preserve for 1.21.8 #8 (abottchen)
- (REPLATS-514) Do not purge WEAVE-CANARY filrewallchains #7 (jpartlow)
- Document what types of purge are supported #6 (MikaelSmith)
v1.0.0 (2021-08-27)
Added
- Provide an option to manage common firewall chains yourself #2 (MikaelSmith)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs-firewall (>= 2.7.0 < 4.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2021 Puppet, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.