Skip to content

Commit

Permalink
docs: update troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
digikata committed Dec 17, 2024
1 parent 63ee423 commit aa677c2
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
21 changes: 21 additions & 0 deletions docs/fluvio/cli/fluvio/cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,26 @@ $ fluvio cluster spu list
5001 custom-spu-5001 Online "custom" - localhost:9010 localhost:9011
```

## `fluvio cluster upgrade`

Upgrade a local Fluvio cluster from an older version to a newer version of Fluvio.

:::danger
Be careful, this cannot be undone.
:::

**Example usage**

To upgrade a Fluvio local cluster, shutdown the cluster with its current version,
`fvm` switch to the new version of Fluvio, perform the upgrade, then resume the cluster.

```bash copy="fl"
$ fluvio cluster shutdown
$ fvm switch stable # or desired newer version e.g. fvm switch 0.14.0
$ fluvio cluster upgrade
$ fluvio cluster resume
```


[getting started guide]: fluvio/quickstart.mdx
[Kubernetes Install]: fluvio/installation/kubernetes.mdx
20 changes: 17 additions & 3 deletions docs/fluvio/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This document will help you troubleshoot common issues with your Fluvio cluster.

## Troubleshooting a Local Cluster


To troubleshoot a local Fluvio cluster, you can check the logs of the SC and SPUs processes.

- Run `cat ~/.fluvio/log/flv_sc.log` for SC logs
Expand All @@ -17,9 +16,21 @@ To troubleshoot a local Fluvio cluster, you can check the logs of the SC and SPU

You can also use `tail -n 100 ~/.fluvio/log/flv_sc.log` to just print the last 100 lines of the log file.

### Getting help

You can ask for help from the Fluvio [Discord]: https://discord.com/invite/bBG2dTz group,

The logging information needed for diagnostics can be packaged up with the command
`fluvio cluster diagnostics`. The compressed archive can be shared in the Discord group or sent via PM to Infinyon admins

## Upgrading the Cluster

If you receive an error `Check Versions match failed Check Versions match failed: cannot resume a x.y.z cluster with fluvio version a.b.c.` This is an error that may be shown when upgrading Fluvio version of a locally deployed cluster. The fluvio cluster may need to be
upgraded to the new version: see the [`fluvio cluster upgrade`] command for more information.

### Log directory

By default, Fluvio logs are stored in the `~/.fluvio/log` directory.
By default, Fluvio logs are stored in the `~/.fluvio/log` directory.
But if you have the `FLUVIO_DIR` environment variable set, the logs will be stored in the directory specified by the variable.

### Setting log level
Expand All @@ -40,5 +51,8 @@ $ RUST_LOG=info fluvio run sc --local

The log level can be set to `trace`, `debug`, `info`, `warn`, `error`.

[filtering tracing log]: https://tracing.rs/tracing_subscriber/filter/struct.envfilter

[`fluvio cluster upgrade`]: cli/fluvio/cluster.mdx#fluvio-cluster-upgrade
[filtering tracing log]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html
[Discord]: https://discord.com/invite/bBG2dTz

0 comments on commit aa677c2

Please sign in to comment.