Skip to content

Commit 20fcded

Browse files
Merge pull request #433 from neil-hickey/feat/add-clusterlifecycle-command
feat: add ClusterLifecycle command and deprecate lifecycle command
2 parents 9370e54 + 208ab8a commit 20fcded

39 files changed

Lines changed: 5372 additions & 397 deletions

docs/kp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Learn more about kpack @ https://github.com/pivotal/kpack
2323
* [kp buildpack](kp_buildpack.md) - Buildpack Commands
2424
* [kp clusterbuilder](kp_clusterbuilder.md) - ClusterBuilder Commands
2525
* [kp clusterbuildpack](kp_clusterbuildpack.md) - ClusterBuildpack Commands
26+
* [kp clusterlifecycle](kp_clusterlifecycle.md) - ClusterLifecycle Commands
2627
* [kp clusterstack](kp_clusterstack.md) - ClusterStack Commands
2728
* [kp clusterstore](kp_clusterstore.md) - ClusterStore Commands
2829
* [kp completion](kp_completion.md) - Generate completion script
2930
* [kp config](kp_config.md) - Config commands
3031
* [kp image](kp_image.md) - Image commands
3132
* [kp import](kp_import.md) - Import dependencies for stores, stacks, and cluster builders
32-
* [kp lifecycle](kp_lifecycle.md) - Lifecycle Commands
3333
* [kp secret](kp_secret.md) - Secret Commands
3434
* [kp version](kp_version.md) - Display kp version
3535

docs/kp_clusterlifecycle.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## kp clusterlifecycle
2+
3+
ClusterLifecycle Commands
4+
5+
### Options
6+
7+
```
8+
-h, --help help for clusterlifecycle
9+
```
10+
11+
### SEE ALSO
12+
13+
* [kp](kp.md) -
14+
* [kp clusterlifecycle create](kp_clusterlifecycle_create.md) - Create a clusterlifecycle
15+
* [kp clusterlifecycle delete](kp_clusterlifecycle_delete.md) - Delete a clusterlifecycle
16+
* [kp clusterlifecycle list](kp_clusterlifecycle_list.md) - List cluster lifecycles
17+
* [kp clusterlifecycle patch](kp_clusterlifecycle_patch.md) - Patch a clusterlifecycle
18+
* [kp clusterlifecycle save](kp_clusterlifecycle_save.md) - Create or patch a cluster lifecycle
19+
* [kp clusterlifecycle status](kp_clusterlifecycle_status.md) - Display cluster lifecycle status
20+

docs/kp_clusterlifecycle_create.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## kp clusterlifecycle create
2+
3+
Create a clusterlifecycle
4+
5+
### Synopsis
6+
7+
Create a cluster-scoped lifecycle by providing command line arguments.
8+
9+
The image will be uploaded to the default repository.
10+
Therefore, you must have credentials to access the registry on your machine.
11+
Additionally, your cluster must have read access to the registry.
12+
13+
Env vars can be used for registry auth as described in https://github.com/buildpacks-community/kpack-cli/blob/main/docs/auth.md
14+
15+
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
16+
The default service account used is read from the "default.repository.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
17+
18+
19+
```
20+
kp clusterlifecycle create <name> [flags]
21+
```
22+
23+
### Examples
24+
25+
```
26+
kp clusterlifecycle create my-lifecycle --image buildpacksio/lifecycle
27+
28+
```
29+
30+
### Options
31+
32+
```
33+
--dry-run perform validation with no side-effects; no objects are sent to the server.
34+
The --dry-run flag can be used in combination with the --output flag to
35+
view the Kubernetes resource(s) without sending anything to the server.
36+
--dry-run-with-image-upload similar to --dry-run, but with container image uploads allowed.
37+
This flag is provided as a convenience for kp commands that can output Kubernetes
38+
resource with generated container image references. A "kubectl apply -f" of the
39+
resource from --output without image uploads will result in a reconcile failure.
40+
-h, --help help for create
41+
-i, --image string image tag or local tar file path
42+
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
43+
The output can be used with the "kubectl apply -f" command. To allow this, the command
44+
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
45+
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
46+
--registry-ca-cert-path string add CA certificate for registry API (format: /tmp/ca.crt)
47+
--registry-verify-certs set whether to verify server's certificate chain and host name (default true)
48+
```
49+
50+
### SEE ALSO
51+
52+
* [kp clusterlifecycle](kp_clusterlifecycle.md) - ClusterLifecycle Commands
53+

docs/kp_clusterlifecycle_delete.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## kp clusterlifecycle delete
2+
3+
Delete a clusterlifecycle
4+
5+
### Synopsis
6+
7+
Delete a specific cluster-scoped lifecycle from the cluster.
8+
9+
```
10+
kp clusterlifecycle delete <name> [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
kp clusterlifecycle delete my-lifecycle
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for delete
23+
```
24+
25+
### SEE ALSO
26+
27+
* [kp clusterlifecycle](kp_clusterlifecycle.md) - ClusterLifecycle Commands
28+

