Skip to content

Commit a2f8953

Browse files
devin-donnellydevin-donnelly
authored
Merge pull request kubernetes#1837 from Crassirostris/logging-docs-refactoring
Logging docs refactoring
2 parents a4d6cf3 + 69304ab commit a2f8953

26 files changed

+157
-257
lines changed

‎_data/guides.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,13 @@ toc:
141141
- title: Resource Usage Monitoring
142142
path: /docs/user-guide/monitoring/
143143
- title: Logging
144-
path: /docs/getting-started-guides/logging/
145-
- title: Logging with Elasticsearch and Kibana
146-
path: /docs/getting-started-guides/logging-elasticsearch/
144+
section:
145+
- title: Logging Overview
146+
path: /docs/user-guide/logging/overview/
147+
- title: Logging with Stackdriver Logging
148+
path: /docs/user-guide/logging/stackdriver/
149+
- title: Logging with Elasticsearch and Kibana
150+
path: /docs/user-guide/logging/elasticsearch/
147151
- title: Running Commands in a Container with kubectl exec
148152
path: /docs/user-guide/getting-into-containers/
149153
- title: Connect with Proxies

‎_data/support.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ toc:
2323
path: /docs/user-guide/debugging-pods-and-replication-controllers/
2424
- title: Application Introspection and Debugging
2525
path: /docs/user-guide/introspection-and-debugging/
26-
- title: Retrieving Logs
27-
path: /docs/user-guide/logging/
2826
- title: Troubleshooting Applications
2927
path: /docs/user-guide/application-troubleshooting/
3028
- title: Troubleshooting Clusters

‎docs/admin/cluster-components.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -91,15 +91,8 @@ about containers in a central database, and provides a UI for browsing that data
9191

9292
#### Cluster-level Logging
9393

94-
[Container Logging](/docs/user-guide/monitoring) saves container logs
95-
to a central log store with search/browsing interface. There are two
96-
implementations:
97-
98-
* [Cluster-level logging to Google Cloud Logging](
99-
/docs/user-guide/logging/#cluster-level-logging-to-google-cloud-logging)
100-
101-
* [Cluster-level Logging with Elasticsearch and Kibana](
102-
/docs/getting-started-guides/logging-elasticsearch/)
94+
A [Cluster-level logging](/docs/user-guide/logging/overview) mechanism is responsible for
95+
saving container logs to a central log store with search/browsing interface.
10396

10497
## Node components
10598

‎docs/admin/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ project](/docs/admin/salt).
6161
* **DNS Integration with SkyDNS** ([dns.md](/docs/admin/dns)):
6262
Resolving a DNS name directly to a Kubernetes service.
6363

64-
* **Logging** with [Kibana](/docs/user-guide/logging)
64+
* [**Cluster-level logging**](/docs/user-guide/logging/overview)
65+
Saving container logs to a central log store with search/browsing interface.
6566

6667
## Multi-tenant support
6768

‎docs/getting-started-guides/gce.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ wget -q -O - https://get.k8s.io | bash
4747

4848
Once this command completes, you will have a master VM and four worker VMs, running as a Kubernetes cluster.
4949

50-
By default, some containers will already be running on your cluster. Containers like `fluentd` provide [logging](/docs/getting-started-guides/logging), while `heapster` provides [monitoring](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/cluster-monitoring/README.md) services.
50+
By default, some containers will already be running on your cluster. Containers like `fluentd` provide [logging](/docs/user-guide/logging/overview), while `heapster` provides [monitoring](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/cluster-monitoring/README.md) services.
5151

5252
The script run by the commands above creates a cluster with the name/prefix "kubernetes". It defines one specific cluster config, so you can't run it more than once.
5353

‎docs/getting-started-guides/scratch.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -826,11 +826,9 @@ Notes for setting up each cluster service are given below:
826826
* [Setup instructions](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/dns/)
827827
* [Admin Guide](/docs/admin/dns/)
828828
* Cluster-level Logging
829-
* Multiple implementations with different storage backends and UIs.
830-
* [Elasticsearch Backend Setup Instructions](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/fluentd-elasticsearch/)
831-
* [Google Cloud Logging Backend Setup Instructions](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/fluentd-gcp/).
832-
* Both require running fluentd on each node.
833-
* [User Guide](/docs/user-guide/logging/)
829+
* [Cluster-level Logging Overview](/docs/user-guide/logging/overview)
830+
* [Cluster-level Logging with Elasticsearch](/docs/user-guide/logging/elasticsearch)
831+
* [Cluster-level Logging with Stackdriver Logging](/docs/user-guide/logging/stackdriver)
834832
* Container Resource Monitoring
835833
* [Setup instructions](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/cluster-monitoring/)
836834
* GUI

‎docs/user-guide/docker-cli-to-kubectl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ $ kubectl logs --previous nginx-app-zibvs
172172
10.240.63.110 - - [14/Jul/2015:01:09:02 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
173173
```
174174
175-
See [Logging](/docs/user-guide/logging) for more information.
175+
See [Logging Overview](/docs/user-guide/logging/overview) for more information.
176176
177177
#### docker stop and docker rm
178178

‎docs/user-guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The following topics in the Kubernetes User Guide can help you run applications
2222
1. [Managing deployments](/docs/user-guide/managing-deployments/)
2323
1. [Application introspection and debugging](/docs/user-guide/introspection-and-debugging/)
2424
1. [Using the Kubernetes web user interface](/docs/user-guide/ui/)
25-
1. [Logging](/docs/user-guide/logging/)
25+
1. [Logging](/docs/user-guide/logging/overview/)
2626
1. [Monitoring](/docs/user-guide/monitoring/)
2727
1. [Getting into containers via `exec`](/docs/user-guide/getting-into-containers/)
2828
1. [Connecting to containers via proxies](/docs/user-guide/connecting-to-applications-proxy/)

‎docs/user-guide/introspection-and-debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ status:
347347

348348
Learn about additional debugging tools, including:
349349

350-
* [Logging](/docs/user-guide/logging)
350+
* [Logging](/docs/user-guide/logging/overview)
351351
* [Monitoring](/docs/user-guide/monitoring)
352352
* [Getting into containers via `exec`](/docs/user-guide/getting-into-containers)
353353
* [Connecting to containers via proxies](/docs/user-guide/connecting-to-applications-proxy)

‎docs/user-guide/logging-demo/Makefile

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)