theforeman / theforeman/foremanctl

Add support for showing the values of the parameters in foremanctl deploy --help

Open
#281 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
27
Forks
47
Avg merge
1d 12h
Merged PRs (30d)
40

Description

The current installer shows the values of options for foreman-installer --help
For example:

# satellite-installer --full-help | grep foreman-db-database
    --foreman-db-database                                                        Database 'production' database (e.g. foreman) (current: "foreman")
    --reset-foreman-db-database                                                  Reset db_database to the default value ("foreman")

Here the current database name is shown which is "foreman"
In the foremanctl the behaviour is different.

# foremanctl deploy --help | grep foreman-database-name
                         [--foreman-database-name FOREMAN_DATABASE_NAME]
                         [--reset-foreman-database-name]
  --foreman-database-name FOREMAN_DATABASE_NAME
  --reset-foreman-database-name

I think many customers might be using this functionality for fetching the values quickly and would be good to maintain the similarity between old and new installer

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 by running foremanctl deploy --help and tracing the deploy command's help-generation entry point. Compare its parameter output with foreman-installer --full-help; done means deploy help displays current parameter values and reset defaults consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.