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.

Sign up for GitHub

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

Make it clear what kritis is #25

Merged
merged 2 commits into from
Sep 10, 2018
Merged

Make it clear what kritis is #25

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9d1b85
Make it clear what `kritis` is
bobcatfish Sep 10, 2018
f390c6e
Make it more clear what the kritis pipeline example failure means
bobcatfish Sep 10, 2018
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
40 changes: 25 additions & 15 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples

This directory contains examples of [the Pipeline strawman CRDs](../README.md) in action.
This directory contains examples of [the Pipeline CRDs](../README.md) in action.

To deploy them to your cluster (after
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have never tested this.
Have you?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep! hopefully soon we'll have CI that verifies they'll keep working (#15 + #16) but in the meantime I've run this manually and gotten them working (or at least they worked last week 🤞 )

[installing the CRDs and running the controller](../DEVELOPMENT.md#installing-andrunning)):
Expand All @@ -11,6 +11,29 @@ kubectl apply -f examples/
kubectl apply -f examples/invocations
```

## Example Pipelines

We have 2 example [Pipelines](../README.md#pipeline) in [./pipelines](./pipelines)

1. [The Kritis Pipline](./pipelines/kritis.yaml): This example builds a Pipeline for the
[kritis project](https://github.com/grafeas/kritis), and demonstrates how to configure
a pipeline which:

1. Runs unit tests
2. Build an image
3. Deploys it to a test environment
4. Runs integration tests

![Pipeline Configuration](./pipelines/kritis-pipeline.png)

2. [Guestbook](./pipelines/guestbook.yaml): This Pipeline is based on example application in
[the Kubernetes example Repo](https://github.com/kubernetes/examples/tree/master/guestbook)
This pipeline demonstartes how to integrate frontend
[guestbook app code](https://github.com/kubernetes/examples/tree/master/guestbook-go) with
backend [redis-docker image](https://github.com/GoogleCloudPlatform/redis-docker/tree/master/4) provided by GCP.

![Pipeline Configuration](./pipelines/guestbook-pipeline.png)

## Example Tasks

* Example [Tasks](../../README.md#task) are in:
Expand All @@ -33,17 +56,4 @@ The [runs](./runs/) dir contains an example [TaskRun](../README.md#taskrun) and

[run-kritis-test.yaml](./invocations/run-kritis-test.yaml) shows an example of how to manually run kritis unit test off your development branch.

[kritis-pipeline-run.yaml](./invocations/kritis-pipeline-run.yaml) shows an example of what it would look like to invoke the [kritis example pipeline](#example-pipelines) manually and have it fail on the second task (building and pushing the image).

## Example Pipelines

Finally, we have 2 example [Pipelines](../README.md#pipeline) in [./pipelines](./pipelines)

1. [Kritis](./pipelines/kritis.yaml): This exmaple demonstrates how to configure a pipeline which runs unit test, build an image, deploys it to test and then run integration tests. (This is the pipeline for [kritis](https://github.com/grafeas/kritis).)

![Pipeline Configuration](./pipelines/kritis-pipeline.png)

2. [Guestbook](./pipelines/guestbook.yaml): This is pipeline which is based on example application in [Kubernetes example Repo](https://github.com/kubernetes/examples/tree/master/guestbook)
This pipeline demonstartes how to integrate frontend [guestbook app code](https://github.com/kubernetes/examples/tree/master/guestbook-go) with backed [redis-docker image](https://github.com/GoogleCloudPlatform/redis-docker/tree/master/4) provided by GCP.

![Pipeline Configuration](./pipelines/guestbook-pipeline.png)
[kritis-pipeline-run.yaml](./invocations/kritis-pipeline-run.yaml) shows an example of what it would look like to invoke the [kritis example pipeline](#example-pipelines) manually and have it fail on the second task (building and pushing the image).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a little bit confusing to me.
I am reading it as "User has configured this pipeline to fail at step 2"
Instead, the pipeline run controller determined the task failed and updated the status right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point! I've tried to make this more clear, PTAL