Uploaded image for project: 'JBoss Enterprise Application Platform'
  1. JBoss Enterprise Application Platform
  2. JBEAP-12193

Fix formatting of CLI commands in security guides

    XMLWordPrintable

Details

    Description

      For 7.1, the security guides have started formatting their management CLI commands with back slashes to break them up onto separate lines. I believe the intent was for better readability by users. However there are two issues with this:

      1. This is not something that we do in our other guides (CLI guide, configuration guide), so it is inconsistent.
      2. If you copy and paste one of these commands into the CLI, you can't go back and change values other than the last line (before the last slash) before you submit. Brian Stansberry confirmed this and brought this up as a concern, since this is probably a regular practice by users.

      The second issues is the most problematic, especially since we regularly use test or replaceable values in our commands that a user would HAVE to replace before it is a valid command. An example is here [1], and shown below. If the user wanted to copy and paste this command into the CLI, they wouldn't be able to change any of the test values, like the real path instead of "/path/to".

      /subsystem=elytron/kerberos-security-factory=krbSF:add( \
        principal="HTTP/host@REALM", \
        path="/path/to/http.keytab", \
        mechanism-oids=[ \
          1.2.840.113554.1.2.2, \
          1.3.6.1.5.5.2 \
        ] \
      )
      

      The security guides (and any other places that use this formatting) should be updated to remove the backslash formatting from their CLI commands.

      [1] https://access.qa.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.1.Beta/html-single/how_to_set_up_sso_with_kerberos/#elytron_http_auth_app

      Attachments

        Activity

          People

            rhn-support-chuffman Christian Huffman
            rhn-support-ahoffer Andrea Hoffer
            Martin Svehla Martin Svehla
            Martin Svehla Martin Svehla
            Votes:
            0 Vote for this issue
            Watchers:
            8 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: