LOC support and changes to support Splunk Show instances

Author: rcastley

content/en/other/hpa/1-deploy-otel.md

@@ -8,25 +8,23 @@ weight: 1
 
 We will be starting this workshop using the new Kubernetes Navigator so please check that you are already using the new Navigator.
 
-When you select **Infrastructure** from the main menu on the left, followed by selecting **Kubernetes**, you should see two services panes (**K8s nodes** and **K8s workloads**) for Kubernetes, similar like the ones below:
+When you select **Infrastructure** from the main menu on the left, followed by selecting **Kubernetes**, you should see two service panes (**K8s nodes** and **K8s workloads**) for Kubernetes, similar to the ones below:
 
 ![k8s-navi-v-2](../images/k8s-nav2-two.png)
 
 ## 2. Connect to EC2 instance
 
 You will be able to connect to the workshop instance by using SSH from your Mac, Linux or Windows device. Open the link to the sheet provided by your instructor. This sheet contains the IP addresses and the password for the workshop instances.
 
-To use SSH, open a terminal on your system and type `ssh [email protected]` (replacing x.x.x.x with the IP address assigned to you). The password for this workshop is also provided in the sheet.
-
-{{% notice title="Note" style="info" %}}
+{{% notice style="info" %}}
 Your workshop instance has been pre-configured with the correct **Access Token** and **Realm** for this workshop. There is no need for you to configure these.
 {{% /notice %}}
 
 ## 3. Namespaces in Kubernetes
 
 Most of our customers will make use of some kind of private or public cloud service to run Kubernetes. They often choose to have only a few large Kubernetes clusters as it is easier to manage centrally.
 
-Namespaces are a way to organize these large Kubernetes clusters into virtual sub-clusters. This can be helpful when different teams or projects share a Kubernetes cluster as this will give them the easy ability to just see and work with their own resources.
+Namespaces are a way to organize these large Kubernetes clusters into virtual sub-clusters. This can be helpful when different teams or projects share a Kubernetes cluster as this will give them the easy ability to just see and work with their resources.
 
 Any number of namespaces are supported within a cluster, each logically separated from others but with the ability to communicate with each other. Components are only **visible** when selecting a namespace or when adding the `--all-namespaces` flag to `kubectl` instead of allowing you to view just the components relevant to your project by selecting your namespace.
 
@@ -70,12 +68,16 @@ helm install splunk-otel-collector \
 --set="splunkObservability.realm=$REALM" \
 --set="splunkObservability.accessToken=$ACCESS_TOKEN" \
 --set="clusterName=$INSTANCE-k3s-cluster" \
---set="splunkObservability.logsEnabled=true" \
+--set="splunkObservability.logsEnabled=false" \
+--set="logsEngine=otel" \
 --set="splunkObservability.infrastructureMonitoringEventsEnabled=true" \
+--set="splunkPlatform.endpoint=$HEC_URL" \
+--set="splunkPlatform.token=$HEC_TOKEN" \
+--set="splunkPlatform.index=splunk4rookies-workshop" \
 splunk-otel-collector-chart/splunk-otel-collector \
 --namespace splunk \
 --create-namespace \
--f ~/workshop/k3s/splunk-defaults.yaml
+-f ~/workshop/k3s/otel-collector.yaml
 ```
 
 {{% /tab %}}
@@ -109,10 +111,10 @@ splunk-otel-collector-k8s-cluster-receiver-6c454894f8-mqs8n   1/1     Running
 <!--
 {{% notice title="Note" style="info" %}}
 
-If you are using the Kubernetes Integration setup from the Data Management page from the O11y UI , you find that the guide will use
+If you are using the Kubernetes Integration setup from the Data Management page from the O11y UI, you find that the guide will use
 `--generate-name splunk-otel-collector-chart/splunk-otel-collector` instead of just `splunk-otel-collector-chart/splunk-otel-collector` as we do in the above example.
 
-This will generate an unique name/label for the collector install and Pods by adding a unique number at the end of the object name, allowing you to install multiple collectors in your Kubernetes environment with different configurations.
+This will generate a unique name/label for the collector install and Pods by adding a unique number at the end of the object name, allowing you to install multiple collectors in your Kubernetes environment with different configurations.
 
 Just make sure you use the correct label that is generated by the Helm chart if you wish to use the `helm` and `kubectl` commands from this workshop on an install done with the `--generate-name` option.
 {{% /notice %}}

content/en/other/hpa/2-check-new-navigator-short.md

@@ -1,29 +1,27 @@
 ---
-title: Tour of the Kubernetes Navigator v2
-linkTitle: 2. Kubernetes Navigator v2
+title: Tour of the Kubernetes Navigator
+linkTitle: 2. Kubernetes Navigator
 weight: 2
 --- 
 
 ## 1. Cluster vs Workload View
 
 The Kubernetes Navigator offers you two separate use cases to view your Kubernetes data.
 
-* The **K8s workloads** is focusing on providing information in regards to workloads a.k.a. *your deployments*.
-* The **K8s nodes** is focusing on providing insight into the performance of clusters, nodes, pods and containers.
+* The **K8s workloads** are focusing on providing information in regards to workloads a.k.a. *your deployments*.
+* The **K8s nodes** are focusing on providing insight into the performance of clusters, nodes, pods and containers.
 
-You will initially select either view depending on your need (you can switch between the view on the fly if required). The most common one we will use in this workshop is the  workload view and we will focus on that specifically.
+You will initially select either view depending on your need (you can switch between the view on the fly if required). The most common one we will use in this workshop is the workload view and we will focus on that specifically.
 
-### 1.1 Finding your K8s Cluster name
+### 1.1 Finding your K8s Cluster Name
 
-Your first task is to identify and find your own cluster. The cluster will be named after your EC2 instance name.
-
-To confirm your EC2 instance name, look at the prompt of your EC2 instance. For example, if you are assigned the 7th EC2 instance, the prompt will show:
+Your first task is to identify and find your cluster. The cluster will be named as determined by the preconfigured environment variable `INSTANCE`. To confirm the cluster name enter the following command in your terminal:
 
 ``` bash
