Skip to content

Punch Resources

To run properly your pipelines, you may need additional resources such as :

  • log parsers: provided by punch or your own.
  • custom parsers : user-provided.
  • pex & jars : user-provided.

Each resource must be composed with an archive (zip, pex or jar) and a metadata file which contains mandatory information about the resource.

Get or Create resources

Before uploading all these resources to Punch resource manager, you need to have all of them into your Punch Console.

For custom parsers and custom nodes, you can create them by following development guides locally or import them to the Punch Console once generated elsewhere.

Punch default parsers

Tip

To download Punch parsers, you only need to have a laptop with an internet access. You do not need to install Punch Console. Just unzip it.

From a laptop with an internet access :

1 . Go to the ./components/parsers folder in PConsole. It contains a resources.txt with Punch default parsers for your platform :

# This file lists the images that should be downloaded with
# resources-helper.sh script.

# Punch Parsers
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-common-punchlets/1.0.0/punch-common-punchlets-1.0.1-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-core-parsers/1.0.0/punch-core-parsers-1.0.0-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-forcepoint-parsers/1.0.0/punch-forcepoint-parsers-1.0.0-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-microsoft-parsers/1.0.0/punch-microsoft-parsers-1.0.0-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-stormshield-parsers/1.0.0/punch-stormshield-parsers-1.0.0-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-unix-parsers/1.0.0/punch-unix-parsers-1.0.0-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-webserver-parsers/1.0.0/punch-webserver-parsers-1.0.0-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-cisco-parsers/1.0.0/punch-cisco-parsers-1.0.0-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-fortinet-parsers/1.0.0/punch-fortinet-parsers-1.0.0-artefact.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-geoipv4-resources/1.0.0/punch-geoipv4-resources-1.0.0.zip
https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-geoipv6-resources/1.0.0/punch-geoipv6-resources-1.0.0.zip
(Note: You can update resources.txt file to download only necessary parsers)

You must add your Artifactory credentials to retrieve the resources :

https://artifactory.thalesdigital.io/artifactory/private-generic-punch/org/thales/punch/punch-common-punchlets/1.0.0/punch-common-punchlets-1.0.0-artefact.zip auth-basic=<artifactory-username>:<artifactory-password>

Ask Punch Team a read-only token if you do not have a personal account on Thales Digital Artifactory.

2 . Download parsers by running :

./bin/resources-helper.sh download --components=parsers --from . --to ./components/parsers
All images will be downloaded in ./components/parsers as tarballs:
├── artifactory
│   └── private-generic-punch
│       └── org
│           └── thales
│               └── punch
│                   ├── punch-cisco-parsers
│                   │   └── 1.0.0
│                   │       └── punch-cisco-parsers-1.0.0-artefact.zip
│                   ├── punch-common-punchlets
│                   │   └── 1.0.0
│                   │       └── punch-common-punchlets-1.0.0-artefact.zip
│                   ├── punch-core-parsers
│                   │   └── 1.0.0
│                   │       └── punch-core-parsers-1.0.0-artefact.zip
│                   ├── punch-forcepoint-parsers
│                   │   └── 1.0.0
│                   │       └── punch-forcepoint-parsers-1.0.0-artefact.zip
│                   ├── punch-fortinet-parsers
│                   │   └── 1.0.0
│                   │       └── punch-fortinet-parsers-1.0.0-artefact.zip
│                   ├── punch-microsoft-parsers
│                   │   └── 1.0.0
│                   │       └── punch-microsoft-parsers-1.0.0-artefact.zip
│                   ├── punch-stormshield-parsers
│                   │   └── 1.0.0
│                   │       └── punch-stormshield-parsers-1.0.0-artefact.zip
│                   ├── punch-unix-parsers
│                   │   └── 1.0.0
│                   │       └── punch-unix-parsers-1.0.0-artefact.zip
│                   └── punch-webserver-parsers
│                       └── 1.0.0
│                           └── punch-webserver-parsers-1.0.0-artefact.zip

Once extracted, each artefact contains the zip file to be uploaded along with its metadata.yml.

Upload resources

To upload your resources into the Artifacts Server, use the resourcectl command.