fix(OHI Kafka): Fixing errors and missing info in the Kafka integration

src/install/config/kafka.yaml

@@ -1,130 +1,218 @@
 agentName: kafka
 agentType: integration
 title: 'Kafka monitoring integration'
-metaDescription: 'Install the Kafka integration'
+metaDescription: 'Here are several ways to install the Kafka integration'
+introFilePath: 'src/install/kafka/intro.mdx'
 redirects:
   - /docs/integrations/host-integrations/host-integrations-list/kafka-monitoring-integration
   - /docs/kafka-integration-new-relic-infrastructure
   - /docs/infrastructure/host-integrations/host-integrations-list/kafka-monitoring-integration
   - /docs/infrastructure/host-integrations/host-integrations-list/kafka/kafka-config
   - /docs/infrastructure/host-integrations/host-integrations-list/kafka/kafka-integration
-introFilePath: 'src/install/kafka/intro.mdx'
-appInfo: 
-  - optionType: dropdown1
+
+
+# -----------------------------------------------------------------
+# Create the buttons for asking about the environment
+# -----------------------------------------------------------------
+
+appInfo:
+  - optionType: deployment 
     label: ''
-    placeholder: 'Select your environment'
-    options: 
+    placeholder: "Choose the option that best matches how you'll install the integration."
+    options:
       - value: 'linux'
         displayName: 'Linux'
         logo: 'linux'
-        recommendedGuided: true
       - value: 'windows'
         displayName: 'Windows'
         logo: 'windows'
-        recommendedGuided: true
-  - optionType: deployment
-    label: "Choose your install path"
-    placeholder: "Choose one:"
+      - value: 'ecs'
+        displayName: 'ECS'
+        logo: 'amazonECS'
+      - value: 'kubernetes'
+        displayName: 'Kubernetes'
+        logo: 'k8'  
+
+  - optionType: linux
+    label: ''
+    placeholder: "How would you like to enable your Linux environment?"
     options:
-      - value: "msi"
-        displayName: "Install using MSI files (Windows)"
-        logo: 'windows'
-        recommendedGuided: true        
-      - value: "apt"
-        displayName: "Install using Apt (Debian, Ubuntu)"
-        recommendedGuided: true        
-      - value: "yum"
-        logo: 'linux'      
-        displayName: "Install using Yum (Amazon Linux, CentOS, RHEL)"
-        recommendedGuided: true        
-      - value: "zypper"
-        displayName: "Install using Zypper (SLES)"
-        recommendedGuided: true        
-        logo: 'linux'        
-      - value: "tar"
-        displayName: "Install from tarball (Other Linux distros)"  
-        recommendedGuided: true        
-        logo: 'linux'        
-  - optionType: autodiscovery
-    label: "Choose your autodiscovery option"      
-    placeholder: "Due to the distributed nature of Kafka, the number and list of brokers changes dynamically. For this reason, the Kafka integration offers two mechanisms to perform automatic discovery of the list of brokers in the cluster. The bootstrap option uses a defined bootstrap broker to obtain a list of brokers, while the Zookeeper option connects to a defined Zookeeper server in order to obtain the list of brokers. If you're unsure which option to choose, select Bootstrap."
-    options:  
-      - value: 'bootstrap'
-        displayName: 'Bootstrap'
-        recommendedGuided: true             
-      - value: 'zookeeper'
-        displayName: 'Zookeeper'
-        recommendedGuided: true             
+      - value: 'apt'
+        displayName: 'Install using Apt (Debian, Ubuntu)'
+      - value: 'yum'
+        displayName: 'Install using Yum (Amazon Linux, CentOS, RHEL)'
+      - value: 'zypper'
+        displayName: 'Install using Zypper (SLES)'     
+      - value: 'tar'
+        displayName: 'Install from Tarball (Other Linux distros)'        
 
 
+# -----------------------------------------------------------------
+# These are the steps that must be followed
+# -----------------------------------------------------------------
 steps:
+
+# This is the first step to select between Linux, Windows, ECS, and K8s
   - filePath: 'src/install/kafka/appInfo.mdx'
