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

Breakup platform api #667

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Breakup platform api #667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d27d00
Break up Platform API section into separate "how to" pages
natalieparellano Mar 6, 2024
56db7e6
Merge branch 'main' into breakup-platform-api
AidanDelaney May 20, 2024
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: 5 additions & 0 deletions content/docs/for-platform-operators/how-to/design-platform/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
+++
title="Design your own platform"
weight=3
include_summaries=true
+++
16 changes: 16 additions & 0 deletions content/docs/for-platform-operators/how-to/design-platform/prepare-filesystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
+++
title="Prepare the filesystem"
weight=99
+++

This page is a stub! The CNB project is applying to [Google Season of Docs](https://developers.google.com/season-of-docs/docs/timeline) to receive support for improving our documentation. Please check back soon.

If you are familiar with this content and would like to make a contribution, please feel free to open a PR :)

To cover:

* Buildpacks are stored on the filesystem as unarchived files such that:
* Each top-level directory is a buildpack ID.
* Each second-level directory is a buildpack version.
* Mount points
* Users
26 changes: 12 additions & 14 deletions content/docs/reference/spec/platform-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,25 @@ aliases=[
]
+++

The Platform specification defines the interface between the CNB [lifecycle](/docs/for-platform-operators/concepts/lifecycle/) and a [platform](/docs/for-app-developers/concepts/platform/) that runs it.
The Platform API specifies the interface between a [lifecycle] program
and a [platform] that runs it.

<!--more-->

## Buildpacks
## API Compatibility

Buildpacks are stored on the filesystem as unarchived files such that:
A [platform] may implement more than one Platform API version at a time, although it is not required to do so.
Platforms can control the Platform API version expected by the lifecycle by setting the `CNB_PLATFORM_API` environment variable.

* Each top-level directory is a buildpack ID.
* Each second-level directory is a buildpack version.
A [lifecycle] may (and usually does) support more than one Platform API version at a time.
The supported Platform API version(s) can be found in the `lifecycle.toml` file in a lifecycle tarball,
or in a label on the [lifecycle image](https://hub.docker.com/r/buildpacksio/lifecycle).

## Users

For security reasons, images built with platforms, such as `pack`, build and run as non-root users.

## Stacks (deprecated)

A stack (deprecated) is the grouping together of the build and run base images, represented by a unique ID.

The build image is used to run the buildpack lifecycle, and the run image is the base image for the application image.
A lifecycle "supports" a platform (and vice versa) if they both declare support for the same Platform API version in format: `<major>.<minor>`.

## Further Reading

You can read the complete [Platform API specification on Github](https://github.com/buildpacks/spec/blob/main/platform.md).

[lifecycle]: /docs/for-platform-operators/concepts/lifecycle/
[platform]: /docs/for-app-developers/concepts/platform/
Loading