Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose --event-log-file to render, apply, and test #5828

Merged
merged 3 commits into from
May 13, 2021
Merged

Expose --event-log-file to render, apply, and test #5828

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2fd001
Expose --event-log-file and --enable-rpc to render, apply, test
briandealwis May 12, 2021
babfaa8
hack/generate-man.sh
briandealwis May 13, 2021
7407737
hide --event-log-file and regen man pages
briandealwis May 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/skaffold/app/cmd/flags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ var flagRegistry = []Flag{
"debug": true,
},
FlagAddMethod: "BoolVar",
DefinedOn: []string{"dev", "build", "run", "debug", "deploy"},
DefinedOn: []string{"dev", "build", "run", "debug", "deploy", "render", "apply", "test"},
IsEnum: true,
},
{
Expand All @@ -174,7 +174,7 @@ var flagRegistry = []Flag{
Value: &opts.EventLogFile,
DefValue: "",
FlagAddMethod: "StringVar",
DefinedOn: []string{"dev", "build", "run", "debug", "deploy"},
DefinedOn: []string{"dev", "build", "run", "debug", "deploy", "render", "test", "apply"},
},
{
Name: "rpc-port",
Expand Down
12 changes: 12 additions & 0 deletions docs/content/en/docs/references/cli/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ Examples:

Options:
-c, --config='': File for global configurations (defaults to $HOME/.skaffold/config)
--enable-rpc=false: Enable gRPC for exposing Skaffold events
--event-log-file='': Save Skaffold events to the provided file after skaffold has finished executing, requires --enable-rpc=true
-f, --filename='skaffold.yaml': Path or URL to the Skaffold config file
--force=false: Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime!
--kube-context='': Deploy to this Kubernetes context
Expand All @@ -143,6 +145,8 @@ Use "skaffold options" for a list of global command-line options (applies to all
Env vars:

* `SKAFFOLD_CONFIG` (same as `--config`)
* `SKAFFOLD_ENABLE_RPC` (same as `--enable-rpc`)
* `SKAFFOLD_EVENT_LOG_FILE` (same as `--event-log-file`)
* `SKAFFOLD_FILENAME` (same as `--filename`)
* `SKAFFOLD_FORCE` (same as `--force`)
* `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`)
Expand Down Expand Up @@ -894,6 +898,8 @@ Options:
--cache-artifacts=true: Set to false to disable default caching of artifacts
-d, --default-repo='': Default repository value (overrides global config)
--digest-source='remote': Set to 'remote' to skip builds and resolve the digest of images by tag from the remote registry. Set to 'local' to build images locally and use digests from built images. Set to 'tag' to use tags directly from the build. Set to 'none' to use tags directly from the Kubernetes manifests.
--enable-rpc=false: Enable gRPC for exposing Skaffold events
--event-log-file='': Save Skaffold events to the provided file after skaffold has finished executing, requires --enable-rpc=true
-f, --filename='skaffold.yaml': Path or URL to the Skaffold config file
-l, --label=[]: Add custom labels to deployed objects. Set multiple times for multiple labels
--loud=false: Show the build logs and output
Expand All @@ -918,6 +924,8 @@ Env vars:
* `SKAFFOLD_CACHE_ARTIFACTS` (same as `--cache-artifacts`)
* `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`)
* `SKAFFOLD_DIGEST_SOURCE` (same as `--digest-source`)
* `SKAFFOLD_ENABLE_RPC` (same as `--enable-rpc`)
* `SKAFFOLD_EVENT_LOG_FILE` (same as `--event-log-file`)
* `SKAFFOLD_FILENAME` (same as `--filename`)
* `SKAFFOLD_LABEL` (same as `--label`)
* `SKAFFOLD_LOUD` (same as `--loud`)
Expand Down Expand Up @@ -1127,6 +1135,8 @@ Examples:

Options:
-a, --build-artifacts=: File containing build result from a previous 'skaffold build --file-output'
--enable-rpc=false: Enable gRPC for exposing Skaffold events
--event-log-file='': Save Skaffold events to the provided file after skaffold has finished executing, requires --enable-rpc=true
-f, --filename='skaffold.yaml': Path or URL to the Skaffold config file
-m, --module=[]: Filter Skaffold configs to only the provided named modules
--remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos)
Expand All @@ -1141,6 +1151,8 @@ Use "skaffold options" for a list of global command-line options (applies to all
Env vars:

* `SKAFFOLD_BUILD_ARTIFACTS` (same as `--build-artifacts`)
* `SKAFFOLD_ENABLE_RPC` (same as `--enable-rpc`)
* `SKAFFOLD_EVENT_LOG_FILE` (same as `--event-log-file`)
* `SKAFFOLD_FILENAME` (same as `--filename`)
* `SKAFFOLD_MODULE` (same as `--module`)
* `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`)
Expand Down