-  - filePath: 'src/install/kafka/default-requirements.mdx'
+
+# -----------------------------------------------------------------
+# If Linux is selected, this step loads.
+# The user has to choose an option to enable the Linux environment
+# -----------------------------------------------------------------
+
+  - filePath: 'src/install/kafka/linux-yes.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: deployment
+            options:
+              - value: 'linux'  
+
+# If ECS is selected, this step loads
+  - filePath: 'src/install/kafka/ecs/install-ecs.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: deployment
+            options:
+              - value: 'ecs'
+
+# If K8s is selected, this step loads
+  - filePath: 'src/install/kafka/kubernetes/install-k8s.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: deployment
+            options:
+              - value: 'kubernetes'
+
+# If Windows is selected, this step loads
+  - filePath: 'src/install/kafka/windows/install-msi.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: deployment
+            options:
+              - value: 'windows'
+
+# If Linux and APT is selected, this step loads
+  - filePath: 'src/install/kafka/linux/install-apt.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: linux
+            options:
+              - value: 'apt'
+
+# If Linux and Yum is selected, this step loads
+  - filePath: 'src/install/kafka/linux/install-yum.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: linux
+            options:
+              - value: 'yum'
+
+# If Linux and Zypper is selected, this step loads
+  - filePath: 'src/install/kafka/linux/install-zypper.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: linux
+            options:
+              - value: 'zypper'
+
+# If Linux and Tarball is selected, this step loads
+  - filePath: 'src/install/kafka/linux/install-tarball.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: linux
+            options:
+              - value: 'tar'
+
+# -----------------------------------------------------------------
+# This step loads always you select an option except for ECS because
+# the instructions for ECS include already the installation of the
+# infrastructure agent.
+# -----------------------------------------------------------------
+
   - filePath: 'src/install/kafka/install-infra.mdx'
-  - filePath: "src/install/kafka/linux/install-apt.mdx"
-    overrides: 
-        - filePath: "src/install/kafka/linux/install-apt.mdx"
-          selectedOptions: 
-            - optionType: deployment
-              options: 
-                - value: "apt"
-        - filePath: "src/install/kafka/linux/install-tarball.mdx"
-          selectedOptions: 
-            - optionType: deployment
-              options: 
-                - value: "tar"
-        - filePath: "src/install/kafka/linux/install-yum.mdx"
-          selectedOptions: 
-            - optionType: deployment
-              options: 
-                - value: "yum"
-        - filePath: "src/install/kafka/linux/install-zypper.mdx"
-          selectedOptions: 
-            - optionType: deployment
-              options: 
-                - value: "zypper"
-        - filePath: "src/install/kafka/windows/install-msi.mdx"
-          selectedOptions: 
-            - optionType: deployment
-              options: 
-                - value: "msi"                 
-  - filePath: 'src/install/kafka/default-install-linux.mdx'
-    overrides: 
-        - filePath: 'src/install/kafka/linux/install-linux-boot.mdx'    
-          isConditionalStep: true
-          selectedOptions: 
-            - optionType: dropdown1
-              options: 
-                - value: 'linux'    
-            - optionType: autodiscovery
-              options: 
-                - value: 'bootstrap' 
-        - filePath: 'src/install/kafka/linux/install-linux-zoo.mdx'        
-          isConditionalStep: true
-          selectedOptions: 
-            - optionType: dropdown1
-              options: 
-                - value: 'linux'    
-            - optionType: autodiscovery
-              options: 
-                - value: 'zookeeper'
-        - filePath: 'src/install/kafka/windows/install-windows-boot.mdx'        
-          isConditionalStep: true
-          selectedOptions: 
-            - optionType: dropdown1
-              options: 
-                - value: 'windows'    
-            - optionType: autodiscovery
-              options: 
-                - value: 'bootstrap'  
-        - filePath: 'src/install/kafka/windows/install-windows-zoo.mdx'        
-          isConditionalStep: true
-          selectedOptions: 
-            - optionType: dropdown1
-              options: 
-                - value: 'windows'    
-            - optionType: autodiscovery
-              options: 
-                - value: 'zookeeper'                            
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: deployment
+            options:
+              - value: 'kubernetes'
+      - isConditionalStep: true
+        selectedOptions:              
+          - optionType: linux
+            options:
+              - value: 'apt'
+              - value: 'yum'
+              - value: 'zypper'
+              - value: 'tar'
+      - isConditionalStep: true
+        selectedOptions:              
+          - optionType: deployment
+            options:
+              - value: 'windows'
+
+# -----------------------------------------------------------------
+# This step loads when one of these options: apt, yum, zypper, or tar
+# has been selected. These are the instructions to configure Kafka.
+# -----------------------------------------------------------------
+
+  - filePath: 'src/install/kafka/linux/install-linux.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: linux
+            options:
+              - value: 'apt'
+              - value: 'yum'
+              - value: 'zypper'
+              - value: 'tar'
+
+# -----------------------------------------------------------------
+# This step loads when Windows has been selected. 
+# These are the instructions to configure Kafka.
+# -----------------------------------------------------------------
+
+  - filePath: 'src/install/kafka/windows/configure-windows.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: deployment
+            options:
+              - value: 'windows'
+
+# -----------------------------------------------------------------
+# This is the step for the find an use data. It loads with all options
+# -----------------------------------------------------------------
+
   - filePath: 'src/install/kafka/find-data.mdx'
