Skip to content

Commit 818112d

Browse files
committed
Denglish fixes
1 parent 1dae56f commit 818112d

File tree

2 files changed

+31
-43
lines changed

2 files changed

+31
-43
lines changed

content/en/tko/session-5/docs/check-new-navigator.md

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,21 @@ title: The new Kubernetes Navigator
33
linkTitle: Touring the Kubernetes Navigator v2
44
weight: 22
55
---
6-
## 1 The k8s cluster & cluster detail Pane
6+
## 1. The k8s cluster & cluster detail Pane
77

88
Go to the **Infrastructure** page in the Observability UI and select **Kubernetes**, this will offer you a number of kubernetes services. For this exercise pick the `K8s cluster` pane.
99

1010
![k8s-cluster-pane](../images/k8sclusters.png)
1111

1212
The first thing you notice is that the pane indicates how many clusters are being monitored for you. The pane also shows a tiny graph of the load being handled across those clusters for a birds eye view. Lastly, if there is a alert for one of the clusters it will be highlighted here too.
1313

14-
Click or select on the pane and you will be taken to the `Infrastructure/Kubernetes/ K8s clusters` overview pane. Here you will find a list off all the Kubernetes clusters that are sending data to the Splunk Observability Cloud platform.
14+
Click or select on the pane and you will be taken to the `Infrastructure/Kubernetes/ K8s clusters` overview pane. Here you will find a list off all the Kubernetes clusters that are sending data to the Splunk Observability Cloud platform.
1515

1616
### 1.1 Finding your K8s cluster name
1717

18-
Your first task is to identify and find your own cluster.
18+
Your first task is to identify and find your own cluster. The cluster will be named after your EC2 instance name: `ws-5-X-k3s-cluster` where `X` is the number of the EC2 instance assigned to you.
1919

20-
The cluster will be named after your EC2 instance name: `ws-5-X-k3s-cluster` where `X` is the number of the EC2 instance assigned to you.
21-
22-
To find your node name look at the prompt of your EC2 instance, assuming you are assigned the 7th ec2 instance the prompt will show
20+
To find your node name look at the prompt of your EC2 instance, assuming you are assigned the 7th EC2 instance the prompt will show
2321

2422
``` bash
2523
ubuntu@ws-5-7 ~ $
@@ -28,79 +26,75 @@ ubuntu@ws-5-7 ~ $
2826
This means your cluster is named: `ws-5-7-k3s-cluster` make a note as you will need this later in the workshop as a filter.
2927

3028
{{% alert title="Workshop Question" color="success" %}}
31-
Find your Cluster in the Observability Kubernetes Navigator, and identify the amoutn of containers that are running at this point.
29+
Find your Cluster in the Observability Kubernetes Navigator, and identify the amount of containers that are running at this point.
3230

3331
**Tip:** You may need to switch the Color By option to containers and refresh the screen a few times until the cluster data is correlated in the background. Also, it is recommended to set the timeframe to be `15m` (down from `3h` which is default).
3432
{{% /alert %}}
3533

3634
### 1.2 Using the K8s cluster Selection Pane
3735

38-
The k8s cluster Selection Pane by default, will offer a list view of your clusters like shown below.
36+
The K8s cluster Selection Pane by default, will offer a list view of your clusters like shown below.
3937

4038
![k8s-cluster-list](../images/k8sclusterselection.png)
4139

42-
You can scroll down the k8s cluster list or by using the filter on the top toolbar, *(marked with a blue stripe)*, with the field `k8s.cluster.name`, to find your Cluster. </br>
43-
You can enter a partial name into the search box such as 'ws-5-7', to find quickly find your Cluster.
40+
You can scroll down the K8s cluster list or by using the filter on the top toolbar, *(marked with a blue stripe)*, with the field `k8s.cluster.name`, to find your Cluster.
4441

45-
Also its is a good idea to switch the default time from the default 3 hours back to 15 minutes.
42+
You can enter a partial name into the search box such as 'ws-5-7', to find quickly find your Cluster. Also, its is a good idea to switch the default time from the default 3 hours back to 15 minutes.
4643

4744
If there are many clusters, you can change the Result per page box *Marked by an orange line*, to increase the list size.
4845

49-
You will note that each cluster row has a colored mark at the end of each row. These will change according the `color by` option, *Marked by a green line*, you have selected as to indicate its range.
46+
You will note that each cluster row has a colored mark at the end of each row. These will change according the `color by` option, *Marked by a green line*, you have selected as to indicate its range.
47+
48+
These are the possible options at this time:
5049

51-
These are the possible options at this time:</br>
5250
![k8s-colorby-list](../images/Infk8sColorBy.png)
5351

5452
Next, you can change the the list view to a heat map view by selecting either the Heatmap or List icon ![heatmap-toggle](../images/heatmaptoggle.png) *(Marked by a purple line).*
5553

56-
This will result in the follow representation:</br>
54+
This will result in the follow representation:
55+
5756
![k8s-heatmap](../images/heatmapview.png)
5857

5958
This might be a useful view if you have many cluster as they can be grouped together using the group by option *Marked by the green line* . The colors of each node will follow the color by choice similar to the list view.
6059

6160
The last option, is the Find Outliers based on historical analytics of your clusters based on what is selected in the `colored by` box.
6261

6362
This view is better used when you view all or a selection of you cluster. It will give you a quick insight which of your clusters are behaving differently than they do normally and may need further investigation.
64-
You may not see relevant info, The clusters in this workshop are short lived and have not send enough meaningful data for the historical analytics to detect deviations.
63+
64+
You may not see relevant info, the clusters in this workshop are short lived and have not send enough meaningful data for the historical analytics to detect deviations.
6565

6666
### 1.3 The K8s cluster detail Pane
6767

6868
Initially,the cluster detail pane will show you the overall performance across all the servers as show below.
69+
6970
![k8s-allclusters](../images/k8s-allclusters.png)
7071

7172
As soon as you select your own cluster, you can see the overall performance of your luster, in this view you also can see if your cluster is affected by an alert:
7273

7374
![k8s-cluster-alert](../images/single-cluster-alert.png)
7475

75-
You may note that a `single alert` has fired for this example Cluster
76+
You may note that a `single alert` has fired for this example Cluster.
7677

77-
## 3. The Nodes & Node Details Pane
78+
## 2. The Nodes & Node Details Pane
7879

79-
Go to the **Infrastructure** page in the Observability UI and select **Kubernetes**, this again will offer you a number of kubernetes services. For this exercise pick the `K8s Nodes` pane.
80+
Go to the **Infrastructure** page in the Observability UI and select **Kubernetes**, this again will offer you a number of kubernetes services. For this exercise pick the `K8s Nodes` pane. When selected it may show a cluster that you have selected previously.
8081

8182
![k8sNode](../images/k8sNodes.png)
8283

83-
When Selected it may show a cluster that you have select4d previously,
84-
85-
-------
86-
8784
In a production environment you would expect to see multiple Nodes within a Cluster which would now all be visible and shown as individual pale blue squares, each containing green squares which represent pods, however in our workshop environment you each have a single node within your Cluster, represented by the large single blue square.
8885

8986
Drill down into the single Node by hovering over the pale blue background, then clicking on either the magnifying glass that appears in the top left corner, or double clicking on the pale blue background, this will take you to the Node level view.
9087

91-
9288
You should now be able to see all the Pods and Containers running on your single Node Cluster...
9389

9490
![cluster-detail](../images/cluster-detail.png)
9591

96-
but more importantly, the 'side panel' should have also switched to the Info Tab and is now showing lots of contextual information about the Node.
92+
But, more importantly, the *side panel* should have also switched to the Info Tab and is now showing lots of contextual information about the Node.
9793

9894
![side-panel-node.png](../images/side-panel-node.png)
9995

10096
There are various Panes showing details on the Properties of the Node, and all the various Workloads running on it, even though we are still on the 'Map' tab within Kubernetes Navigator.
10197

102-
---
103-
10498
At the top of the side panel, click on the Expand icon ![expand-sidebar.png](../images/expand-sidebar.png) which takes you to the full screen tab of the currently displayed resource, which in this case is a Node, so we end up on the Node Details Tab.
10599

106100
Node Details shows you lots of great detail about what is happening on this Node, with charts for total CPU Usage, Mem Usage, Network traffic etc for all the Pods running on the Node with a list of any Events just to the right of these Charts.
@@ -111,7 +105,7 @@ You also have scrollable table views of both the Workloads and Containers runnin
111105
How much memory and how many CPU cores does our one node have?
112106
{{% /alert %}}
113107

114-
## 4. Workloads & Workload Details Tabs
108+
## 3. Workloads & Workload Details Tabs
115109

116110
Assuming you have been able to answer the question about the Node CPU cores, you will now need to switch to the Workloads tab on the top toolbar. The Workloads tab details all the workloads that are deployed within your cluster.
117111

@@ -127,7 +121,7 @@ To get more detail on a specific Workload, simply click on its name in the Workl
127121

128122
---
129123

130-
### Workload Detail tab
124+
### 3.1 Workload Detail tab
131125

132126
Here you will get the general info about your Workload, the CPU and Memory the Containers are consuming, the Pods and their Phase, details of any Events, and finally a list of Pods related to this Workload.
133127

@@ -137,14 +131,12 @@ As with the other Kubernetes Navigator views clicking on the name of a Pod withi
137131
How many containers does the `splunk-otel-collector-agent` Pod contain?
138132
{{% /alert %}}
139133

140-
## 5. Pod Detail & Container Details Tabs
141-
142-
The last two Tabs that make up the Kubernetes Navigator are Pod Detail and Container Detail.
134+
## 4. Pod Detail & Container Details Tabs
143135

144-
The Pod Detail view will show you the Pod Properties, CPU, Memory and Network usage along with any events relevant to the Pod.
136+
The last two Tabs that make up the Kubernetes Navigator are Pod Detail and Container Detail. The Pod Detail view will show you the Pod Properties, CPU, Memory and Network usage along with any events relevant to the Pod.
145137

146138
Clicking through to the Container Detail Tab, you should know how to do this by now, but just to play safe, select one of the Containers in the list then click the expand button ![expand-sidebar.png](../images/expand-sidebar.png) to navigate to the Container Detail Tab.
147139

148140
If you navigated straight to the Container Detail Tab by simply clicking on the Tab, try using the Container ID drop down to select a container, now you will see the benefit of 'clicking through' to get to the desired Container!
149141

150-
You can now see the details for the Selected Container, with the Container Properties pane offering lots of detail on its configuration
142+
You can now see the details for the Selected Container, with the Container Properties pane offering lots of detail on its configuration.

content/en/tko/session-5/docs/deploy-otel-navi2.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Deploying the OpenTelemetry Collector in Kubernetes using a NameSpace
33
linkTitle: Prep UI & Deploy the OTel Collector
44
weight: 21
55
---
6-
## 0. Switching to the new Kubernetes Navigator 2.0 UI
6+
## 1. Switching to the new Kubernetes Navigator 2.0 UI
77

88
As we are in the process of switched to the new generation of the Kubernetes Navigator please check if you are already on the new Kubernetes navigator.
99

@@ -13,9 +13,7 @@ When you select `Kubernetes` as you focus, you should see a number of services p
1313

1414
If you taken straight to the Kubernetes Navigator v1 after selecting `Kubernetes` in the right hand menu, you need to set the feature flag for the new Navigator yourself.
1515

16-
To do this, please change the Url in your browser to match the following:
17-
18-
https://app.[REALM].signalfx.com/#/Superpowers
16+
To do this, please change the Url in your browser to match the following: [https://app.[REALM].signalfx.com/#/superpowers](https://app.[REALM].signalfx.com/#/superpowers)
1917

2018
Were [REALM] needs to match the Realm we are running this workshop in.
2119

@@ -37,7 +35,7 @@ You can fix this by pressing the ![new-k8-button](../images/new-k8s-button.png)
3735
You may need to do this once per service type (Cluster/Nodes/Workloads).
3836
{{% /alert %}}
3937

40-
## 1. Connect to EC2 instance
38+
## 2. Connect to EC2 instance
4139

4240
You will be able to connect to the workshop instance by using SSH from your Mac, Linux or Windows device.
4341

@@ -47,7 +45,7 @@ To use SSH, open a terminal on your system and type `ssh [email protected]` (replac
4745
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.
4846
{{% /alert %}}
4947

50-
## 2. Namespaces in Kubernetes
48+
## 3. Namespaces in Kubernetes
5149

5250
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.
5351

@@ -57,7 +55,7 @@ Any number of namespaces are supported within a cluster, each logically separate
5755

5856
Most customers will want to install the Splunk OpenTelemetry Collector in a separate namespace. This workshop will follow that practice.
5957

60-
## 3. Install Splunk OTel using Helm
58+
## 4. Install Splunk OTel using Helm
6159

6260
Install the OpenTelemetry Collector using the Splunk Helm chart. First, add the Splunk Helm chart repository and update.
6361

@@ -99,7 +97,7 @@ helm install splunk-otel-collector --set="splunkObservability.realm=$REALM" --se
9997
{{< /tab >}}
10098
{{< /tabpane >}}
10199

102-
## 4. Verify Deployment
100+
## 5. Verify Deployment
103101

104102
You can monitor the progress of the deployment by running `kubectl get pods` and adding `-n splunk` to the command to see the pods in the `splunk` NameSpace which should typically report that the new pods are up and running after about 30 seconds.
105103

@@ -142,5 +140,3 @@ helm delete splunk-otel-collector -n splunk
142140
```
143141

144142
{{% /alert %}}
145-
146-

0 commit comments

Comments
 (0)