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.

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

added default-repo to getting started #1672

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
7 changes: 4 additions & 3 deletions docs/content/en/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,9 @@ https://storage.googleapis.com/skaffold/builds/latest/skaffold-windows-amd64.exe

## `skaffold dev`: Build and deploy your app every time your code changes

Run command `skaffold dev` to build and deploy your app continuously. You should
see some outputs similar to the following entries:
Run command `skaffold dev --default-repo <myrepo>` to build and deploy your app continuously.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we remove the word command here? sentence is a bit awkward with it.

The `--default-repo` functionality enables to push images to your own repository instead of the default `gcr.io/k8s-skaffold` repo.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/enables to push/enables pushing

You should see some outputs similar to the following entries:

```
Starting build...
Expand All @@ -167,7 +168,7 @@ Step 5/5 : RUN go build -o app main.go
---> 9c4622e8f0e7
Successfully built 9c4622e8f0e7
Successfully tagged 930080f0965230e824a79b9e7eccffbd:latest
Successfully tagged gcr.io/k8s-skaffold/skaffold-example:9c4622e8f0e7b5549a61a503bf73366a9cf7f7512aa8e9d64f3327a3c7fded1b
Successfully tagged <myrepo>/gcr.io/k8s-skaffold/skaffold-example:9c4622e8f0e7b5549a61a503bf73366a9cf7f7512aa8e9d64f3327a3c7fded1b
Build complete in 657.426821ms
Starting deploy...
Deploying k8s-pod.yaml...
Expand Down
7 changes: 7 additions & 0 deletions docs/content/en/docs/tutorials/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,10 @@ weight: 90
---

See the [Github Examples page](https://github.com/GoogleContainerTools/skaffold/tree/master/examples) for examples.

To run the examples, you either have to manually replace the image repositories in the examples from gcr.io/k8s-skaffold to yours or you can point skaffold to your default image repository in one of the four ways:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little nitpicky: can this be structured something like:

To run the examples in the repo, you have two options:
  1) manually replace the image repositories in the example skaffold.yamls from gcr.io/k8s-skaffold to your own person repository
  2) point skaffold to your default image repository in one of the four ways:
....

this just makes it a bit more clear to the user why it's being done this way, and why the default-repo stuff even exists in the first place.


* flag: `skaffold dev --default-repo <myrepo>`
* env var: `SKAFFOLD_DEFAULT_REPO=<myrepo> skaffold dev`
* global skaffold config (one time): `skaffold config set --global default-repo <myrepo>`
* skaffold config for current kubectl context: `skaffold config set default-repo <myrepo>`