Skip to content

Commit

Permalink
Run docs generation script
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkennedy513 committed Feb 22, 2023
1 parent 0858848 commit efd7221
Show file tree
Hide file tree
Showing 11 changed files with 23 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/kp_clusterstack_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The run and build images will be uploaded to the default repository.
Therefore, you must have credentials to access the registry on your machine.
Additionally, your cluster must have read access to the registry.

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

The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.

Expand Down
2 changes: 2 additions & 0 deletions docs/kp_clusterstack_patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Patches the run and build images of a specific cluster-scoped stack.
The run and build images will be uploaded to the the registry configured on your stack.
Therefore, you must have credentials to access the registry on your machine.

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

The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.

Expand Down
2 changes: 2 additions & 0 deletions docs/kp_clusterstack_save.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The run and build images will be uploaded to the default repository.
Therefore, you must have credentials to access the registry on your machine.
Additionally, your cluster must have read access to the registry.

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

The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.

Expand Down
2 changes: 2 additions & 0 deletions docs/kp_clusterstore_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Upload buildpackage(s) to a specific cluster-scoped buildpack store.
Buildpackages will be uploaded to the default repository.
Therefore, you must have credentials to access the registry on your machine.

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

The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.


Expand Down
2 changes: 2 additions & 0 deletions docs/kp_clusterstore_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Create a cluster-scoped buildpack store by providing command line arguments.
Buildpackages will be uploaded to the default repository.
Therefore, you must have credentials to access the registry on your machine.

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

This clusterstore will be created only if it does not exist.
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
Expand Down
2 changes: 2 additions & 0 deletions docs/kp_clusterstore_save.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Create or update a cluster-scoped buildpack store by providing command line argu
Buildpackages will be uploaded to the default repository.
Therefore, you must have credentials to access the registry on your machine.

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

This clusterstore will be created only if it does not exist, otherwise it will be updated.
The default repository is read from the "default.repository" key in the "kp-config" ConfigMap within "kpack" namespace.
The default service account used is read from the "default.serviceaccount" key in the "kp-config" ConfigMap within "kpack" namespace.
Expand Down
4 changes: 3 additions & 1 deletion docs/kp_image_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ For example, "--env key1=value1 --env key2=value2 ...".

Service bindings may be provided by using the "--service-binding" flag.
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".
For example, "--service-binding my-secret-1 --service-binding Secret:v1:my-secret-2 --service-binding CustomProvisionedService:v1beta1:my-ps"
For example, "--service-binding my-secret-1 --service-binding Secret:v1:my-secret-2 --service-binding CustomProvisionedService:v1beta1:my-ps

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

```
kp image create <name> --tag <tag> [flags]
Expand Down
2 changes: 2 additions & 0 deletions docs/kp_image_patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ For example, "--service-binding my-secret-1 --service-binding CustomProvisionedS

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

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


```
kp image patch <name> [flags]
Expand Down
2 changes: 2 additions & 0 deletions docs/kp_image_save.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Service bindings may be provided by using the "--service-binding" flag or delete
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".
For example, "--service-binding my-secret-1 --service-binding CustomProvisionedService:v1beta1:my-ps --delete-service-binding Secret:v1:my-secret-2"

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


```
kp image save <name> --tag <tag> [flags]
Expand Down
2 changes: 2 additions & 0 deletions docs/kp_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ This operation will create or update clusterstores, clusterstacks, and clusterbu
kp import will always attempt to upload the stack, store, and builder images, even if the resources have not changed.
This can be used as a way to repair resources when registry images have been unexpectedly removed.

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

```
kp import -f <filename> [flags]
```
Expand Down
2 changes: 2 additions & 0 deletions docs/kp_lifecycle_patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Patch lifecycle image used by kpack
The Lifecycle image will be uploaded to the default repository.
Therefore, you must have credentials to access the registry on your machine.

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

The default repository is read from the "default.repository" key of the "kp-config" ConfigMap within "kpack" namespace.


Expand Down

0 comments on commit efd7221

Please sign in to comment.