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

docs: update troubleshooting #322

Merged
merged 2 commits into from
Dec 17, 2024
Merged

docs: update troubleshooting #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80eb12c
docs: update troubleshooting
digikata Dec 17, 2024
7c1a32f
add: fluvio community news link
digikata Dec 17, 2024
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
21 changes: 21 additions & 0 deletions docs/fluvio/cli/fluvio/cluster.mdx
View file
Open in desktop
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
View file
Open in desktop
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] 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

2 changes: 2 additions & 0 deletions news/this-week-in-fluvio-0000.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,12 @@ This is a feature highlight that will be included in the next Fluvio release
---

Get in touch with us on [Github Discussions] or join [our Discord channel] and come say hello!
See some of the interesting community projects, examples, and utilities in the [Fluvio Community] github org.
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor nitpick:

GitHub instead github


For the full list of changes this week, be sure to check out [our CHANGELOG].

[Fluvio open source]: https://github.com/infinyon/fluvio
[our CHANGELOG]: https://github.com/infinyon/fluvio/blob/master/CHANGELOG.md
[our Discord channel]: https://discordapp.com/invite/bBG2dTz
[Github Discussions]: https://github.com/infinyon/fluvio/discussions
[Fluvio Community]: https://github.com/fluvio-community
Loading