Skip to content

Commit 36377c6

Browse files
authored
Merge pull request #305 from vmware-tanzu/buildpack-commands
Add buildpack and clusterbuildpack commands
2 parents b9079e0 + 233c927 commit 36377c6

71 files changed

Lines changed: 4468 additions & 655 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/kp.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Learn more about kpack @ https://github.com/pivotal/kpack
2020

2121
* [kp build](kp_build.md) - Build Commands
2222
* [kp builder](kp_builder.md) - Builder Commands
23+
* [kp buildpack](kp_buildpack.md) - Buildpack Commands
2324
* [kp clusterbuilder](kp_clusterbuilder.md) - ClusterBuilder Commands
25+
* [kp clusterbuildpack](kp_clusterbuildpack.md) - ClusterBuildpack Commands
2426
* [kp clusterstack](kp_clusterstack.md) - ClusterStack Commands
2527
* [kp clusterstore](kp_clusterstore.md) - ClusterStore Commands
2628
* [kp completion](kp_completion.md) - Generate completion script

docs/kp_buildpack.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## kp buildpack
2+
3+
Buildpack Commands
4+
5+
### Options
6+
7+
```
8+
-h, --help help for buildpack
9+
```
10+
11+
### SEE ALSO
12+
13+
* [kp](kp.md) -
14+
* [kp buildpack create](kp_buildpack_create.md) - Create a buildpack
15+
* [kp buildpack delete](kp_buildpack_delete.md) - Delete a buildpack
16+
* [kp buildpack list](kp_buildpack_list.md) - List available buildpacks
17+
* [kp buildpack patch](kp_buildpack_patch.md) - Patch an existing buildpack configuration
18+
* [kp buildpack save](kp_buildpack_save.md) - Create or patch a buildpack
19+
* [kp buildpack status](kp_buildpack_status.md) - Display status of a buildpack
20+

docs/kp_buildpack_create.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## kp buildpack create
2+
3+
Create a buildpack
4+
5+
### Synopsis
6+
7+
Create a buildpack by providing command line arguments.
8+
The buildpack will be created only if it does not exist in the provided namespace.
9+
10+
The namespace defaults to the kubernetes current-context namespace.
11+
12+
```
13+
kp buildpack create <name> --image <image> [flags]
14+
```
15+
16+
### Examples
17+
18+
```
19+
kp buildpack create my-buildpack --image gcr.io/paketo-buildpacks/java
20+
kp buildpack create my-buildpack --image gcr.io/paketo-buildpacks/java:8.9.0
21+
kp buildpack create my-buildpack --image gcr.io/paketo-buildpacks/java@sha256:fc1c6fba46b582f63b13490b89e50e93c95ce08142a8737f4a6b70c826c995de
22+
23+
```
24+
25+
### Options
26+
27+
```
28+
--dry-run perform validation with no side-effects; no objects are sent to the server.
29+
The --dry-run flag can be used in combination with the --output flag to
30+
view the Kubernetes resource(s) without sending anything to the server.
31+
-h, --help help for create
32+
-i, --image string registry location where the buildpack is located
33+
-n, --namespace string kubernetes namespace
34+
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
35+
The output can be used with the "kubectl apply -f" command. To allow this, the command
36+
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
37+
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
38+
--service-account string service account name to use (default "default")
39+
```
40+
41+
### SEE ALSO
42+
43+
* [kp buildpack](kp_buildpack.md) - Buildpack Commands
44+

docs/kp_buildpack_delete.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## kp buildpack delete
2+
3+
Delete a buildpack
4+
5+
### Synopsis
6+
7+
Delete a buildpack in the provided namespace.
8+
9+
The namespace defaults to the kubernetes current-context namespace.
10+
11+
```
12+
kp buildpack delete <name> [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
kp buildpack delete my-buildpack
19+
kp buildpack delete -n my-namespace other-buildpack
20+
```
21+
22+
### Options
23+
24+
```
25+
-h, --help help for delete
26+
-n, --namespace string kubernetes namespace
27+
```
28+
29+
### SEE ALSO
30+
31+
* [kp buildpack](kp_buildpack.md) - Buildpack Commands
32+

docs/kp_buildpack_list.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## kp buildpack list
2+
3+
List available buildpacks
4+
5+
### Synopsis
6+
7+
Prints a table of the most important information about the available buildpacks in the provided namespace.
8+
9+
The namespace defaults to the kubernetes current-context namespace.
10+
11+
```
12+
kp buildpack list [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
kp buildpack list
19+
kp buildpack list -n my-namespace
20+
```
21+
22+
### Options
23+
24+
```
25+
-h, --help help for list
26+
-n, --namespace string kubernetes namespace
27+
```
28+
29+
### SEE ALSO
30+
31+
* [kp buildpack](kp_buildpack.md) - Buildpack Commands
32+

