-
Notifications
You must be signed in to change notification settings - Fork 184
New page "Basics of BuildPacks" under the Getting Started side menu #688
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
Open
QuillPusher
wants to merge
3
commits into
buildpacks:main
Choose a base branch
from
QuillPusher:add_buildpack_basics_under_getting_started
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
+++ | ||
title="An App's Brief Journey from Source to Image" | ||
weight=2 | ||
weight=3 | ||
getting-started=true | ||
+++ | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
+++ | ||
title="Basics of BuildPacks" | ||
weight=2 | ||
getting-started=true | ||
+++ | ||
|
||
## Basic Concepts | ||
|
||
### What is a Buildpack? | ||
|
||
A `buildpack` is software that transforms application source code into | ||
executable files by analyzing the code and determining the best way to | ||
build it. | ||
|
||
 | ||
|
||
Buildpacks have many shapes and forms. For example, a 'Distribution BuildPack' | ||
is a pre-built and tested buildpack that is ready for distribution to | ||
application developers. A Distribution Buildpack includes a set of buildpacks | ||
that are packaged together and can be used to build applications in different | ||
environments. | ||
|
||
'Paketo Buildpacks' is a distribution buildpack for building applications in | ||
Java, Go, Python, Ruby, etc. The buildpacks included in 'Paketo Buildpacks' | ||
work together to create application container images that can run on any | ||
platform that supports container images (e.g., Cloud Foundry, Docker, | ||
Kubernetes, etc.). | ||
|
||
### What is a Builder? | ||
|
||
A builder is an image that contains all the components necessary to | ||
execute a build (for example, an ordered combination of buildpacks, a build | ||
image and other files and configurations). | ||
|
||
 | ||
|
||
### What is a Lifecycle? | ||
|
||
A lifecycle is a series of steps that are used to create and manage a | ||
buildpack. The cumulative `create` step can be used to `analyze`, `detect`, | ||
`restore`, `build`, and `export` buildpack execution. All of these steps are | ||
part of a lifecycle. You can also re-enter a lifecycle using `rebase` to push | ||
the latest changes to an existing buildpack. | ||
|
||
 | ||
|
||
`launcher` is an independent step that can be used to launch the application | ||
at any time. | ||
|
||
### How BuildPacks add Efficiency to Code Iterations | ||
|
||
#### Building with Containers: | ||
|
||
Here's a quick look at how much manual effort is needed when working with | ||
containers, especially when major changes to the application need to be | ||
re-built. | ||
|
||
 | ||
|
||
#### Building with BuildPacks: | ||
|
||
With BuildPacks, a lot of the steps mentioned above are automated. However, | ||
the true power of BuildPack is evident when 'rebasing' a newer iteration of the | ||
application code. With a layered approach, only incremental changes are | ||
rebuilt, greatly improving the time and efficiency of the build process. | ||
|
||
 | ||
|
||
### What is a Platform | ||
|
||
A platform coordinates builds by invoking the lifecycle binary together with | ||
the buildpacks and the application source code in order to produce an | ||
executable OCI image. | ||
|
||
A platform can be a: | ||
|
||
- A local CLI tool | ||
- A plugin for a continuous integration service | ||
- A cloud application platform | ||
|
||
## Who uses Buildpacks (Personas) | ||
|
||
### App Developers | ||
|
||
Regular Application developers that utilize Buildpacks in their app packaging | ||
workflows. | ||
|
||
### Platform Operators | ||
|
||
Platform Operators are organizations or service providers (e.g., kpack, | ||
Tekton, Fly.io, Digital Ocean, Google Cloud, Heroku, SalesForce, etc.) that | ||
incorporates Buildpacks within their products to make buildpack functionality | ||
available to their end-users (typically, application developers). | ||
|
||
### Buildpack Authors | ||
|
||
Buildpacks' internal developers working on Buildpack features. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've always found it difficult to describe what an individual buildpack is! A
buildpack
is a small software component that does something. Would we be better off here to explain by example? i.e. provide an example of a "distribution" buildpack, an a "build process" buildpack?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Buildpacks have many shapes and forms. For example, a 'Distribution BuildPack' is a pre-built and tested buildpack that is ready for distribution to application developers. A Distribution Buildpack includes a set of buildpacks that are packaged together and can be used to build applications in different environments.
'Paketo Buildpacks' is a distribution buildpack for building applications in Java, Go, Python, Ruby, etc. The buildpacks included in 'Paketo Buildpacks' work together to create application container images that can run on any platform that supports container images (e.g., Cloud Foundry, Docker, Kubernetes, etc.).
Source: https://paketo.io/
P.s., I'm still connecting the dots with the core concepts, please see if the description is conceptually correct.