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

Add Platform documentation #185

Merged
merged 2 commits into from
Aug 19, 2020
Merged

Add Platform documentation #185

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb6add2
Add Platform documentation
dfreilich Aug 18, 2020
9ce9432
Merge branch 'main' into document-platform
jromero Aug 19, 2020
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
30 changes: 30 additions & 0 deletions content/docs/concepts/components/platform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
+++
title="Platform"
weight=3
+++

## What is a Platform?

A `platform` uses a [lifecycle][lifecycle], [buildpacks][buildpack] (packaged in a [builder][builder]), and application source code to produce an OCI image.

<!--more-->

## Examples
Examples of a platform might include:

* A local CLI tool that uses buildpacks to create OCI images. One such tool is the [Pack CLI][pack]
* A plugin for a continuous integration service that uses buildpacks to create OCI images. One such plugin is the [buildpacks][buildpacks-tekton] plugin in [Tekton][tekton]
* A cloud application platform that uses buildpacks to build source code before deployment. One such platform is [kpack][kpack]

## API
The platform [specification][spec] details what a platform does, and how it interacts with lifecycles and builders. The current API version for the platform is `0.4`.

[builder]: /docs/concepts/components/builder/
[buildpack]: /docs/concepts/components/buildpack/
[lifecycle]: /docs/concepts/components/lifecycle/
[spec]: https://github.com/buildpacks/spec/blob/main/platform.md
[pack]: https://github.com/buildpacks/pack
[buildpacks-tekton]: https://github.com/tektoncd/catalog/tree/master/task/buildpacks
[tekton]: https://tekton.dev/
[kpack]: https://github.com/pivotal/kpack
[api-version]: https://github.com/buildpacks/spec/blob/main/platform.md#platform-api-version