Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PaloAltoNetworks/terraform-panos-dag-nia
Palo Alto Networks PAN-OS Dynamic Address Group (DAG) Tags Module for Network Infrastructure Automation (NIA)
https://github.com/PaloAltoNetworks/terraform-panos-dag-nia
automation consul infrastructure-as-code pan-os terraform terraform-modules
Last synced: 16 days ago
JSON representation
Palo Alto Networks PAN-OS Dynamic Address Group (DAG) Tags Module for Network Infrastructure Automation (NIA)
- Host: GitHub
- URL: https://github.com/PaloAltoNetworks/terraform-panos-dag-nia
- Owner: PaloAltoNetworks
- License: apache-2.0
- Created: 2020-10-12T15:37:45.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-18T11:02:38.000Z (almost 2 years ago)
- Last Synced: 2024-07-29T18:57:46.409Z (3 months ago)
- Topics: automation, consul, infrastructure-as-code, pan-os, terraform, terraform-modules
- Language: HCL
- Homepage:
- Size: 152 KB
- Stars: 2
- Watchers: 6
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Palo Alto Networks PAN-OS Dynamic Address Group (DAG) Tags module for Network Infrastructure Automation (NIA)
This Terraform module allows users to support **Dynamic Firewalling** by integrating [Consul](https://www.consul.io/) with Palo Alto Networks **PAN-OS** based [PA-Series and VM-Series NGFW](https://www.paloaltonetworks.com/network-security/next-generation-firewall) devices to dynamically manage dynamic registration/de-registration of **Dynamic Address Group (DAG) tags** based on services in Consul catalog.
Using this Terraform module in conjunction with **consul-terraform-sync** enables teams to reduce manual ticketing processes and automate Day-2 operations related to application scale up/down in a way that is both declarative and repeatable across the organization and across multiple **PAN-OS** devices.
#### Note: This Terraform module is designed to be used only with **consul-terraform-sync**
## Feature
This module supports the following:
* Create, update and delete Dynamic Address Tags based service name and IP address for the service in Consul catalog. If service address is not defined in Consul catalog, node address is used instead.
If there is a missing feature or a bug - - [open an issue (to be updated) ](https://github.com/devarshishah3/terraform-panos-dag-nia/issues/new)
## What is consul-terraform-sync?
The **consul-terraform-sync** runs as a daemon that enables a **publisher-subscriber** paradigm between **Consul** and **PAN-OS** based devices to support **Network Infrastructure Automation (NIA)**.
* consul-terraform-sync **subscribes to updates from the Consul catalog** and executes one or more automation **"tasks"** with appropriate value of *service variables* based on those updates. **consul-terraform-sync** leverages [Terraform](https://www.terraform.io/) as the underlying automation tool and utilizes the Terraform provider ecosystem to drive relevant change to the network infrastructure.
* Each task consists of a runbook automation written as a compatible **Terraform module** using resources and data sources for the underlying network infrastructure provider.
Please refer to this [link (to be updated)](https://www.consul.io/docs/download-tools) for getting started with **consul-terraform-sync**
## Requirements
| Name | Version |
|------|---------|
| terraform | >= 0.13 |
| consul-terraform-sync | >= 0.1.0 |
| consul | >= 1.7 |
## Providers
| Name | Version |
|------|---------|
| panos | >= 1.6 |
## Compatibility
This module is meant for use with **consul-terraform-sync >= 0.1.0** and **Terraform >= 0.13** and **PAN-OS versions >= 8.0**
## Permissions
* In order for the module to work as expected, the user or the api_key associated to the **panos** Terraform provider must have **User-ID Agent** permissions enabled
## Caveats
* PAN-OS versions >=9.0 have a behavior where the dynamic tags added to the address group will be present, but do not show up in the UI until the address group is associated to a policy.
## Usage
In order to use this module, you will need to install **consul-terraform-sync**, create a **"task"** with this Terraform module as a source within the task, and run **consul-terraform-sync**.
The users can subscribe to the services in the consul catalog and define the Terraform module which will be executed when there are any updates to the subscribed services using a **"task"**.
**~> Note:** It is recommended to have the (consul-terraform-sync config guide (link to be added))[https://www.consul.io/docs] for reference.
1. Download the **consul-terraform-sync** on a node which is highly available (prefrably, a node running a consul client)
2. Add **consul-terraform-sync** to the PATH on that node
3. Check the installation
```
$ consul-terraform-sync --version
0.1.0
Compatible with Terraform ~>0.13.0
```
4. Create a config file **"tasks.hcl"** for consul-terraform-sync. Please note that this just an example.
```terraform
log_level = # eg. "info"
driver "terraform" {
log = true
required_providers {
panos = {
source = "PaloAltoNetworks/panos"
}
}
}
consul {
address = "" # eg. "1.1.1.1:8500"
}
provider "panos" {
alias = "panos1"
hostname = "" # eg. "2.2.2.2"
username = "" # Username the API key is associated with for partial commit
api_key = ""
}
task {
name = # eg. "Create_DAG_on_PANOS1"
description = # eg. "Dynamic Address Groups based on service definition"
source = "github.com/PaloAltoNetworks/terraform-panos-dag-nia" # to be updated
providers = ["panos.panos1"]
services = [""] # eg. ["web", "api"]
variable_files = [""] # eg. ["/opt/panw-config/user-demo.tfvars"]
}
```
5. Start consul-terraform-sync
```
$ consul-terraform-sync -config-file=tasks.hcl
```
**consul-terraform-sync** will create right set of address groups and dynamic tags on the PAN-OS device based on the values in consul catalog.
**consul-terraform-sync is now subscribed to the Consul catalog. Any updates to the serices identified in the task will result in updating the address and the dyanmic address group tags on the PAN-OS devices**
**~> Note:** If you are interested in how **consul-terraform-sync** works, please refer to this [section](#how-does-consul-terraform-sync-work).
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| vsys\_name | PAN-OS virual system name, e.g., vsys1 | `string` | vsys1 | yes |
| dag\_prefix | Prefix to be added to the dynamic address group on PAN-OS device created by consul-terraform-sync | `string` | | no |
| dag\_suffix | Suffix to be added to the dynamic address group on PAN-OS device created by consul-terraform-sync | `string` | | no |
| services | Consul services monitored by consul-terraform-sync |
map(
object({
id = string
name = string
address = string
port = number
meta = map(string)
tags = list(string)
namespace = string
status = string
node = string
node_id = string
node_address = string
node_datacenter = string
node_tagged_addresses = map(string)
node_meta = map(string)
})
)
| n/a | yes |
## Outputs
| Name | Description |
|------|-------------|
| address\_groups | Name of address groups dynamically created on PAN-OS device through consul-terraform-sync |
| tag_to_ip_associatuion | Name of the dynamic address tags created and the IP addresses associated |
## How does consul-terraform-sync work?
There are 2 aspects of consul-terraform-sync.
1. **Updates from Consul catalog:**
In the backend, consul-terraform-sync creates a blocking API query session with the Consul agent indentified in the config to get updates from the Consul catalog.
consul-terraform-sync.
consul-terraform-sync will get an update for the services in the consul catalog when any of the following service attributes are created, updated or deleted. These updates include service creation and deletion as well.
* service id
* service name
* service address
* service port
* service meta
* service tags
* service namespace
* service health status
* node id
* node address
* node datacenter
* node tagged addresses
* node meta
2. **Managing the entire Terraform workflow:**
If a task and is defined, one or more services are associated with the task, provider is declared in the task and a Terraform module is specified using the source field of the task, the following sequence of events will occur:
1. consul-terraform-sync will install the required version of Terraform.
2. consul-terraform-sync will install the required version of the Terraform provider defined in the config file and declared in the "task".
3. A new direstory "nia-tasks" with a sub-directory corresponding to each "task" will be created. This is the reason for having strict guidelines around naming.
4. Each sub-directory corresponds to a separate Terraform workspace.
5. Within each sub-directory corresponding a task, consul-terraform-sync will template a main.tf, variables.tf, terraform.tfvars and terraform.tfvars.tmpl.
* **main.tf:**
* This files contains declaration for the required terraform and provider versions based on the task definition.
* In addition, this file has the module (identified by the 'source' field in the task) declaration with the input variables
* Consul K/V is used as the backend state for fo this Terraform workspace.
example generated main.tf:
```terraform
# This file is generated by Consul NIA.
#
# The HCL blocks, arguments, variables, and values are derived from the
# operator configuration for Consul NIA. Any manual changes to this file
# may not be preserved and could be clobbered by a subsequent update.
terraform {
required_version = "~>0.13.0"
required_providers {
panos = {
source = "PaloAltoNetworks/panos"
}
}
backend "consul" {
address = "1.1.1.1:8500"
gzip = true
path = "consul-nia/terraform"
}
}
provider "panos" {
api_key = var.panos.api_key
hostname = var.panos.hostname
}
# Dynamic Address Groups based on service definition
module "Create_DAG_on_PANOS1" {
source = "github.com/PaloAltoNetworks/terraform-panos-dag-nia"
services = var.services
vsys_name = var.vsys_name
}
```
* **variables.tf:**
* This is variables.tf file defined in the module
example generated variables.tf
```terraform
variable "services" {
description = "Consul services monitored by Consul NIA"
type = map(
object({
id = string
name = string
address = string
port = number
status = string
meta = map(string)
tags = list(string)
namespace = string
node = string
node_id = string
node_address = string
node_datacenter = string
node_tagged_addresses = map(string)
node_meta = map(string)
})
)
}
variable "vsys_name" {
# https://docs.paloaltonetworks.com/pan-os/9-0/pan-os-web-interface-help/device/device-virtual-systems.html
description = "The name of the virtual system"
type = string
default = "vsys1"
}
variable "dag_prefix" {
type = string
description = "(Optional) Prefix added to the dynamic address group created by Consul"
default = ""
}
variable "dag_suffix" {
type = string
description = "(Optional) Suffix added to the dynamic address group created by Consul"
default = ""
}
```
* **terraform.tfvars:**
* This is the most important file generated by consul-terraform-sync.
* This variables file is generated with the most updated values from Consul catalog for all the services identified in the task.
* consul-terraform-sync updates this file with the latest values when the corresponding service gets updated in Consul catalog.
example terraform.tfvars
```terraform
services = {
"api2" : {
id = "api2"
name = "api"
address = "172.31.29.206"
port = 8090
meta = {}
tags = ["api", "dc1", "test"]
namespace = null
status = "passing"
node = "i-03a2d3e5efc9df8fc"
node_id = "a179f33b-b4b5-bf85-1ba3-a8d29546dbfb"
node_address = "172.31.29.206"
node_datacenter = "us-east-1"
node_tagged_addresses = {
lan = "172.31.29.206"
lan_ipv4 = "172.31.29.206"
wan = "172.31.29.206"
wan_ipv4 = "172.31.29.206"
}
node_meta = {
consul-network-segment = ""
}
},
"api1" : {
id = "api1"
name = "api"
address = "172.31.13.27"
port = 8090
meta = {}
tags = ["api", "dc1", "test"]
namespace = null
status = "passing"
node = "i-06535c245da7eb639"
node_id = "3d32e036-8b5f-2528-6a08-153ee6246072"
node_address = "172.31.13.27"
node_datacenter = "us-east-1"
node_tagged_addresses = {
lan = "172.31.13.27"
lan_ipv4 = "172.31.13.27"
wan = "172.31.13.27"
wan_ipv4 = "172.31.13.27"
}
node_meta = {
consul-network-segment = ""
}
},
"api0" : {
id = "api0"
name = "api"
address = "172.31.94.1"
port = 8090
meta = {}
tags = ["api", "dc1", "test"]
namespace = null
status = "passing"
node = "i-0d61132ea5ad3c0bf"
node_id = "d7d41dc5-7b60-3dbb-0537-6abcf453daa9"
node_address = "172.31.94.1"
node_datacenter = "us-east-1"
node_tagged_addresses = {
lan = "172.31.94.1"
lan_ipv4 = "172.31.94.1"
wan = "172.31.94.1"
wan_ipv4 = "172.31.94.1"
}
node_meta = {
consul-network-segment = ""
}
},
"web0" : {
id = "web0"
name = "web"
address = "172.31.43.78"
port = 80
meta = {}
tags = ["dc1", "nginx", "test", "web"]
namespace = null
status = "passing"
node = "i-08040820d8d7c4984"
node_id = "63844302-407d-5cc6-a618-a9e5caad1d1f"
node_address = "172.31.43.78"
node_datacenter = "us-east-1"
node_tagged_addresses = {
lan = "172.31.43.78"
lan_ipv4 = "172.31.43.78"
wan = "172.31.43.78"
wan_ipv4 = "172.31.43.78"
}
node_meta = {
consul-network-segment = ""
}
},
"web3" : {
id = "web3"
name = "web"
address = "192.168.128.17"
port = 80
meta = {}
tags = ["dc1", "nginx", "test", "web"]
namespace = null
status = "passing"
node = "i-0d61132ea5ad3c0bf"
node_id = "d7d41dc5-7b60-3dbb-0537-6abcf453daa9"
node_address = "172.31.94.1"
node_datacenter = "us-east-1"
node_tagged_addresses = {
lan = "172.31.94.1"
lan_ipv4 = "172.31.94.1"
wan = "172.31.94.1"
wan_ipv4 = "172.31.94.1"
}
node_meta = {
consul-network-segment = ""
}
},
"web1" : {
id = "web1"
name = "web"
address = "172.31.51.85"
port = 80
meta = {}
tags = ["dc1", "nginx", "test", "web"]
namespace = null
status = "passing"
node = "i-0f92f7eb4b6fb460a"
node_id = "778506df-a1b2-65e0-fe1e-eafd2d1162a8"
node_address = "172.31.51.85"
node_datacenter = "us-east-1"
node_tagged_addresses = {
lan = "172.31.51.85"
lan_ipv4 = "172.31.51.85"
wan = "172.31.51.85"
wan_ipv4 = "172.31.51.85"
}
node_meta = {
consul-network-segment = ""
}
}
}
```
* **Network Infrastructure Automation (NIA) compatible modules are built to utilize the above service variables**
6. **consul-terraform-sync** manages the entire Terraform workflow of plan, apply and destroy for all the individual workspaces corrresponding to the defined "tasks" based on the updates to the services to those tasks.
**In summary, consul-terraform-sync triggers a Terraform workflow (plan, apply, destroy) based on updates it detects from Consul catalog.**