PaloAltoNetworks / PaloAltoNetworks/pan.dev

Issue/Help with "Configuration Details"

Open
#492 0 comments 0 reactions 1 assignee View on GitHub

@FoSix is already working on this.

Since Oct 6, 2023.

documentation
Dominant language
MDX
Stars
78
Forks
88
Avg merge
5d 17h
Merged PRs (30d)
18

Description

Documentation link

https://pan.dev/panos/docs/panos-upgrade-assurance/configuration-details/#readiness-checks

Describe the problem

Small cosmetic changes and one minor fix.

cosmetics

The example payload provided is inconsistent in its usage of "" and ', and the whitespacing is inconsistent with the previous examples of four spaces.

minor fix

This same payload is currently missing a comma, breaking the data structure in its current representation.

[
  "active_support",
  'candidate_config',
  'expired_licenses',
  'ntp_sync',
  'panorama',
  # tests below have optional configuration
  {
    "certificates_requirements": {
      "ecdsa": {"hash_method": "sha512"},
      "rsa": {
        "key_size": 1024,
        "hash_method": "sha1"
      }
    }
  },
  {'content_version': {'version': '8634-7678'}},
  {"expired_licenses": {"skip_licenses": ["Threat Prevention"]}},
  {'free_disk_space': {'image_version': '10.1.6-h6'}},
  {'ha': {'skip_config_sync': True}},
  {'planes_clock_sync': {'diff_threshold': 30}}
  # tests below require additional configuration
  {'arp_entry_exist': {'ip': '10.0.1.1'} },
  {'ip_sec_tunnel_status': {
    'tunnel_name': 'ipsec_tun'
  }},
  {'session_exist': {
    'source': '134.238.135.137',
    'destination': '10.1.0.4',
    'dest_port': '80'
  }},
]

Suggested fix

  1. standardize on double quotes and whitespacing to satiate those of us with OCD
  2. added a comma after the planes_clock_sync key / value pair to allow data structure to continue
[
    "active_support",
    "candidate_config",
    "expired_licenses",
    "ntp_sync",
    "panorama",
    # tests below have optional configuration
    {
        "certificates_requirements": {
            "ecdsa": {"hash_method": "sha512"},
            "rsa": {"key_size": 1024, "hash_method": "sha1"},
        }
    },
    {"content_version": {"version": "8634-7678"}},
    {"expired_licenses": {"skip_licenses": ["Threat Prevention"]}},
    {"free_disk_space": {"image_version": "10.1.6-h6"}},
    {"ha": {"skip_config_sync": True}},
    {"planes_clock_sync": {"diff_threshold": 30}},
    # tests below require additional configuration
    {"arp_entry_exist": {"ip": "10.0.1.1"}},
    {"ip_sec_tunnel_status": {"tunnel_name": "ipsec_tun"}},
    {
        "session_exist": {
            "source": "134.238.135.137",
            "destination": "10.1.0.4",
            "dest_port": "80",
        }
    },
]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.