docs/kp_buildpack_patch.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## kp buildpack patch
2+
3+
Patch an existing buildpack configuration
4+
5+
### Synopsis
6+
7+
Patch an existing buildpack configuration by providing command line arguments.
8+
9+
The namespace defaults to the kubernetes current-context namespace.
10+
11+
```
12+
kp buildpack patch <name> [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
kp buildpack patch my-buildpack --image gcr.io/paketo-buildpacks/java
19+
kp buildpack patch my-buildpack --service-account my-other-sa
20+
```
21+
22+
### Options
23+
24+
```
25+
--dry-run perform validation with no side-effects; no objects are sent to the server.
26+
The --dry-run flag can be used in combination with the --output flag to
27+
view the Kubernetes resource(s) without sending anything to the server.
28+
-h, --help help for patch
29+
-i, --image string registry location where the buildpack is located
30+
-n, --namespace string kubernetes namespace
31+
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
32+
The output can be used with the "kubectl apply -f" command. To allow this, the command
33+
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
34+
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
35+
--service-account string service account name to use
36+
```
37+
38+
### SEE ALSO
39+
40+
* [kp buildpack](kp_buildpack.md) - Buildpack Commands
41+

docs/kp_buildpack_save.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## kp buildpack save
2+
3+
Create or patch a buildpack
4+
5+
### Synopsis
6+
7+
Create or patch a buildpack by providing command line arguments.
8+
The buildpack will be created only if it does not exist in the provided namespace, otherwise it will be patched.
9+
10+
No defaults will be assumed for patches.
11+
12+
The namespace defaults to the kubernetes current-context namespace.
13+
14+
```
15+
kp buildpack save <name> [flags]
16+
```
17+
18+
### Examples
19+
20+
```
21+
kp buildpack save my-buildpack --image gcr.io/paketo-buildpacks/java
22+
kp buildpack save my-buildpack --service-account my-other-sa
23+
```
24+
25+
### Options
26+
27+
```
28+
--dry-run perform validation with no side-effects; no objects are sent to the server.
29+
The --dry-run flag can be used in combination with the --output flag to
30+
view the Kubernetes resource(s) without sending anything to the server.
31+
-h, --help help for save
32+
-i, --image string registry location where the buildpack is located
33+
-n, --namespace string kubernetes namespace
34+
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
35+
The output can be used with the "kubectl apply -f" command. To allow this, the command
36+
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
37+
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
38+
--service-account string service account name to use
39+
```
40+
41+
### SEE ALSO
42+
43+
* [kp buildpack](kp_buildpack.md) - Buildpack Commands
44+

docs/kp_buildpack_status.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## kp buildpack status
2+
3+
Display status of a buildpack
4+
5+
### Synopsis
6+
7+
Prints detailed information about the status of a specific buildpack in the provided namespace.
8+
9+
The namespace defaults to the kubernetes current-context namespace.
10+
11+
```
12+
kp buildpack status <name> [flags]
13+
```
14+
15+
### Examples
16+
17+
```
18+
kp buildpack status my-buildpack
19+
kp buildpack status -n my-namespace other-buildpack
20+
```
21+
22+
### Options
23+
24+
```
25+
-h, --help help for status
26+
-n, --namespace string kubernetes namespace
27+
```
28+
29+
### SEE ALSO
30+
31+
* [kp buildpack](kp_buildpack.md) - Buildpack Commands
32+

docs/kp_clusterbuildpack.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## kp clusterbuildpack
2+
3+
ClusterBuildpack Commands
4+
5+
### Options
6+
7+
```
8+
-h, --help help for clusterbuildpack
9+
```
10+
11+
### SEE ALSO
12+
13+
* [kp](kp.md) -
14+
* [kp clusterbuildpack create](kp_clusterbuildpack_create.md) - Create a cluster buildpack
15+
* [kp clusterbuildpack delete](kp_clusterbuildpack_delete.md) - Delete a buildpack
16+
* [kp clusterbuildpack list](kp_clusterbuildpack_list.md) - List available cluster buildpacks
17+
* [kp clusterbuildpack patch](kp_clusterbuildpack_patch.md) - Patch an existing cluster buildpack configuration
18+
* [kp clusterbuildpack save](kp_clusterbuildpack_save.md) - Create or patch a cluster buildpack
19+
* [kp clusterbuildpack status](kp_clusterbuildpack_status.md) - Display status of a buildpack
20+

docs/kp_clusterbuildpack_create.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## kp clusterbuildpack create
2+
3+
Create a cluster buildpack
4+
5+
### Synopsis
6+
7+
Create a cluster buildpack by providing command line arguments.
8+
9+
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
10+
11+
12+
```
13+
kp clusterbuildpack create <name> --image <image> [flags]
14+
```
15+
16+
### Examples
17+
18+
```
19+
kp cbp create my-cluster-buildpack --image gcr.io/paketo-buildpacks/java
20+
kp cbp buildpack create my-cluster-buildpack --image gcr.io/paketo-buildpacks/java:8.9.0
21+
kp cbp buildpack create my-cluster-buildpack --image gcr.io/paketo-buildpacks/java@sha256:fc1c6fba46b582f63b13490b89e50e93c95ce08142a8737f4a6b70c826c995de
22+
23+
```
24+
25+
### Options
26+
27+
```
28+
--dry-run perform validation with no side-effects; no objects are sent to the server.
29+
The --dry-run flag can be used in combination with the --output flag to
30+
view the Kubernetes resource(s) without sending anything to the server.
31+
-h, --help help for create
32+
-i, --image string registry location where the cluster buildpack is located
33+
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
34+
The output can be used with the "kubectl apply -f" command. To allow this, the command
35+
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
36+
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
37+
```
38+
39+
### SEE ALSO
40+
41+
* [kp clusterbuildpack](kp_clusterbuildpack.md) - ClusterBuildpack Commands
42+

0 commit comments

Comments
 (0)