From 80eb12cb5a019d200a95c7ddf8009b41b6dce20c Mon Sep 17 00:00:00 2001 From: Alan Chen Date: Tue, 17 Dec 2024 10:41:43 -0800 Subject: [PATCH 1/2] docs: update troubleshooting --- docs/fluvio/cli/fluvio/cluster.mdx | 21 +++++++++++++++++++++ docs/fluvio/troubleshooting.mdx | 20 +++++++++++++++++--- 2 files changed, 38 insertions(+), 3 deletions(-) diff --git a/docs/fluvio/cli/fluvio/cluster.mdx b/docs/fluvio/cli/fluvio/cluster.mdx index b5166a36..9875b981 100644 --- a/docs/fluvio/cli/fluvio/cluster.mdx +++ b/docs/fluvio/cli/fluvio/cluster.mdx @@ -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 diff --git a/docs/fluvio/troubleshooting.mdx b/docs/fluvio/troubleshooting.mdx index 207631c7..a40f7ba2 100644 --- a/docs/fluvio/troubleshooting.mdx +++ b/docs/fluvio/troubleshooting.mdx @@ -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 @@ -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 @@ -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 From 7c1a32f4811d2aaf4d7472324052b33610f84c74 Mon Sep 17 00:00:00 2001 From: Alan Chen Date: Tue, 17 Dec 2024 10:46:08 -0800 Subject: [PATCH 2/2] add: fluvio community news link --- news/this-week-in-fluvio-0000.md.tmpl | 2 ++ 1 file changed, 2 insertions(+) diff --git a/news/this-week-in-fluvio-0000.md.tmpl b/news/this-week-in-fluvio-0000.md.tmpl index 7d86bb09..6ea17b45 100644 --- a/news/this-week-in-fluvio-0000.md.tmpl +++ b/news/this-week-in-fluvio-0000.md.tmpl @@ -44,6 +44,7 @@ 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. For the full list of changes this week, be sure to check out [our CHANGELOG]. @@ -51,3 +52,4 @@ For the full list of changes this week, be sure to check out [our CHANGELOG]. [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