Uploaded image for project: 'RHEL Conversions'
  1. RHEL Conversions
  2. RHELC-854

Man/help page to mention config file location

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done-Errata
    • Icon: Minor Minor
    • 1.2
    • None
    • None
    • False
    • False
    • Hide

      None

      Show
      None
    • 1
    • 2023-Q1
    • Testable

      Currently we explain where convert2rhel expects a configuration file in the /etc/convert2rhel.ini configuration file:

      # cat /etc/convert2rhel.ini
      # -*- coding: utf-8 -*-
      # This file should be in mode 0600
      # Example of configuration file convert2rhel.ini for secrets.
      # Possible locations of this file:
      # 1) user specified and passed by -c, --config-file option; highest priority
      # 2) ~/.convert2rhel.ini; lower priority
      # 3) /etc/convert2rhel.ini; the lowest priority
      
      [subscription_manager]
      # password = <insert_password>
      # activation_key = <insert_activation_key>
      

      The man/help page is not descriptive enough about that:

          -c CONFIG_FILE, --config-file=CONFIG_FILE
                              A configuration file to safely provide either a user
                              password or an activation key for registering the
                              system through subscription-manager. Alternatively,
                              passing these values through the --activationkey or
                              --password option would leak them through a list of
                              running processes. Example of this file in
                              /etc/convert2rhel.ini
      

      The new message:
      https://docs.google.com/document/d/1DwLWhRJggr989HTkhQlOxOD_UVLbkNQ2dkg1ZavN9fc/edit#

      Acceptance criteria:

      • the man/help page (the source code for both is the same) mentions under the "--config-file" option what paths convert2rhel looks at to find a configuration file as well as that using this option overrides looking at these default paths.

              ahosek@redhat.com Adam Hosek
              mbocek@redhat.com Michal Bocek
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: