2.5 Creating Flight Control troubleshooting section (#2853) (#2872)

* Creating Flight Control troubleshooting section

[Docs] Flight Control - Troubleshooting

https://issues.redhat.com/browse/AAP-39628

Affects `titles/flight-control-user-guide`

Author: EMcWhinn

downstream/assemblies/flight-control/flight-control

@@ -0,0 +1,9 @@
+[id="assembly-flight-control-troubleshooting"]
+
+= Troubleshooting {RedHatEdge}
+
+When working with devices in {RedHatEdge}, you might see issues related to configuration, connectivity, or deployment. 
+Troubleshooting these issues requires understanding how device configurations are applied, how to check logs, and how to verify communication between the device and the service.
+
+include::platform/proc-flight-control-view-device-config.adoc[leveloffset=+1]
+include::platform/proc-flight-control-generate-device-log.adoc[leveloffset=+1]

downstream/assemblies/platform/assembly-flight-control-troubleshooting.adoc

@@ -103,7 +103,8 @@
 :ControllerAG: Configuring automation execution
 :Analytics: Automation Analytics
 
-
+// Red Hat Edge Manager
+:RedHatEdge: Red Hat Edge Manager
 
 // Execution environments
 :ExecEnvNameStart: Automation execution environments

downstream/attributes/attributes.adoc

@@ -0,0 +1,20 @@
+[id="flight-control-generate-device-log"]
+
+= Generating a device log bundle
+
+The device includes a script that generates a bundle of logs necessary to debug the agent. 
+
+.Procedure
+
+* Run the following command on the device and include the .tar file in the bug report. 
++
+[NOTE] 
+====
+This depends on an SSH connection to extract the .tar file.
+====
++
+[literal, options="nowrap" subs="+attributes"]
+----
+sudo flightctl-must-gather
+----
+

downstream/modules/platform/proc-flight-control-generate-device-log.adoc

@@ -0,0 +1,17 @@
+[id="proc-flight-control-view-device-config"]
+
+= Viewing a device's effective target configuration
+
+The device manifest returned by the `flightctl get device` command still only has references to external configuration and secret objects.
+Only when the device agent queries the service, the service replaces the references with the actual configuration and secret data. 
+While this better protects potentially sensitive data, it also makes troubleshooting faulty configurations hard. 
+This is why a user can be authorized to query the effective configuration as rendered by the service to the agent.
+
+.Procedure
+
+* To query the effective configuration, use the following command:
++
+[literal, options="nowrap" subs="+attributes"]
+----
+flightctl get device/${device_name} --rendered | jq
+----

downstream/modules/platform/proc-flight-control-view-device-config.adoc

@@ -1,9 +1,9 @@
 <title>Flight Control</title>
 <productname>Red Hat Ansible Automation Platform</productname>
 <productnumber>2.5</productnumber>
-<subtitle>Install and configure Flight Control</subtitle>
+<subtitle>Enable Red Hat Edge Manager</subtitle>
 <abstract>
-    <para>This guide shows you how to install, configure, and use Flight Control to manage individual and fleets of devices.</para>
+    <para>This guide shows you how to install, configure, and use {RedHatEdge} to manage individual and fleets of devices.</para>
 </abstract>
 <authorgroup>
     <orgname>Red Hat Customer Content Services </orgname>

downstream/titles/flight-control/flight-control-user-guide/docinfo.xml

@@ -6,10 +6,12 @@
 include::attributes/attributes.adoc[]
 
 // Book Title
-= Installing and configuring Flight Control
+= Enabling Red Hat Edge Manager
 
-Flight Control aims to give simple, scalable, and secure management of edge devices and applications. 
+{RedHatEdge} aims to give simple, scalable, and secure management of edge devices and applications. 
 You can declare the operating system version, host configuration, and set of applications that you want to run on an individual device or a whole fleet of devices.
-Flight Control rolls out the target configuration to devices where a device agent automatically applies them and report progress and health status back up.
+{RedHatEdge} rolls out the target configuration to devices where a device agent automatically applies them and report progress and health status back up.
 
 include::{Boilerplate}[]
+
+include::platform/assembly-flight-control-troubleshooting.adoc[leveloffset=+1]

downstream/titles/flight-control/flight-control-user-guide/flight-control

@@ -0,0 +1 @@
+../../../assemblies/platform