Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs on how to access Run logs 🗎 #935

Merged
merged 1 commit into from
May 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
1. [Set up a docker repository you can push to](https://github.com/knative/serving/blob/master/docs/setting-up-a-docker-registry.md)

Then you can [iterate](#iterating) (including
[runing the controllers with `ko`](#install-pipeline)).
[running the controllers with `ko`](#install-pipeline)).

### Ramp up

Expand Down Expand Up @@ -271,6 +271,9 @@ To look at the webhook logs, run:
kubectl -n tekton-pipelines logs $(kubectl -n tekton-pipelines get pods -l app=tekton-pipelines-webhook -o name)
```

To look at the logs for individual `TaskRuns` or `PipelineRuns`, see
[docs on accessing logs](docs/logs.md).

## Adding new types

If you need to add a new CRD type, you will need to add:
Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ High level details of this design:
- [How do I control auth?](auth.md)
- [How do I run a Pipeline?](pipelineruns.md)
- [How do I run a Task on its own?](taskruns.md)
- [How do I get logs?](logs.md)

## Learn more

Expand All @@ -49,6 +50,7 @@ components:
Additional reference topics not related to a specific component:

- [Labels](labels.md)
- [Logs](logs.md)

## Try it out

Expand Down
32 changes: 32 additions & 0 deletions docs/logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Logs

Logs for [`PipelineRuns`](pipelineruns.md) and [`TaskRuns`](taskruns.md) are
associated with the underlying pod.

_In [#107](https://github.com/tektoncd/pipeline/issues/107)
we will add a solution to persist logs outside of your kubernetes cluster._

To access these logs currently you have a few options:

* [You can get the logs from the pod](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#interacting-with-running-pods)
e.g. using `kubectl`:

```bash
# Get the name of the pod from the instance of the TaskRun
kubectl get taskruns -o yaml | grep podName

# Or get the pod name from the PipelineRun
kubectl get pipelineruns -o yaml | grep podName

# Use kubectl to access the logs for all containers in the pod
kubectl logs $POD_NAME --all-containers

# Or get the logs from a specific container in the pod
kubectl logs $POD_NAME -c $CONTAINER_NAME
kubectl logs $POD_NAME -c step-run-kubectl
```

* You can use [the `tkn` cli tool](https://github.com/tektoncd/cli) to access logs
* You can use [the dashboard web interface](https://github.com/tektoncd/dashboard) to access logs
* You can setup an external service to consume and display logs, for example
[Elasticsearch, Beats and Kibana](https://github.com/mgreau/tekton-pipelines-elastic-tutorials)
1 change: 1 addition & 0 deletions docs/pipelineruns.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Creation of a `PipelineRun` will trigger the creation of
- [Service account](#service-account)
- [Cancelling a PipelineRun](#cancelling-a-pipelinerun)
- [Examples](#examples)
- [Logs](logs.md)

## Syntax

Expand Down
1 change: 1 addition & 0 deletions docs/taskruns.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ A `TaskRun` runs until all `steps` have completed or until a failure occurs.
- [Service Account](#service-account)
- [Cancelling a TaskRun](#cancelling-a-taskrun)
- [Examples](#examples)
- [Logs](logs.md)

---

Expand Down
1 change: 1 addition & 0 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -583,6 +583,7 @@ Tekton Pipelines is known to work with:

- Logs can remain in-memory only as opposed to sent to a service such as
[Stackdriver](https://cloud.google.com/logging/).
- See [docs on getting logs from Runs](logs.md)

Elasticsearch, Beats and Kibana can be deployed locally as a means to view logs:
an example is provided at
Expand Down