+    overrides:
+      - isConditionalStep: true
+        selectedOptions:
+          - optionType: deployment
+            options:
+              - value: 'kubernetes'
+              - value: 'ecs'
+              - value: 'windows'          
+      - isConditionalStep: true
+        selectedOptions:              
+          - optionType: linux
+            options:
+              - value: 'apt'
+              - value: 'yum'
+              - value: 'zypper'
+              - value: 'tar'
+
+# -----------------------------------------------------------------
+# This is not an step.
+# This file includes all the configuration options, metrics, and 
+# troubleshooting. It loads with all options
+# -----------------------------------------------------------------
+
 whatsNextFilePath: 'src/install/kafka/whatsNext.mdx'

src/install/kafka/appInfo.mdx

@@ -1,32 +1,7 @@
 ---
-componentType: appInfoConfig
-headingText: Choose your framework
+componentType: appInfoConfigOption
+optionType: deployment
+headingText: "Select your environment"
+descriptionText: ""
 ---
 
-<Callout variant="tip">
-  **Use guided install to quickly see your data in the UI**
-
-  Guided install is a single CLI command you can run on your system to monitor your Kafka instance. The CLI installs the infrastructure agent and Kafka integration.
-
-  This is a good way to trial ingesting data on our platform.
-
-  <ButtonGroup>
-    <ButtonLink
-      role="button"
-      to="https://one.newrelic.com/launcher/nr1-core.explorer?pane=eyJuZXJkbGV0SWQiOiJucjEtY29yZS5saXN0aW5nIn0=&cards[0]=eyJuZXJkbGV0SWQiOiJucjEtaW5zdGFsbC1uZXdyZWxpYy5ucjEtaW5zdGFsbC1uZXdyZWxpYyIsImFjdGl2ZUNvbXBvbmVudCI6IlZUU09FbnZpcm9ubWVudCIsInBhdGgiOiJndWlkZWQifQ=="
-      variant="primary"
-    >
-      Guided install
-    </ButtonLink>
-
-    <ButtonLink
-      role="button"
-      to="https://one.eu.newrelic.com/launcher/nr1-core.explorer?pane=eyJuZXJkbGV0SWQiOiJucjEtY29yZS5saXN0aW5nIn0=&cards[0]=eyJuZXJkbGV0SWQiOiJucjEtaW5zdGFsbC1uZXdyZWxpYy5ucjEtaW5zdGFsbC1uZXdyZWxpYyIsImFjdGl2ZUNvbXBvbmVudCI6IlZUU09FbnZpcm9ubWVudCIsInBhdGgiOiJndWlkZWQifQ=="
-      variant="primary"
-    >
-      EU guided install
-    </ButtonLink>
-  </ButtonGroup>
-
-  If you'd prefer to install manually, follow the steps below.
-</Callout>