pingcap / pingcap/tiup

Improved Firewall handling

Open
#2,503 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type/feature-request
Dominant language
Go
Stars
466
Forks
338
Avg merge
3d 7h
Merged PRs (30d)
8

Description

Feature Request

Is your feature request related to a problem? Please describe:

  1. tiup cluster check --apply only temporarily disables firewalld.service. It does a systemctl stop, but not a systemctl disable/systemctl mask. This leaves this as a booby trap that will explode on next reboot.
  2. Disabling the firewall doesn't seem to be the right action. Changing the zone from public to trusted seems to be a better option.
  3. Some high security deployments might not allow one to disable the firewall
  4. The docs aren't clear that a host based firewall isn't recommended, but a network based firewall around the cluster is.

Describe the feature you'd like:

  1. Make sure whatever tiup cluster check --apply is done in a persistent way that survives reboots
  2. Don't disable the firewall. Change the zone instead.
  3. Extend documentation for what ports need to be open, both for host based firewalls and for network based firewalls around the cluster.
  4. Allow one to operate with a firewall enabled.
  5. Create service definitions for the firewall service which then can be added to the zone.

Why the featue is needed:

Describe alternatives you've considered:

Teachability, Documentation, Adoption, Migration Strategy:

Related:

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.

Research direction

Start with pkg/cluster/task/check.go at the linked line and review related issue #1329, then compare the existing firewall behavior with the linked security and network documentation. Done means the requested firewall-enabled operation, persistent configuration, service definitions, and documentation for host- and network-based firewall ports are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, linux
Domain
devops, documentation, infrastructure, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.