Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history 
Signed-off-by: Caroline Scherf <[email protected]>
  • Loading branch information
@fcaroline2020
fcaroline2020 committed Jul 24, 2023
1 parent 848ab19 commit 0c9899a
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 65 deletions.
4 changes: 2 additions & 2 deletions cmd/docs/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package main

import (
"io/ioutil"
"io"
"log"
"os"

Expand All @@ -14,7 +14,7 @@ import (
)

func main() {
log.SetOutput(ioutil.Discard)
log.SetOutput(io.Discard)

cmd := rootcommand.GetRootCommand()

Expand Down
60 changes: 30 additions & 30 deletions docs/kp_image_create.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,36 +49,36 @@ kp image create my-image --tag my-registry.com/my-repo --blob https://my-blob-ho
### Options

```
--additional-tag stringArray additional tags to push the OCI image to
--blob string source code blob url
-b, --builder string builder name
--cache-size string cache size as a kubernetes quantity (default "2G")
-c, --cluster-builder string cluster builder name
--dry-run perform validation with no side-effects; no objects are sent to the server.
The --dry-run flag can be used in combination with the --output flag to
view the Kubernetes resource(s) without sending anything to the server.
--dry-run-with-image-upload similar to --dry-run, but with container image uploads allowed.
This flag is provided as a convenience for kp commands that can output Kubernetes
resource with generated container image references. A "kubectl apply -f" of the
resource from --output without image uploads will result in a reconcile failure.
-e, --env stringArray build time environment variables
--git string git repository url
--git-revision string git revision such as commit, tag, or branch (default "main")
-h, --help help for create
--local-path string path to local source code
--local-path-destination-image registry location of local source image
-n, --namespace string kubernetes namespace
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
The output can be used with the "kubectl apply -f" command. To allow this, the command
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
--registry-ca-cert-path string add CA certificate for registry API (format: /tmp/ca.crt)
--registry-verify-certs set whether to verify server's certificate chain and host name (default true)
--service-account string service account name to use (default "default")
-s, --service-binding stringArray build time service bindings
--sub-path string build code at the sub path located within the source code directory
-t, --tag string registry location where the OCI image will be created
-w, --wait wait for image create to be reconciled and tail resulting build logs
--additional-tag stringArray additional tags to push the OCI image to
--blob string source code blob url
-b, --builder string builder name
--cache-size string cache size as a kubernetes quantity (default "2G")
-c, --cluster-builder string cluster builder name
--dry-run perform validation with no side-effects; no objects are sent to the server.
The --dry-run flag can be used in combination with the --output flag to
view the Kubernetes resource(s) without sending anything to the server.
--dry-run-with-image-upload similar to --dry-run, but with container image uploads allowed.
This flag is provided as a convenience for kp commands that can output Kubernetes
resource with generated container image references. A "kubectl apply -f" of the
resource from --output without image uploads will result in a reconcile failure.
-e, --env stringArray build time environment variables
--git string git repository url
--git-revision string git revision such as commit, tag, or branch (default "main")
-h, --help help for create
--local-path string path to local source code
--local-path-destination-image string registry location of local source image
-n, --namespace string kubernetes namespace
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
The output can be used with the "kubectl apply -f" command. To allow this, the command
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
--registry-ca-cert-path string add CA certificate for registry API (format: /tmp/ca.crt)
--registry-verify-certs set whether to verify server's certificate chain and host name (default true)
--service-account string service account name to use (default "default")
-s, --service-binding stringArray build time service bindings
--sub-path string build code at the sub path located within the source code directory
-t, --tag string registry location where the OCI image will be created
-w, --wait wait for image create to be reconciled and tail resulting build logs
```

### SEE ALSO
Expand Down
66 changes: 33 additions & 33 deletions docs/kp_image_save.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,39 +52,39 @@ kp image save my-image --tag my-registry.com/my-repo --blob https://my-blob-host
### Options

```
--additional-tag stringArray additional tags to push the OCI image to
--blob string source code blob url
-b, --builder string builder name
--cache-size string cache size as a kubernetes quantity (default "2G")
-c, --cluster-builder string cluster builder name
--delete-additional-tag stringArray additional tags to remove
-d, --delete-env stringArray build time environment variables to remove
--delete-service-binding stringArray build time service bindings to remove
--dry-run perform validation with no side-effects; no objects are sent to the server.
The --dry-run flag can be used in combination with the --output flag to
view the Kubernetes resource(s) without sending anything to the server.
--dry-run-with-image-upload similar to --dry-run, but with container image uploads allowed.
This flag is provided as a convenience for kp commands that can output Kubernetes
resource with generated container image references. A "kubectl apply -f" of the
resource from --output without image uploads will result in a reconcile failure.
-e, --env stringArray build time environment variables
--git string git repository url
--git-revision string git revision such as commit, tag, or branch (default "main")
-h, --help help for save
--local-path string path to local source code
--local-path-destination-image registry location of local source image
-n, --namespace string kubernetes namespace
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
The output can be used with the "kubectl apply -f" command. To allow this, the command
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
--registry-ca-cert-path string add CA certificate for registry API (format: /tmp/ca.crt)
--registry-verify-certs set whether to verify server's certificate chain and host name (default true)
--service-account string service account name to use
-s, --service-binding stringArray build time service bindings to add/replace
--sub-path string build code at the sub path located within the source code directory
-t, --tag string registry location where the image will be created
-w, --wait wait for image create to be reconciled and tail resulting build logs
--additional-tag stringArray additional tags to push the OCI image to
--blob string source code blob url
-b, --builder string builder name
--cache-size string cache size as a kubernetes quantity (default "2G")
-c, --cluster-builder string cluster builder name
--delete-additional-tag stringArray additional tags to remove
-d, --delete-env stringArray build time environment variables to remove
--delete-service-binding stringArray build time service bindings to remove
--dry-run perform validation with no side-effects; no objects are sent to the server.
The --dry-run flag can be used in combination with the --output flag to
view the Kubernetes resource(s) without sending anything to the server.
--dry-run-with-image-upload similar to --dry-run, but with container image uploads allowed.
This flag is provided as a convenience for kp commands that can output Kubernetes
resource with generated container image references. A "kubectl apply -f" of the
resource from --output without image uploads will result in a reconcile failure.
-e, --env stringArray build time environment variables
--git string git repository url
--git-revision string git revision such as commit, tag, or branch (default "main")
-h, --help help for save
--local-path string path to local source code
--local-path-destination-image string registry location of source image
-n, --namespace string kubernetes namespace
--output string print Kubernetes resources in the specified format; supported formats are: yaml, json.
The output can be used with the "kubectl apply -f" command. To allow this, the command
updates are redirected to stderr and only the Kubernetes resource(s) are written to stdout.
The APIVersion of the outputted resources will always be the latest APIVersion known to kp (currently: v1alpha2).
--registry-ca-cert-path string add CA certificate for registry API (format: /tmp/ca.crt)
--registry-verify-certs set whether to verify server's certificate chain and host name (default true)
--service-account string service account name to use
-s, --service-binding stringArray build time service bindings to add/replace
--sub-path string build code at the sub path located within the source code directory
-t, --tag string registry location where the image will be created
-w, --wait wait for image create to be reconciled and tail resulting build logs
```

### SEE ALSO
Expand Down

0 comments on commit 0c9899a

Please sign in to comment.