Interacting with the command-line assistant powered by RHEL Lightspeed

Procedure

1. Enable the terminal capture for your current terminal session:

   $ c shell --enable-capture

2. Run at least one command before you reference previous commands.

3. Reference the output of a previously run command. For example, to reference the previous command, run:

   $ c -w 1 "what_is_this"

   • To reference the second to previous command, run:

     $ c -w 2 "what_is_this"

4. To stop terminal capture, press the Ctrl + D keys on your keyboard.:

Procedure

1. Authenticate to the Red Hat Container Registry:

   $ podman login registry.redhat.io

2. Run the installer container. This command downloads the necessary images and installs the offline RHEL command-line assistant on your system.

   $ podman run -u : --rm \
   -v $HOME/.config:/config:Z \
   -v $HOME/.local/bin:/config/.local/bin:Z \
   registry.redhat.io/rhel-cla/installer:latest

3. Optional: To automatically start the offline RHEL command-line assistant containers each time the system boots, add the install-systemd argument to the podman run command:

   $ podman run -u : --rm \
   -v $HOME/.config:/config:Z \
   -v $HOME/.local/bin:/config/.local/bin:Z \
   registry.redhat.io/rhel-cla/installer:latest install-systemd

4. Verify that the container is running:

   $ podman ps
   CONTAINER ID   IMAGE         COMMAND     CREATED          STATUS
   ba655e5efdcd   installer-rh… /sbin/init  30 seconds ago   Up 29 seconds

5. Install the RHEL command-line-assistant client package on your RHEL system:

   # sudo dnf install command-line-assistant

6. Update the endpoint configuration option.

   1. Open the /etc/xdg/command-line-assistant/config.toml file in a text editor.

   2. Locate the endpoint variable and change its value to the address of the system hosting your offline RHEL command-line assistant containers. For example, to connect to the local system:

      endpoint = "http://127.0.0.1:8000/"

7. Restart the clad service to apply the new configuration:

   $ sudo systemctl restart clad

   After the installation is complete, you can use the rhel-lightspeed command to start, stop, uninstall, and check the status of the offline RHEL command-line assistant.

Verification

1. Check if the offline RHEL command-line assistant is running:

   $ rhel-lightspeed start

2. Check if the client is correctly configured by asking a question:

   $ c "what is an immutable file?"
   
   + Asking Red Hat Lightspeed
   This feature uses AI technology. Do not include any personal information or other sensitive information in your input. Interactions may be used to improve Red Hat's products or services.

Procedure

1. Open the ~/.config/rhel-lightspeed/.env file in a text editor. For example:

   $ vi ~/.config/rhel-lightspeed/.env

2. Set the container image variable:

   1. Locate the LLAMACPP_IMAGE variable and set it up to the corresponding ramalama container for your GPU hardware. For example:

      LLAMACPP_IMAGE="registry.redhat.io/rhel-cla/ramalama-rhel10-nvidia:latest"

3. Set the host device variable:

   1. Locate the HOST_DEVICE variable for the device of your GPU. For example:

      # For AMD GPUs
      HOST_DEVICE="/dev/dri"
      # For NVIDIA GPUs
      HOST_DEVICE="/dev/nvidia0"

4. Optional: Configure NVIDIA-specific variables:

   1. Locate and set up the NVIDIA-specific variables.

5. Restart the assistant to apply the changes:

   $ rhel-lightspeed stop
   $ rhel-lightspeed start

Procedure

1. Check the SSHD status and restart it.

   $ sudo systemctl status ssh
   $ sudo systemctl restart ssh

2. Enable the optional command-line assistant terminal capture feature:

   $ c shell --enable-capture

3. Use the -w 1 "your_question" option to specify to include the output from the last command that was run.

   $ c -w 1 "what_is_this"

   • If you specify the number 2, that references the output from the second-to-last command. This is also true for the additional numbers.

   • You can also specify a prompt to run with the command and ask "help me understand the output", and reference the output with the error, so that the command-line assistant understands that you are asking for more details on what the error is.

     The command-line assistant processes the request and provides several possible solutions. In the example, you can use the suggestion to run the journalctl -xeu sshd.service command to check the log files.

4. Run that journalctl command and check the log files to identify potential issues.

   $ journalctl -xeu sshd.service

5. Ask the command-line assistant to generate a command on how to fix this typing error.

   $ c "what is the command that I can use to change 'Porrt' to 'Port' in the /etc/ssh/sshd_config file?"

6. Run the command suggested by the command-line assistant as a sudo user. For example:

   $ sudo sed -i s/Porrt/Port/g /etc/ssh/sshd_config

Procedure

1. On your terminal, enter the following command to list the httpd package version that you have installed in your system:

   $ sudo rpm -qa httpd
   httpd-2.4.62-2.fc40.x86_64

2. Query all httpd packages:

   $ sudo rpm -qa httpd

3. Identify the ports on which the web server accepts incoming requests:

   $ cat /etc/httpd/conf/httpd.conf | grep Listen
   # Listen: Allows you to bind Apache to specific IP addresses and/or
   # Change this to Listen on a specific IP address, but note that if
   #Listen 12.34.56.78:80
   Listen 80

4. Restart the httpd service:

   $ systemctl restart httpd
   
   Job for httpd. Service failed because the control process exited with error code.
   See "systemctl status httpd.service" and "journalctl -xeu httpd.service" for details.

   1. Run the journalctl command for more details on the failed service:

      $ sudo journalctl -xeu httpd.service

5. Use the command-line assistant to troubleshoot the issue and ask why the service is failing:

   $ sudo c "why did httpd fail to start"

   1. Ask the command-line assistant about the selinux httpd port:

      $ c "selinux httpd port"

      The assistant advises using the sestatus command to check the current SELinux status and the content of the httpd services with the following command:

      $ sudo sestatus
      
      SELinux status:                 enabled
      SELinuxfs mount:                /sys/fs/selinux
      SELinux root directory:         /etc/selinux
      Loaded policy name:             targeted
      Current mode:                   enforcing
      Mode from config file:          enforcing
      Policy MLS status:              enabled
      Policy deny_unknown status:     allowed
      Memory protection checking:     actual (secure)
      Max kernel policy version:      33

   2. View the specific SELinux policy for the httpd services by running the following command:

      $ sudo cat /usr/share/selinux/targeted/contexts/httpd_var_run_t
      No such file or directory

   3. Ask the command-line assistant about contexts.

      $ c "i don't have a httpd_var_run_t contexts"

      The command-line assistant takes some time to process the request, then provides several possible suggestions.

   4. The assistant says that you might not have context and need to set it with the following command:

      $ sudo chcon -R -t httpd_var_run_t

   5. Ask the CLA about the port:

      $ c "selinux won't let httpd listen on port 12345"

   6. Try the following suggestion, run the command:

      $ sudo semanage port -a -t httpd_port_t -p tcp 12345
      ValueError: Type httpd_port_t is invalid, must be a port type

   7. Ask the CLA about the error you see in the output:

      $ c "how do I fix ValueError: Type httpd_port_t is invalid, must be a port type"

6. Run the steps provided by the CLA:

   $ sudo ls -Z /usr/sbin/httpd
   system_u:object_r:httpd_exec_t:s0 /usr/sbin/httpd
   
   $ chcon -t httpd_exec_t /usr/sbin/httpd
   
   $ sudo setenforce 1

   1. Restart the httpd service and check the status of httpd.service:

      $ sudo systemctl restart httpd
      Job failed
      
      $ sudo systemctl status httpd.service
      Failed to start the Apache Server

7. Ask the CLA how to enable httpd to listen on port 12345:

   $ c "how do I enable httpd to listen on port 12345 selinux"

   1. Run the command advised by the CLA:

      $ sudo setsebool -P httpd_can_network_connect=1

8. Restart the httpd service and check the status of httpd.service again:

   $ sudo systemctl status httpd
   $ sudo systemctl restart httpd
   Job failed, see journalctl

9. Check the journalctl service:

   $ journalctl -xeu httpd
   Output: An ExecStart= process belonging to unit httpd.service has exited.

10. Use the output to ask the CLA to troubleshoot:

    $ c "An ExecStart= process belonging to unit httpd.service has exited."

    1. Run the command that the CLA responds with:

       $ sudo ausearch -m AVC,USER_AVC -ts recent
       Output: "avc:  denied  {name_bind}  for pid=7184 comm="httpd" src=12345 scontext=system_u:system_r:httpd_t:s0 tcontext=system_u:object_r: unreserved_port_t:s0 tclas=tcp_socket permissive=0"

    2. Copy the output of the previous command:

       $ sudo c "avc: denied {name_bind} for pid=7184 comm="httpd" src=12345 scontext=system_u:system_r:httpd_t:s0 tcontext=system_u:object_r: unreserved_port_t:s0 tclas=tcp_socket permissive=0"

    3. Run the following command to resolve the error “SELinux is preventing Apache Server (httpd) from binding to port 12345".

       $ sudo semanage port -a -t http_port_t -p tcp 12345

Procedure

1. Check if the system is registered:

   # subscription-manager identity

2. If the system is not registered, use the following command to register the system:

   # subscription-manager register

Procedure

1. Restart the command-line assistant daemon (clad).

   $ systemctl restart clad

2. Rerun the c command with your question:

   $ c "<Your_question>"

Procedure

1. Change the key.pem permission to root.

   $ sudo ls -l /etc/pki/consumer/
   $ sudo chown $(whoami):$(id -gn) /etc/pki/consumer/${<key_name>}

2. Run clad commands as root.

   $ sudo chown $(whoami):$(id -gn) /etc/pki/consumer/${<key_name>}

Procedure

1. Access the proxy configuration by opening the /etc/xdg/command-line-assistant/config.toml configuration file.

2. Locate and change the following block in the config.toml file :

   # Backend settings for communicating with the external API.
   [backend]
   ...
   # proxies = { http = "http://example-host:8002", https = "https://example-host:8002" }

3. Uncomment the proxies key and define your http or https proxy host:

   [backend]
   …
   # For a https proxy host
   proxies = { https = "https://<your_https_proxy_host:1234>"}

4. After making the changes, restart clad for the changes to be effective:

   $ sudo systemctl restart clad

   注意

   You can use the http value and https key control if the http or https traffic from clad is routed to the specified proxy. However, the protocol does not influence the proxy type selection, and you can have a configuration that uses http proxy for https traffic. For example:

   https = "http://<your_https_proxy_host:1234>"

Procedure

1. Install the database of your choice:

   • To install MySQL, enter:

     # dnf install python3-PyMySQL

   • To install PostgreSQL, enter:

     # dnf install python3-psycopg2

2. Access your database configuration file at /etc/xdg/command-line-assistant/config.toml.

3. Locate and comment out the default configuration. For example:

    [database]
       # type = "sqlite"
       # connection_string = "/var/lib/command-line-assistant/history.db"

4. Configure the database of your choice. The following information is also available in /etc/xdg/command-line-assistant/config.toml.

   1. Set the database type, where <db_type> can be mysql or postgresql.

   2. Set the database details.

       type = <db_type>
       host = "<hostname_or_ip_address>"
       port = "5432"
       username = "<database_user_name>"
       password = "<password>"
       database = "<database_name>"

5. After changing the database type, restart the clad daemon to apply the changes:

   $ sudo systemctl restart clad

Procedure

1. Access your database configuration file at /etc/xdg/command-line-assistant/config.toml.

2. Remove the username and password parameters from the [database] section, for example:

   [database]
   type = "postgresql"
   host = "localhost"
   port = "5432"
   database = "history"

   注意

   If you leave the username and password in the configuration file, these credentials take precedence over the systemd-creds tool.

3. Generate encrypted credentials for your username or password. The following example uses systemd-ask-password commands. The name must follow the schema of database-username and database-password, otherwise, clad does not load the credentials properly.

   1. To generate an encrypted username, run the following command:

      $ systemd-ask-password -n | ( echo "[Service]" && systemd-creds encrypt --name=<database_username> -p - - ) >/etc/systemd/system/clad.service.d/<username>.conf

   2. To generate an encrypted password, run the following command:

      $ systemd-ask-password -n | ( echo "[Service]" && systemd-creds encrypt --name=<database_password> -p - - ) >/etc/systemd/system/clad.service.d/<password>.conf

4. After updating the database credentials, reload systemd and restart the clad daemon to apply the changes:

   $ sudo systemctl daemon-reload
   $ sudo systemctl restart clad