Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 2f57de6

Browse files
authored
Merge pull request cloudfoundry#1825 from cloudfoundry/document-kpack-lifecycle-174024842
document kpack lifecycle [finishes #174024842]
2 parents 18e857d + db005cd commit 2f57de6

1 file changed

Lines changed: 35 additions & 4 deletions

File tree

docs/v3/source/includes/concepts/_lifecycles.md.erb

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ pull a Docker image from a registry to run an app.
77

88
Name | Type | Description
99
---- | ---- | -----------
10-
**type** | _string_ | Type of the lifecycle; valid values are `buildpack`, `docker`
10+
**type** | _string_ | Type of the lifecycle; valid values are `buildpack`, `docker`, `kpack`
1111
**data** | _object_ | Data that is used during staging and running for a lifecycle
1212

1313
### Buildpack lifecycle
@@ -26,16 +26,18 @@ Example Buildpack Lifecycle
2626
}
2727
```
2828

29-
This is the default lifecycle for Cloud Foundry. When staging an app with this lifecycle, the app source code will be
29+
This is the default lifecycle for Cloud Foundry for VMs. When staging an app with this lifecycle, the app source code will be
3030
compiled using a buildpack, resulting in a droplet. When running an app with this lifecycle, a container running a rootfs
3131
will be created and the droplet will be expanded inside that container to be executed.
3232

33+
**Note**: This lifecycle is not supported on Cloud Foundry for Kubernetes.
34+
3335
#### Buildpack lifecycle object
3436

3537
Name | Type | Description
3638
---- | ---- | -----------
3739
**type** | _string_ | `buildpack`
38-
**data.buildpacks** | _array of strings_ | A list of the names of buildpacks, URLs from which they may be downloaded, or `null` to auto-detect a suitable buildpack
40+
**data.buildpacks** | _array of strings_ | A list of the names of buildpacks, URLs from which they may be downloaded, or `null` to auto-detect a suitable buildpack during staging
3941
**data.stack** | _string_ | The root filesystem to use with the buildpack, for example `cflinuxfs3`
4042

4143
### Docker lifecycle
@@ -51,7 +53,7 @@ Example Docker Lifecycle
5153
}
5254
```
5355

54-
This allows Cloud Foundry to run Docker images. When staging an app with this lifecycle, the Docker registry is queried for
56+
This allows Cloud Foundry to run pre-built Docker images. When staging an app with this lifecycle, the Docker registry is queried for
5557
metadata about the image, such as ports and start command. When running an app with this lifecycle, a container is created
5658
and the Docker image is executed inside of it.
5759

@@ -62,3 +64,32 @@ Name | Type | Description
6264
**type** | _string_ | `docker`
6365
**data** | _object_ | Data is not used by the Docker lifecycle; valid value is `{}`
6466

67+
### Kpack lifecycle
68+
69+
```
70+
Example Kpack Lifecycle
71+
```
72+
73+
```json
74+
{
75+
"type": "kpack",
76+
"data": {
77+
"buildpacks": ["paketo-buildpacks/java"]
78+
}
79+
}
80+
```
81+
82+
This is the default lifecycle for Cloud Foundry for Kubernetes. When staging an app with this lifecycle, the app source code will be
83+
built into an OCI image using a [Cloud Native Buildpack](https://buildpacks.io/) and [kpack](https://github.com/pivotal/kpack).
84+
This image is published to the app image registry and a `docker` lifecycle droplet is created referring to the image.
85+
86+
When running an app with this lifecycle, a container is created and the OCI image is executed inside of it.
87+
88+
**Note**: This lifecycle is not supported on Cloud Foundry for VMs.
89+
90+
#### Kpack lifecycle object
91+
92+
Name | Type | Description
93+
---- | ---- | -----------
94+
**type** | _string_ | `kpack`
95+
**data.buildpacks** | _array of strings_ | An optional list of buildpack names. Specify an empty list to auto-detect a suitable buildpack during staging

0 commit comments

Comments
 (0)