Skip to content

Commit 072cc00

Browse files
pspinradpspinrad
authored
Merge pull request #312 from sap-contributions/cnb-docu
Document use of Cloud Native Buildpacks
2 parents 10c3b98 + 4fb70a9 commit 072cc00

8 files changed

+133
-42
lines changed

‎classic.html.md.erb

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Classic Buildpacks
3+
owner: Buildpacks
4+
---
5+
6+
Buildpacks provide framework and runtime support for your apps. Buildpacks typically examine your apps to
7+
determine what dependencies to download and how to configure your apps to communicate with bound services.
8+
9+
When you push an app, Cloud Foundry automatically detects an appropriate buildpack for it.
10+
This buildpack is used to compile or prepare your app for launch.
11+
12+
Cloud Foundry deployments often have limited access to dependencies.
13+
This limitation occurs when the deployment is behind a firewall, or when administrators want to use local mirrors and proxies. In these circumstances, Cloud Foundry provides a Buildpack Packager app. For more information, see the <a href="https://github.com/cloudfoundry/buildpack-packager">Buildpack Packager</a> repository on GitHub.
14+
15+
## <a id='using-buildpacks'></a> Using buildpacks
16+
17+
The following topics discuss different usage scenarios for buildpacks in Cloud Foundry:
18+
19+
* [How buildpacks work](./understand-buildpacks.html)
20+
21+
* [Stack association](./stack-association.html)
22+
23+
* [Pushing an app with multiple buildpacks](./use-multiple-buildpacks.html)
24+
25+
* [Using a proxy](./proxy-usage.html)
26+
27+
* [Supported binary dependencies](./supported-binary-dependencies.html)
28+
29+
* [Production server configuration](./prod-server.html)
30+
31+
## <a id='system-buildpacks'></a> Cloud Foundry Buildpacks
32+
33+
For information about the existing buildpacks that Cloud Foundry supports, see [CF Buildpack Languages and Sources](./system-buildpacks.html).
34+
35+
## <a id='sidecar-buildpacks'></a> Sidecar buildpacks
36+
37+
For information about deploying a sidecar buildpack, see [Sidecar buildpack](./sidecar-buildpacks.html).
38+
39+
## <a id='community-buildpacks'></a> Community buildpacks
40+
41+
For a list of unsupported, community created buildpacks, see [Community created](https://github.com/cloudfoundry-community/cf-docs-contrib/wiki/Buildpacks#community-created) section of the _Buildpack information for Cloud Foundry v2_ page in the cf-docs-contrib repository on GitHub.
42+
43+
## <a id='developing-buildpacks'></a> Customizing and developing buildpacks
44+
45+
For information about customizing existing buildpacks and developing new buildpacks, see [Customizing and developing buildpacks](./developing-buildpacks.html).
46+
47+
## <a id='buildpack-ci'></a> Using continuous integration for buildpacks
48+
49+
For information about updating and releasing a new version of a Cloud Foundry buildpack through the Cloud Foundry Buildpacks Team Concourse pipeline, see [Using CI for buildpacks](./buildpack-ci-index.html). You can use this topic as a model when working with Concourse to build, and release new versions of your own buildpacks.

‎cnb/index.html.md.erb

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Cloud Native Buildpacks
3+
owner: Buildpacks
4+
---
5+
6+
Buildpacks provide framework and runtime support for your app. Buildpacks typically examine your app to
7+
determine what dependencies to download and how to start the application.
8+
9+
Since there are no system buildpacks yet for Cloud Native Buildpacks, you have to specify what buildpack to use, i.e. what type of application you have.
10+
11+
Cloud Foundry deployments often have limited access to dependencies.
12+
This limitation occurs when the deployment is behind a firewall, or when administrators want to use local mirrors and proxies. In these circumstances, Cloud Foundry provides a Buildpack Packager app. For more information, see the <a href="https://github.com/cloudfoundry/buildpack-packager">Buildpack Packager</a> repository on GitHub.
13+

‎cnb/own.html.md.erb

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Cloud Foundry buildpacks
3+
owner: Buildpacks
4+
---
5+
6+
Buildpacks provide framework and runtime support for your apps. Buildpacks typically examine your apps to
7+
determine what dependencies to download and how to configure your apps to communicate with bound services.
8+
9+
When you push an app, Cloud Foundry automatically detects an appropriate buildpack for it.
10+
This buildpack is used to compile or prepare your app for launch.
11+
12+
Cloud Foundry deployments often have limited access to dependencies.
13+
This limitation occurs when the deployment is behind a firewall, or when administrators want to use local mirrors and proxies. In these circumstances, Cloud Foundry provides a Buildpack Packager app. For more information, see the <a href="https://github.com/cloudfoundry/buildpack-packager">Buildpack Packager</a> repository on GitHub.
14+

‎cnb/paketo.html.md.erb

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Paketo Buildpacks
3+
owner: Buildpacks
4+
---
5+
6+
You can the [paketo](https://paketo.io/) buildpacks as one implementaion of Cloud Native Buildpacks. You will find buildpacks for the most popular languages, like
7+
8+
* Go
9+
* Java
10+
* NodeJS
11+
* Python
12+
* Ruby

‎cnb/understand-buildpacks.html.md.erb

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Working with Cloud Native in Cloud Foundry
3+
owner: Buildpacks
4+
---
5+
6+
This topic tells you about how buildpacks are structured and detected in Cloud Foundry.
7+
8+
## <a id='buildpack-scripts'></a> Buildpack scripts
9+
10+
A buildpack repository might contain the following scripts in the `bin` directory:
11+
12+
* `bin/detect` determines whether or not to apply the buildpack to an app.
13+
* `bin/build` is called if the buildpacks detect and builds the app including
14+
* downloading dependencies
15+
* actually building the app
16+
* defining the start command
17+
18+
You can use multiple buildpacks for your app
19+
20+
For example:
21+
22+
<p class="note">
23+
<span class="note__title"><strong>Note</strong></span>
24+
You must use cf CLI v9 or later.</p>
25+
26+
27+
```
28+
<code>cf push APP-NAME --lifecycle cnb -b docker://FIRST-BUILDPACK -b docker://SECOND-BUILDPACK</code>
29+
```
30+
31+
In this case <em>all</em> buildpacks must `detect` and `build` is called in the given order.

‎cnb/using.html.md.erb

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Using Cloud Native Buildpacks
3+
owner: Buildpacks
4+
---
5+
6+
This section provides links to additional information about using buildpacks. Each of the following
7+
topics are applicable to all supported buildpack languages:
8+
9+
* [Working with buildpacks in Cloud Foundry](./understand-buildpacks.html).
10+

‎index.html.md.erb

Lines changed: 3 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,11 @@
11
---
2-
title: Cloud Foundry buildpacks
2+
title: Cloud Foundry Buildpacks
33
owner: Buildpacks
44
---
55

66
Buildpacks provide framework and runtime support for your apps. Buildpacks typically examine your apps to
77
determine what dependencies to download and how to configure your apps to communicate with bound services.
88

9-
When you push an app, Cloud Foundry automatically detects an appropriate buildpack for it.
10-
This buildpack is used to compile or prepare your app for launch.
119

12-
Cloud Foundry deployments often have limited access to dependencies.
13-
This limitation occurs when the deployment is behind a firewall, or when administrators want to use local mirrors and proxies. In these circumstances, Cloud Foundry provides a Buildpack Packager app. For more information, see the <a href="https://github.com/cloudfoundry/buildpack-packager">Buildpack Packager</a> repository on GitHub.
14-
15-
## <a id='using-buildpacks'></a> Using buildpacks
16-
17-
The following topics discuss different usage scenarios for buildpacks in Cloud Foundry:
18-
19-
* [How buildpacks work](understand-buildpacks.html)
20-
21-
* [Stack association](stack-association.html)
22-
23-
* [Pushing an app with multiple buildpacks](use-multiple-buildpacks.html)
24-
25-
* [Using a proxy](proxy-usage.html)
26-
27-
* [Supported binary dependencies](supported-binary-dependencies.html)
28-
29-
* [Production server configuration](prod-server.html)
30-
31-
## <a id='system-buildpacks'></a> Cloud Foundry Buildpacks
32-
33-
For information about the existing buildpacks that Cloud Foundry supports, see [CF Buildpack Languages and Sources](system-buildpacks.html).
34-
35-
## <a id='sidecar-buildpacks'></a> Sidecar buildpacks
36-
37-
For information about deploying a sidecar buildpack, see [Sidecar buildpack](sidecar-buildpacks.html).
38-
39-
## <a id='community-buildpacks'></a> Community buildpacks
40-
41-
For a list of unsupported, community created buildpacks, see [Community created](https://github.com/cloudfoundry-community/cf-docs-contrib/wiki/Buildpacks#community-created) section of the _Buildpack information for Cloud Foundry v2_ page in the cf-docs-contrib repository on GitHub.
42-
43-
## <a id='developing-buildpacks'></a> Customizing and developing buildpacks
44-
45-
For information about customizing existing buildpacks and developing new buildpacks, see [Customizing and developing buildpacks](./developing-buildpacks.html).
46-
47-
## <a id='buildpack-ci'></a> Using continuous integration for buildpacks
48-
49-
For information about updating and releasing a new version of a Cloud Foundry buildpack through the Cloud Foundry Buildpacks Team Concourse pipeline, see [Using CI for buildpacks](./buildpack-ci-index.html). You can use this topic as a model when working with Concourse to build, and release new versions of your own buildpacks.
10+
In Cloud Foundry, you can use 2 types of buildpacks. [The Classic Buildpacks](./classic.html) (aka `v2`) and the
11+
[Cloud Native Buildpacks](./cnb/) (aka `v3`).

‎using-buildpacks.html.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Using buildpacks in Cloud Foundry
2+
title: Using Classic Buildpacks in Cloud Foundry
33
owner: Buildpacks
44
---
55

0 commit comments

Comments
 (0)