-ubuntu@emea-ws-7 ~ $
+echo $INSTANCE-k3s-cluster
 ```
 
-This means your cluster will be named: `emea-ws-7-k3s-cluster`. Please make a note of your cluster name as you will need this later in the workshop for filtering.
+Please make a note of your cluster name as you will need this later in the workshop for filtering.
 
 ## 2. Workloads & Workload Details Pane
 
@@ -39,12 +37,12 @@ Initially, you will see all the workloads for all clusters that are reported int
 
 ![Workloads](../images/k8s-workload-screen.png)
 
-Now, let's find your own cluster by filtering on the field `k8s.cluster.name` in the filter toolbar (as marked with a blue stripe).
+Now, let's find your cluster by filtering on the field `k8s.cluster.name` in the filter toolbar (as marked with a blue stripe).
 
 {{% notice title="Note" style="info" %}}
-You can enter a partial name into the search box, such as 'emea-ws-7*', to quickly find your Cluster.
+You can enter a partial name into the search box, such as `emea-ws-7*`, to quickly find your Cluster.
 
-Also, it's a very good idea to switch the default time from the default **-3h** back to last 15 minutes (**-15m**).
+Also, it's a very good idea to switch the default time from the default **-3h** back to the last 15 minutes (**-15m**).
 {{% /notice %}}
 
 ![Workloads](../images/k8s-workload-filter.png)
@@ -55,15 +53,15 @@ You should now just see information for your own cluster.
 How many workloads are running & how many namespaces are in your Cluster?
 {{% /notice %}}
 
-### 2.1 Using the Navigator Selection chart
+### 2.1 Using the Navigator Selection Chart
 
-The **K8s workloads** table is a common feature used across most of the Navigator's and will offer you a list view of the data you are viewing. In our case, it shows a list of `Pods Failed` grouped by `k8s.namespace.name`.
+The **K8s workloads** table is a common feature used across most of the Navigators and will offer you a list view of the data you are viewing. In our case, it shows a list of `Pods Failed` grouped by `k8s.namespace.name`.
 
 ![k8s-workload-list](../images/workload-selection.png)
 
-Now let's change the list view to a heat map view by selecting either the Heat map icon or List icon in the upper-right corner of the screen (as marked with the purple line).
+Now let's change the list view to a heat map view by selecting either the Heat map icon or the List icon in the upper-right corner of the screen (as marked with the purple line).
 
-Changing this option will result in the following visualisation:
+Changing this option will result in the following visualization:
 
 ![k8s-Heat-map](../images/heatmap.png)
 
@@ -72,17 +70,17 @@ In this view, you will note that each workload is now a colored square. These sq
 
 Another valuable option in this screen is **Find Outliers** which provides historical analytics of your clusters based on what is selected in the **Color by** dropdown.
 
-Now, let's select the **File system usage (bytes)** from the **Color by** drop down box, then click on the **Find outliers** drop down *as marked by a yellow line* in the above image and make sure you change the **Scope** in the dialog to **Per k8s.namespace.name** and **Deviation from Median** as below:
+Now, let's select the **File system usage (bytes)** from the **Color by** drop-down box, then click on the **Find outliers** drop-down *as marked by a yellow line* in the above image and make sure you change the **Scope** in the dialog to **Per k8s.namespace.name** and **Deviation from Median** as below:
 
 ![k8s-Heat-map](../images/set-find-outliers.png)
 
-The **Find outliers** view is very useful when you need to view a selection of your workloads (or any service depending on the Navigator used) and quickly need to figure out if something has changed.
+The **Find Outliers** view is very useful when you need to view a selection of your workloads (or any service depending on the Navigator used) and quickly need to figure out if something has changed.
 
 It will give you fast insight into items (workloads in our case) that are performing differently (both increased or decreased) which helps to make it easier to spot problems.
 
-### 2.2 The Deployment overview pane
+### 2.2 The Deployment Overview pane
 
-The Deployment overview pane gives you a quick insight of the status of your deployments. You can see at once if the pods of your deployments are Pending, Running, Succeeded, Failed or in an Unknown state.  
+The Deployment Overview pane gives you a quick insight into the status of your deployments. You can see at once if the pods of your deployments are Pending, Running, Succeeded, Failed or in an Unknown state.  
 
 ![k8s-workload-overview](../images/k8s-deployment-overview.png)
 
@@ -102,15 +100,15 @@ To filter to a specific workload, you can click on three dots **...** next to th
 
 This will add the selected workload to your filters. Try this for the **splunk-otel-collector-k8s-cluster-receiver** workload. It will then list a single workload in the **splunk** namespace.
 
-The Heat map above will also filter down to a single coloured square. Click on the square to see more information about the workload.
+The Heat map above will also filter down to a single-colored square. Click on the square to see more information about the workload.
 
 ![workload-add-filter](../images/k8s-workload-detail.png)
 
 {{% notice title="Workshop Question" style="tip" icon="question" %}}
 What are the CPU request  & CPU limit units for the otel-collector?
 {{% /notice %}}
 
-At this point you can drill into the information of the pods, but that is outside the scope of this workshop, for now reset your view by removing the filter for the **splunk-otel-collector-k8s-cluster-receiver** workload and setting the **Color by** option to **Pods Running**.
+At this point, you can drill into the information of the pods, but that is outside the scope of this workshop, for now reset your view by removing the filter for the **splunk-otel-collector-k8s-cluster-receiver** workload and setting the **Color by** option to **Pods Running**.
 
 ![workload-add-filter](../images/k8s-workload-remove-filter.png)
 
@@ -127,6 +125,6 @@ extraDimensions:
 
 The Navigator Sidebar will expand and a link to the discovered service will be added as seen in the image below:
 
-![pivotbar](../images/pivotbar.png)
+![Pivotbar](../images/pivotbar.png)
 
-This will allow for easy switching between Navigators. The same applies for your Apache server instance, it will have a Navigator Sidebar allowing you to quickly jump back to the Kubernetes Navigator.
+This will allow for easy switching between Navigators. The same applies to your Apache server instance, it will have a Navigator Sidebar allowing you to quickly jump back to the Kubernetes Navigator.

content/en/other/hpa/3-deploy-apache.md

@@ -28,7 +28,7 @@ Any Pods exposed by a Service have the following DNS resolution available:
 my_pod.service-name.my-namespace.svc.cluster-domain.example
 ```
 
