Skip to content

feat: add command-line arguments to install.sh for Quick Start alignment#66

Merged
homepods merged 1 commit intomainfrom
claude/hookprobe-dsm-whitepaper-01CRuWQisJL1Sz3ZjAWgSDoE
Nov 27, 2025
Merged

feat: add command-line arguments to install.sh for Quick Start alignment#66
homepods merged 1 commit intomainfrom
claude/hookprobe-dsm-whitepaper-01CRuWQisJL1Sz3ZjAWgSDoE

Conversation

@homepods
Copy link
Copy Markdown
Member

Added --role argument support to align install.sh with Quick Start guide in README.md. The installer now supports both automated and interactive modes.

Changes

New Command-Line Interface

  • ./install.sh --role edge - Automated edge node installation
  • ./install.sh --role validator - Automated cloud validator installation
  • ./install.sh --role cloud - Alias for validator role
  • ./install.sh --help - Show usage information
  • ./install.sh - Interactive menu (original behavior preserved)

Automated Installation Features

  • Non-interactive deployment for CI/CD pipelines
  • Clear post-installation instructions with Neuro protocol setup
  • Automatic service start commands displayed
  • Dashboard URL shown after edge installation
  • Validator configuration guidance after cloud installation

Post-Installation Steps Displayed

After edge installation:

  1. Initialize Neuro Protocol: python3 -m neuro.tools.init_weights --node-id edge-001
  2. Start services: systemctl start hookprobe-edge & hookprobe-neuro
  3. Verify installation: systemctl status hookprobe-edge
  4. Access dashboard: https://:8443

After validator installation:

  1. Configure validator settings
  2. Start validator services
  3. Verify Neuro deterministic replay
  4. Configure edge nodes to connect

Alignment with Quick Start Guide

Now matches README.md Quick Start examples:

  • sudo ./install.sh --role edge
  • sudo ./install.sh --role validator

Backward Compatibility

βœ“ Interactive menu mode preserved when no arguments provided βœ“ All existing menu options remain functional
βœ“ No breaking changes to existing workflows

Pull Request

πŸ“‹ Description

Brief summary of changes:

Related Issue:

Fixes #

🎯 Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Security enhancement
  • Infrastructure/CI improvement
  • Refactoring (no functional changes)

πŸ”§ Component(s) Affected

  • Deployment scripts (setup.sh, uninstall.sh, network-config.sh)
  • Security features (Qsecbit, WAF, IDS/IPS)
  • Networking (VXLAN, OVS, OpenFlow)
  • Containers/PODs
  • Monitoring (Grafana, VictoriaMetrics)
  • n8n automation (POD 008)
  • LTE/5G connectivity
  • Documentation
  • Testing infrastructure
  • Other:

πŸ§ͺ Testing Done

How was this tested?

  • Fresh deployment test (./setup.sh in clean environment)
  • Uninstall test (./uninstall.sh verifies complete cleanup)
  • Service functionality tests
  • Network isolation tests
  • Security regression tests
  • Manual testing only
  • Automated tests added/updated

Test environment:

  • OS:
  • Podman version:
  • Hardware:

Test results:

# Paste relevant test output

βœ… Checklist

Before submitting this PR:

  • I have read CONTRIBUTING.md
  • My code follows the project's coding standards
  • I have tested my changes in a clean environment
  • I have updated documentation (README.md, CLAUDE.md, etc.)
  • I have checked for exposed secrets/credentials
  • My commit messages follow the conventional commits format
  • I have run shellcheck on bash scripts (if applicable)
  • I have run linting on Python code (if applicable)
  • All deployment scripts still work after my changes
  • I have verified network ranges are correct (10.200.x.x)

Security considerations:

  • No hardcoded credentials added
  • No security features disabled
  • User input is validated (if applicable)
  • No command injection vulnerabilities introduced
  • Changes reviewed for OWASP Top 10 vulnerabilities

πŸ“Έ Screenshots/Logs

Before:

# Show state before changes (if applicable)

After:

# Show state after changes

πŸ”„ Breaking Changes

Does this PR introduce breaking changes?

  • No
  • Yes (explain below)

πŸ“š Documentation Updates

Documentation changes made:

  • README.md updated
  • CLAUDE.md updated (for AI-relevant changes)
  • CHANGELOG.md updated
  • Component-specific README updated
  • Inline code comments added
  • No documentation changes needed

πŸ’¬ Additional Notes

πŸ“ Reviewer Notes

Specific areas to review:


By submitting this PR, I confirm:

  • This code is my own work or properly attributed
  • I agree to license contributions under the MIT License
  • I have followed the security disclosure policy for any security-related changes

Added --role argument support to align install.sh with Quick Start guide
in README.md. The installer now supports both automated and interactive modes.

## Changes

### New Command-Line Interface
- `./install.sh --role edge` - Automated edge node installation
- `./install.sh --role validator` - Automated cloud validator installation
- `./install.sh --role cloud` - Alias for validator role
- `./install.sh --help` - Show usage information
- `./install.sh` - Interactive menu (original behavior preserved)

### Automated Installation Features
- Non-interactive deployment for CI/CD pipelines
- Clear post-installation instructions with Neuro protocol setup
- Automatic service start commands displayed
- Dashboard URL shown after edge installation
- Validator configuration guidance after cloud installation

### Post-Installation Steps Displayed
After edge installation:
1. Initialize Neuro Protocol: python3 -m neuro.tools.init_weights --node-id edge-001
2. Start services: systemctl start hookprobe-edge & hookprobe-neuro
3. Verify installation: systemctl status hookprobe-edge
4. Access dashboard: https://<IP>:8443

After validator installation:
1. Configure validator settings
2. Start validator services
3. Verify Neuro deterministic replay
4. Configure edge nodes to connect

## Alignment with Quick Start Guide
Now matches README.md Quick Start examples:
- sudo ./install.sh --role edge
- sudo ./install.sh --role validator

## Backward Compatibility
βœ“ Interactive menu mode preserved when no arguments provided
βœ“ All existing menu options remain functional
βœ“ No breaking changes to existing workflows
@homepods homepods merged commit e7ba55d into main Nov 27, 2025
28 checks passed
@homepods homepods deleted the claude/hookprobe-dsm-whitepaper-01CRuWQisJL1Sz3ZjAWgSDoE branch November 27, 2025 05:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants