Skip to content

Commit ad5e309

Browse files
authored
Merge pull request #29515 from sftim/20210823_tweak_dashboard_task
Revise task page to deploy and access the Kubernetes Dashboard
2 parents 0857620 + 8563416 commit ad5e309

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

content/en/docs/tasks/access-application-cluster/web-ui-dashboard.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ reviewers:
33
- bryk
44
- mikedanese
55
- rf232
6-
title: Web UI (Dashboard)
6+
title: Deploy and Access the Kubernetes Dashboard
7+
description: >-
8+
Deploy the web UI (Kubernetes Dashboard) and access it.
79
content_type: concept
810
weight: 10
911
card:
@@ -49,7 +51,9 @@ The sample user created in the tutorial will have administrative privileges and
4951
{{< /warning >}}
5052

5153
### Command line proxy
52-
You can access Dashboard using the kubectl command-line tool by running the following command:
54+
55+
You can enable access to the Dashboard using the `kubectl` command-line tool,
56+
by running the following command:
5357

5458
```
5559
kubectl proxy
@@ -60,7 +64,8 @@ Kubectl will make Dashboard available at [http://localhost:8001/api/v1/namespace
6064
The UI can _only_ be accessed from the machine where the command is executed. See `kubectl proxy --help` for more options.
6165

6266
{{< note >}}
63-
Kubeconfig Authentication method does NOT support external identity providers or x509 certificate-based authentication.
67+
The kubeconfig authentication method does **not** support external identity providers
68+
or X.509 certificate-based authentication.
6469
{{< /note >}}
6570

6671
## Welcome view
@@ -75,7 +80,7 @@ In addition, you can view which system applications are running by default in th
7580
## Deploying containerized applications
7681

7782
Dashboard lets you create and deploy a containerized application as a Deployment and optional Service with a simple wizard.
78-
You can either manually specify application details, or upload a YAML or JSON file containing application configuration.
83+
You can either manually specify application details, or upload a YAML or JSON _manifest_ file containing application configuration.
7984

8085
Click the **CREATE** button in the upper right corner of any page to begin.
8186

@@ -186,13 +191,14 @@ If needed, you can expand the **Advanced options** section where you can specify
186191
### Uploading a YAML or JSON file
187192

188193
Kubernetes supports declarative configuration.
189-
In this style, all configuration is stored in YAML or JSON configuration files
190-
using the Kubernetes [API](/docs/concepts/overview/kubernetes-api/) resource schemas.
194+
In this style, all configuration is stored in manifests (YAML or JSON configuration files).
195+
The manifests use Kubernetes [API](/docs/concepts/overview/kubernetes-api/) resource schemas.
191196

192197
As an alternative to specifying application details in the deploy wizard,
193-
you can define your application in YAML or JSON files, and upload the files using Dashboard.
198+
you can define your application in one or more manifests, and upload the files using Dashboard.
194199

195200
## Using Dashboard
201+
196202
Following sections describe views of the Kubernetes Dashboard UI; what they provide and how can they be used.
197203

198204
### Navigation
@@ -203,23 +209,24 @@ this can be changed using the namespace selector located in the navigation menu.
203209

204210
Dashboard shows most Kubernetes object kinds and groups them in a few menu categories.
205211

206-
#### Admin Overview
207-
For cluster and namespace administrators, Dashboard lists Nodes, Namespaces and Persistent Volumes and has detail views for them.
212+
#### Admin overview
213+
214+
For cluster and namespace administrators, Dashboard lists Nodes, Namespaces and PersistentVolumes and has detail views for them.
208215
Node list view contains CPU and memory usage metrics aggregated across all Nodes.
209216
The details view shows the metrics for a Node, its specification, status,
210217
allocated resources, events and pods running on the node.
211218

212219
#### Workloads
213220

214221
Shows all applications running in the selected namespace.
215-
The view lists applications by workload kind (e.g., Deployments, Replica Sets, Stateful Sets, etc.)
222+
The view lists applications by workload kind (for example: Deployments, ReplicaSets, StatefulSets).
216223
and each workload kind can be viewed separately.
217224
The lists summarize actionable information about the workloads,
218-
such as the number of ready pods for a Replica Set or current memory usage for a Pod.
225+
such as the number of ready pods for a ReplicaSet or current memory usage for a Pod.
219226

220227
Detail views for workloads show status and specification information and
221228
surface relationships between objects.
222-
For example, Pods that Replica Set is controlling or New Replica Sets and Horizontal Pod Autoscalers for Deployments.
229+
For example, Pods that ReplicaSet is controlling or new ReplicaSets and HorizontalPodAutoscalers for Deployments.
223230

224231
#### Services
225232

@@ -230,9 +237,9 @@ internal endpoints for cluster connections and external endpoints for external u
230237

231238
#### Storage
232239

233-
Storage view shows Persistent Volume Claim resources which are used by applications for storing data.
240+
Storage view shows PersistentVolumeClaim resources which are used by applications for storing data.
234241

235-
#### Config Maps and Secrets
242+
#### ConfigMaps and Secrets {#config-maps-and-secrets}
236243

237244
Shows all Kubernetes resources that are used for live configuration of applications running in clusters.
238245
The view allows for editing and managing config objects and displays secrets hidden by default.

0 commit comments

Comments
 (0)