Skip to content

Commit

Permalink
Update docs for --progress (#360)
Browse files Browse the repository at this point in the history
* hint: Waiting for your editor to close the file...
Initial checkin of code to check on the progress of deployment.
The deployment will fail if a container failes with ErrImagePull.
State changes of pods and containers may optionally be displayed.

This is an intermedite checkin and is not complete.

* Do not crash if we fail to initiate the progress tracker.

* Remove unnecessary client parameter to newWatcher.

* Remove the ceos4 update.  It intereacts with ceos3 inside the
Kubernetes fake when doing updates.  Update to test changes to
pods.go

* Turn off lint for the nil context test.

* Turn off lint for the nil context test.

* Rename Verbose to Progress

* Move status.go from deploy to pods as it is generic.

* Switch to main's go.mod/go.sum

* Update documentation to include --progress.
  • Loading branch information
bormanp authored Apr 17, 2023
1 parent f821cab commit 101c672
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/create_topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Usage:
kne deploy <deployment yaml> [flags]

Flags:
-h, --help help for deploy
-h, --help help for deploy
--progress Display progress of container bringup

Global Flags:
--kubecfg string kubeconfig file (default "/path/to/home/{{USERNAME}}/.kube/config")
Expand Down
4 changes: 4 additions & 0 deletions docs/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ For an exhaustive list use the `-A` flag instead of `-n`.

## Common issues

Use the `--progress` option to monitor the state of the pods as KNE is coming up.

### Pods stuck in ImagePullBackOff

```bash
Expand All @@ -43,6 +45,8 @@ container image access [steps](create_topology.md#container_images) and then
delete/recreate the topology. To check which image is causing the issue, use
`kubectl describe` command on the problematic pod.

KNE should normally detect this condition and fail the deployment.

### Pods stuck in Init

After creating a topology, some pods may get stuck in an `Init:0/1` state while
Expand Down

0 comments on commit 101c672

Please sign in to comment.