docs/kp_clusterlifecycle_list.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## kp clusterlifecycle list
2+
3+
List cluster lifecycles
4+
5+
### Synopsis
6+
7+
Prints a table of the most important information about cluster-scoped lifecycles in the cluster.
8+
9+
```
10+
kp clusterlifecycle list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
kp clusterlifecycle list
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for list
23+
```
24+
25+
### SEE ALSO
26+
27+
* [kp clusterlifecycle](kp_clusterlifecycle.md) - ClusterLifecycle Commands
28+

docs/kp_clusterlifecycle_patch.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## kp clusterlifecycle patch
2+
3+
Patch a clusterlifecycle
4+
5+
### Synopsis
6+
7+
Patches the image of a specific cluster-scoped lifecycle.
8+
9+
The image will be uploaded to the registry configured on your lifecycle.
10+
Therefore, you must have credentials to access the registry on your machine.
11+
12+
Env vars can be used for registry auth as described in https://github.com/buildpacks-community/kpack-cli/blob/main/docs/auth.md
13+
14+
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
15+
The default service account used is read from the "default.repository.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
16+
17+
```
18+
kp clusterlifecycle patch <name> [flags]
19+
```
20+
21+
### Examples
22+
23+
```
24+
kp clusterlifecycle patch my-lifecycle --image buildpacksio/lifecycle
25+
```
26+
27+
### Options
28+
29+
```
30+
--dry-run perform validation with no side-effects; no objects are sent to the server.
31+
The --dry-run flag can be used in combination with the --output flag to
32+
view the Kubernetes resource(s) without sending anything to the server.
33+
--dry-run-with-image-upload similar to --dry-run, but with container image uploads allowed.
34+
This flag is provided as a convenience for kp commands that can output Kubernetes
35+
resource with generated container image references. A "kubectl apply -f" of the
36+
resource from --output without image uploads will result in a reconcile failure.
37+
-h, --help help for patch
38+
-i, --image string image tag or local tar file path
39+
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
40+
The output can be used with the "kubectl apply -f" command. To allow this, the command
41+
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
42+
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
43+
--registry-ca-cert-path string add CA certificate for registry API (format: /tmp/ca.crt)
44+
--registry-verify-certs set whether to verify server's certificate chain and host name (default true)
45+
```
46+
47+
### SEE ALSO
48+
49+
* [kp clusterlifecycle](kp_clusterlifecycle.md) - ClusterLifecycle Commands
50+

docs/kp_clusterlifecycle_save.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## kp clusterlifecycle save
2+
3+
Create or patch a cluster lifecycle
4+
5+
### Synopsis
6+
7+
Create or patch a cluster-scoped lifecycle by providing command line arguments.
8+
9+
The image will be uploaded to the default repository.
10+
Therefore, you must have credentials to access the registry on your machine.
11+
Additionally, your cluster must have read access to the registry.
12+
13+
Env vars can be used for registry auth as described in https://github.com/buildpacks-community/kpack-cli/blob/main/docs/auth.md
14+
15+
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
16+
The default service account used is read from the "default.repository.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
17+
18+
19+
```
20+
kp clusterlifecycle save <name> [flags]
21+
```
22+
23+
### Examples
24+
25+
```
26+
kp clusterlifecycle save my-lifecycle --image buildpacksio/lifecycle
27+
```
28+
29+
### Options
30+
31+
```
32+
--dry-run perform validation with no side-effects; no objects are sent to the server.
33+
The --dry-run flag can be used in combination with the --output flag to
34+
view the Kubernetes resource(s) without sending anything to the server.
35+
--dry-run-with-image-upload similar to --dry-run, but with container image uploads allowed.
36+
This flag is provided as a convenience for kp commands that can output Kubernetes
37+
resource with generated container image references. A "kubectl apply -f" of the
38+
resource from --output without image uploads will result in a reconcile failure.
39+
-h, --help help for save
40+
-i, --image string image tag or local tar file path
41+
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
42+
The output can be used with the "kubectl apply -f" command. To allow this, the command
43+
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
44+
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
45+
--registry-ca-cert-path string add CA certificate for registry API (format: /tmp/ca.crt)
46+
--registry-verify-certs set whether to verify server's certificate chain and host name (default true)
47+
```
48+
49+
### SEE ALSO
50+
51+
* [kp clusterlifecycle](kp_clusterlifecycle.md) - ClusterLifecycle Commands
52+

docs/kp_clusterlifecycle_status.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## kp clusterlifecycle status
2+
3+
Display cluster lifecycle status
4+
5+
### Synopsis
6+
7+
Prints detailed information about the status of a specific cluster-scoped lifecycle.
8+
9+
```
10+
kp clusterlifecycle status <name> [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
kp clusterlifecycle status my-lifecycle
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for status
23+
-v, --verbose display supported and deprecated buildpack APIs
24+
```
25+
26+
### SEE ALSO
27+
28+
* [kp clusterlifecycle](kp_clusterlifecycle.md) - ClusterLifecycle Commands
29+

0 commit comments

Comments
 (0)