Skip to content

Commit

Permalink
Merge pull request #185 from buildpacks/document-platform
Browse files Browse the repository at this point in the history
Add Platform documentation
  • Loading branch information
jromero authored Aug 19, 2020
2 parents 77eeef1 + 9ce9432 commit 489819d
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions content/docs/concepts/components/platform.md
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

0 comments on commit 489819d

Please sign in to comment.