Skip to content

Commit d2de9aa

Browse files
Merge pull request #280 from vmware-tanzu/docs
Run docs generation script
2 parents 7d034eb + 1009d71 commit d2de9aa

11 files changed

Lines changed: 23 additions & 1 deletion

docs/kp_clusterstack_create.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ The run and build images will be uploaded to the default repository.
1010
Therefore, you must have credentials to access the registry on your machine.
1111
Additionally, your cluster must have read access to the registry.
1212

13+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
14+
1315
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
1416
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
1517

docs/kp_clusterstack_patch.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Patches the run and build images of a specific cluster-scoped stack.
99
The run and build images will be uploaded to the the registry configured on your stack.
1010
Therefore, you must have credentials to access the registry on your machine.
1111

12+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
13+
1214
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
1315
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
1416

docs/kp_clusterstack_save.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ The run and build images will be uploaded to the default repository.
1010
Therefore, you must have credentials to access the registry on your machine.
1111
Additionally, your cluster must have read access to the registry.
1212

13+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
14+
1315
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
1416
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
1517

docs/kp_clusterstore_add.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Upload buildpackage(s) to a specific cluster-scoped buildpack store.
99
Buildpackages will be uploaded to the default repository.
1010
Therefore, you must have credentials to access the registry on your machine.
1111

12+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
13+
1214
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
1315

1416

docs/kp_clusterstore_create.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Create a cluster-scoped buildpack store by providing command line arguments.
99
Buildpackages will be uploaded to the default repository.
1010
Therefore, you must have credentials to access the registry on your machine.
1111

12+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
13+
1214
This clusterstore will be created only if it does not exist.
1315
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
1416
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.

docs/kp_clusterstore_save.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Create or update a cluster-scoped buildpack store by providing command line argu
99
Buildpackages will be uploaded to the default repository.
1010
Therefore, you must have credentials to access the registry on your machine.
1111

12+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
13+
1214
This clusterstore will be created only if it does not exist, otherwise it will be updated.
1315
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
1416
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.

docs/kp_image_create.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ For example, "--env key1=value1 --env key2=value2 ...".
2525

2626
Service bindings may be provided by using the "--service-binding" flag.
2727
For each service binding, supply the "--service-binding" flag followed by the <KIND>:<APIVERSION>:<NAME> or just <NAME> which will default the kind to "Secret".
28-
For example, "--service-binding my-secret-1 --service-binding Secret:v1:my-secret-2 --service-binding CustomProvisionedService:v1beta1:my-ps"
28+
For example, "--service-binding my-secret-1 --service-binding Secret:v1:my-secret-2 --service-binding CustomProvisionedService:v1beta1:my-ps
29+
30+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md"
2931

3032
```
3133
kp image create <name> --tag <tag> [flags]

docs/kp_image_patch.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ For example, "--service-binding my-secret-1 --service-binding CustomProvisionedS
2828

2929
The --cache-size flag can only be used to increase the size of the existing cache.
3030

31+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
32+
3133

3234
```
3335
kp image patch <name> [flags]

docs/kp_image_save.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Service bindings may be provided by using the "--service-binding" flag or delete
2929
For each service binding, supply the "--service-binding" flag followed by the <KIND>:<APIVERSION>:<NAME> or just <NAME> which will default the kind to "Secret".
3030
For example, "--service-binding my-secret-1 --service-binding CustomProvisionedService:v1beta1:my-ps --delete-service-binding Secret:v1:my-secret-2"
3131

32+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
33+
3234

3335
```
3436
kp image save <name> --tag <tag> [flags]

docs/kp_import.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ This operation will create or update clusterstores, clusterstacks, and clusterbu
99
kp import will always attempt to upload the stack, store, and builder images, even if the resources have not changed.
1010
This can be used as a way to repair resources when registry images have been unexpectedly removed.
1111

12+
Env vars can be used for registry auth as described in https://github.com/vmware-tanzu/kpack-cli/blob/main/docs/auth.md
13+
1214
```
1315
kp import -f <filename> [flags]
1416
```

0 commit comments

Comments
 (0)