Skip to content

Commit

Permalink
chore: add upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
leon3s committed May 3, 2024
1 parent fb81561 commit c795103
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 1 deletion.
43 changes: 43 additions & 0 deletions docs/manuals/nanocl/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Upgrading - Nanocl
sidebar_label: Upgrade
---

# Overview

In the current state of Nanocl, upgrading is not as simple as it should be. This is because Nanocl is still in development and the API is not stable yet. This means that the API can change at any time and upgrading Nanocl can break because of the previous database state.

:::note
We encourage our community to help us stabilize the API and make upgrading as simple as possible.
To do so don't hesitate to create [issues][github_issues], create [discussions][github_discussions] on our github repository or join our [discord][discord] server.
:::

# Upgrading

To upgrade Nanocl, you will need to follow these steps:

- Uninstall the current version of Nanocl
```sh
nanocl uninstall
```
- Remove the current nanocl state by running:
```sh
sudo rm -rf /var/lib/nanocl
```
- Grap the latest version of the nanocl cli using our [installation guide](/manuals/nanocl/install/overview)
- Install the new version
```sh
nanocl install
```

Then you need to reapply your Statefiles to recover your previous state.

To compensate the lack of upgrade support you can share this meme with your friends:

<div class="center">
<img src="/img/nanocl_upgrade.jpg" />
</div>

[github_issues]: https://github.com/next-hat/nanocl/issues
[github_discussions]: https://github.com/next-hat/nanocl/discussions
[discord]: https://discord.gg/WV4Aac8uZg
7 changes: 6 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ const config = {
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
blog: false,
// blog: {
// blogTitle: 'Next Hat blog',
// blogDescription: 'Latest new about Next Hat technologies',
// postsPerPage: 'ALL',
// },
docs: {
path: 'docs',
routeBasePath: '/',
Expand Down Expand Up @@ -129,6 +133,7 @@ const config = {
height: '32',
},
items: [
// {to: 'blog', label: 'Blog', position: 'left'},
{
type: 'doc',
position: 'left',
Expand Down
Binary file added static/img/nanocl_upgrade.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c795103

Please sign in to comment.