-More information can be found here : [DNS for Service and Pods](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/)
+More information can be found here: [**DNS for Service and Pods**](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/)
 
 ## 2. Review OTel receiver for PHP/Apache
 
@@ -61,7 +61,7 @@ The above file contains an observation rule for Apache using the OTel `receiver_
 
 The configured rules will be evaluated for each endpoint discovered. If the rule evaluates to true, then the receiver for that rule will be started as configured against the matched endpoint.
 
-In the file above we tell the OpenTelemetry agent to look for Pods that match the name `apache` and have port `80` open. Once found, the agent will configure an Apache receiver to read Apache metrics from the configured URL. Note, the K8s DNS based URL in the above YAML for the service.
+In the file above we tell the OpenTelemetry agent to look for Pods that match the name `apache` and have port `80` open. Once found, the agent will configure an Apache receiver to read Apache metrics from the configured URL. Note, the K8s DNS-based URL in the above YAML for the service.
 
 To use the Apache configuration, you can upgrade the existing Splunk OpenTelemetry Collector Helm chart to use the `otel-apache.yaml` file with the following command:
 
@@ -73,11 +73,15 @@ helm upgrade splunk-otel-collector \
 --set="splunkObservability.realm=$REALM" \
 --set="splunkObservability.accessToken=$ACCESS_TOKEN" \
 --set="clusterName=$INSTANCE-k3s-cluster" \
---set="splunkObservability.logsEnabled=true" \
+--set="splunkObservability.logsEnabled=false" \
+--set="logsEngine=otel" \
 --set="splunkObservability.infrastructureMonitoringEventsEnabled=true" \
+--set="splunkPlatform.endpoint=$HEC_URL" \
+--set="splunkPlatform.token=$HEC_TOKEN" \
+--set="splunkPlatform.index=splunk4rookies-workshop" \
 splunk-otel-collector-chart/splunk-otel-collector \
 --namespace splunk \
--f ~/workshop/k3s/splunk-defaults.yaml \
+-f ~/workshop/k3s/otel-collector.yaml \
 -f ~/workshop/k3s/otel-apache.yaml
 ```
 
@@ -101,7 +105,7 @@ TEST SUITE: None
 
 ## 4. Kubernetes ConfigMaps
 
-A ConfigMap is an object in Kubernetes consisting of key-value pairs which can be injected into your application. With a ConfigMap, you can separate configuration from your Pods.
+A ConfigMap is an object in Kubernetes consisting of key-value pairs that can be injected into your application. With a ConfigMap, you can separate configuration from your Pods.
 
 Using ConfigMap, you can prevent hardcoding configuration data. ConfigMaps are useful for storing and sharing non-sensitive, unencrypted configuration information.
 
@@ -115,7 +119,7 @@ kubectl get cm -n splunk
 How many ConfigMaps are used by the collector?
 {{% /notice %}}
 
-When you have list of ConfigMaps from the namespace, select the one for the `otel-agent` and view it with the following command:
+When you have a list of ConfigMaps from the namespace, select the one for the `otel-agent` and view it with the following command:
 
 ``` bash
 kubectl get cm splunk-otel-collector-otel-agent -n splunk -o yaml
@@ -139,7 +143,7 @@ cat ~/workshop/k3s/php-apache.yaml
 
  This file contains the configuration for the PHP/Apache deployment and will create a new StatefulSet with a single replica of the PHP/Apache image.
 
-A stateless application is one that does not care which network it is using, and it does not need permanent storage. Examples of stateless apps may include web servers such as Apache, Nginx, or Tomcat.
+A stateless application does not care which network it is using, and it does not need permanent storage. Examples of stateless apps may include web servers such as Apache, Nginx, or Tomcat.
 
 ```yaml
 apiVersion: apps/v1
@@ -188,7 +192,7 @@ spec:
 
 ## 6. Deploy PHP/Apache
 
-Create an apache namespace then deploy the PHP/Apache application to the cluster.
+Create an `apache` namespace then deploy the PHP/Apache application to the cluster.
 
 Create the `apache` namespace:
 

content/en/other/hpa/4-fix-apache.md

@@ -7,7 +7,7 @@ weight: 4
 
 Especially in Production Kubernetes Clusters, CPU and Memory are considered precious resources.  Cluster Operators will normally require you to specify the amount of CPU and Memory your Pod or Service will require in the deployment, so they can have the Cluster automatically manage on which Node(s) your solution will be placed.
 
-You do this by placing a Resource section in the deployment of you application/Pod
+You do this by placing a Resource section in the deployment of your application/Pod
 
 **Example:**
 
@@ -21,13 +21,13 @@ resources:
     memory: "4Mi" # Requesting 4Mb of memory
 ```
 
-More information can be found here : [Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)
+More information can be found here: [**Resource Management for Pods and Containers**](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)
 
 If your application or Pod will go over the limits set in your deployment, Kubernetes will kill and restart your Pod to protect the other applications on the Cluster.
 
 Another scenario that you will run into is when there is not enough Memory or CPU on a Node. In that case, the Cluster will try to reschedule your Pod(s) on a different Node with more space.
 
-If that fails, or if there is not enough space when you deploy your application, the Cluster will put your workload/deployment in schedule mode until there is enough room on any of the available Nodes to deploy the Pods according their limits.
+If that fails, or if there is not enough space when you deploy your application, the Cluster will put your workload/deployment in schedule mode until there is enough room on any of the available Nodes to deploy the Pods according to their limits.
 
 ## 2. Fix PHP/Apache Deployment
 
@@ -55,7 +55,7 @@ resources:
     memory: "4Mi"
 ```
 
-Save the changes youhave made. (Hint: Use `Esc` followed by `:wq!` to save your changes).
+Save the changes you have made. (Hint: Use `Esc` followed by `:wq!` to save your changes).
 
 Now, we must delete the existing StatefulSet and re-create it. StatefulSets are immutable, so we must delete the existing one and re-create it with the new changes.
 
@@ -91,7 +91,7 @@ Monitor the Apache web servers Navigator dashboard for a few minutes.
 What is happening with the # Hosts reporting chart?
 {{% /notice %}}
 
-## 4. Fix memory issue
+## 4. Fix the memory issue
 
 If you navigate back to the Apache dashboard, you will notice that metrics are no longer coming in. We have another resource issue and this time we are Out of Memory. Let's edit the stateful set and increase the memory to what is shown in the image below: